A hyperlink.
Go to Property Listing | Method Listing
addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, showDestination, showSource, toSource, toSpecifier
Boolean, CrossReferenceSource, EventListeners, Events, HyperlinkAppearanceHighlight, HyperlinkAppearanceStyle, HyperlinkAppearanceWidth, HyperlinkExternalPageDestination, HyperlinkPageDestination, HyperlinkPageItemSource, HyperlinkTextDestination, HyperlinkTextSource, HyperlinkURLDestination, Number, Object, ParagraphDestination, String, UIColors,
Property |
Type |
Access |
Description |
---|---|---|---|
Array of 3 Reals (0 - 255) |
read/write |
The hyperlink border color. Can return: Array of 3 Reals (0 - 255) or UIColors enumerator. |
|
read/write |
The hyperlink border style. |
||
read/write |
The text, page, or URL that the hyperlink points to. Can return: HyperlinkTextDestination, HyperlinkPageDestination, HyperlinkExternalPageDestination, HyperlinkURLDestination or ParagraphDestination. |
||
readonly |
A collection of event listeners. |
||
readonly |
A collection of events. |
||
readonly |
If true, the hyperlink is hidden. |
||
read/write |
The hyperlink highlight style. |
||
readonly |
The unique ID of the Hyperlink. |
||
readonly |
The index of the Hyperlink within its containing object. |
||
readonly |
Returns true if the object specifier resolves to valid objects. |
||
read/write |
A property that can be set to any string. |
||
read/write |
The name of the Hyperlink. |
||
readonly |
The parent of the Hyperlink (a Document). |
||
read/write |
A property that allows setting of several properties at the same time. |
||
read/write |
The hyperlinked text or page item. Can return: HyperlinkPageItemSource, HyperlinkTextSource or CrossReferenceSource. |
||
read/write |
If true, the Hyperlink is visible. |
||
read/write |
The stroke weight of the hyperlink border. |
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The event type. |
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
String extractLabel (key:String)
Gets the label value associated with the specified key.
Parameter |
Type |
Description |
---|---|---|
key |
The key. |
Hyperlink getElements ()
Resolves the object specifier, creating an array of object references.
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
undefined remove ()
Deletes the Hyperlink.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The registered event type. |
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined showDestination ()
Jumps to the hyperlink destination.
undefined showSource ()
Jumps to the hyperlink source.
String toSource ()
Generates a string which, if executed, will return the Hyperlink.
String toSpecifier ()
Retrieves the object specifier.
Hyperlinks.[]()