A hyperlinked text object or insertion point.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| hidden | bool | readonly | If true, the HyperlinkTextSource is hidden. |
| id | number | readonly | The unique ID of the HyperlinkTextSource. |
| index | number | readonly | The index of the HyperlinkTextSource within its containing object. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the HyperlinkTextSource. |
| parent | Document | readonly | The parent of the HyperlinkTextSource (a Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| sourceText | Text | r/w | The hyperlinked text or insertion point. |
Methods
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of HyperlinkTextSource
getElements ()
Resolves the object specifier, creating an array of object references.
void insertLabel (key:
string, value:
string)
Sets the label to the value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void remove ()
Deletes the HyperlinkTextSource.
void showSource ()
Jumps to the hyperlink source.
string toSource ()
Generates a string which, if executed, will return the HyperlinkTextSource.
string toSpecifier ()
Retrieves the object specifier.
Used in:
HyperlinkTextSources.previousItem ( obj: HyperlinkTextSource)HyperlinkTextSources.nextItem ( obj: HyperlinkTextSource)
Returned by:
Array of HyperlinkTextSource HyperlinkTextSource.getElements ( )HyperlinkTextSource HyperlinkTextSources.add ( source: Text[, withProperties: Object] )
HyperlinkTextSource HyperlinkTextSources.anyItem ( )
Array of HyperlinkTextSource HyperlinkTextSources.everyItem ( )
HyperlinkTextSource HyperlinkTextSources.firstItem ( )
HyperlinkTextSource HyperlinkTextSources.item ( index: any )
HyperlinkTextSource HyperlinkTextSources.itemByID ( id: number )
HyperlinkTextSource HyperlinkTextSources.itemByName ( name: string )
Array of HyperlinkTextSource HyperlinkTextSources.itemByRange ( from: any, to: any )
HyperlinkTextSource HyperlinkTextSources.lastItem ( )
HyperlinkTextSource HyperlinkTextSources.middleItem ( )
HyperlinkTextSource HyperlinkTextSources.nextItem ( obj: HyperlinkTextSource )
HyperlinkTextSource HyperlinkTextSources.previousItem ( obj: HyperlinkTextSource )