A hyperlink.
hyperlink properties
| Property | Type | Access | Description |
|---|---|---|---|
| border color | list of 3 fixed (0 – 255), UI colors enumeration | r/w | The color of the hyperlink. |
| border style | hyperlink appearance style enumeration | r/w | The hyperlink’s border style. |
| class | integer | read | The class descriptor type. |
| destination | hyperlink text destination, hyperlink page destination, hyperlink external page destination, hyperlink URL destination |
r/w | The destination this hyperlink points to. |
| hidden | boolean | read | Is this object hidden in the UI. |
| highlight | hyperlink appearance highlight enumeration | r/w | The appearance of the hyperlink’s highlight. |
| id | integer | read | A unique number identifying the object. |
| index | integer | read | Index of the object within its parent object. |
| label | string | r/w | A label that can be set to any string. |
| name | string | r/w | The name of the object. |
| object reference | object | read | An object reference for this object. |
| parent | object | read | The parent of the object. |
| properties | record | r/w | Property that allows setting of several properties at the same time. |
| source | hyperlink page item source, hyperlink text source | r/w | The source this hyperlink points to. |
| visible | boolean | r/w | If true, the hyperlink is visible. |
| width | hyperlink appearance width enumeration | r/w | The width of the object. |
hyperlink methods
| Method | Returns | Description |
|---|---|---|
| delete | Nothing | Delete the object. |
| extract label | string | Gets the content of the label associated with the specified key (name). |
| insert label | Nothing | Sets the content of the label associated with the specified key (name), creating the label if it does not already exist. |
| show destination | Nothing | Go to Hyperlink destination. |
| show source | Nothing | Go to Hyperlink source. |