Hyperlink
A hyperlink.
Hyperlink Properties
| Property |
Type |
Access |
Description |
| BorderColor |
Array of 3 Doubles (0 – 255), idUIColors enumeration (see table at end of chapter) |
r/w |
The color of the hyperlink. |
| BorderStyle |
idHyperlinkAppearanceStyle enumeration |
r/w |
The hyperlink’s border style. |
| Destination |
HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination |
r/w |
The destination this hyperlink points to. |
| Hidden |
Boolean |
read |
Is this object hidden in the UI. |
|
| Highlight |
idHyperlinkAppearanceHighlight enumeration |
r/w |
The appearance of the hyperlink’s highlight. |
| Id |
Long |
read |
A unique number identifying the object. |
| Index |
Long |
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. |
| Parent |
Object |
read |
The parent of the object. |
| Source |
HyperlinkPageItemSource, HyperlinkTextSource |
r/w |
The source this hyperlink points to. |
| Visible |
Boolean |
r/w |
If true, the hyperlink is visible. |
| Width |
idHyperlinkAppearanceWidth enumeration |
r/w |
The width of the object. |
Hyperlink Methods
| Method |
Returns |
Description |
| Delete |
Nothing |
Deletes the object. |
| ExtractLabel |
String |
Gets the content of the label associated with the specified key (name). |
| InsertLabel |
Nothing |
Sets the content of the label associated with the specified key (name), creating the label if it does not already exist. |
| ShowDestination |
Nothing |
Go to Hyperlink destination. |
| ShowSource |
Nothing |
Go to Hyperlink source. |