HyperlinkTextSource
A hyperlinked text object or insertion point.
Superclass of CrossReferenceSource
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| appliedCharacterStyle | CharacterStyle | r/w | Character style of the hyperlink text source. |
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| hidden | bool | readonly | If true, the hyperlink is hidden. |
| id | number | readonly | The unique ID of the HyperlinkTextSource. |
| index | number | readonly | The index of the HyperlinkTextSource within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| 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
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
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.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
void showSource ()
Jumps to the hyperlink source.
string toSource ()
Generates a string which, if executed, will return the HyperlinkTextSource.
Element of
Hyperlink.source
Used in:
HyperlinkTextSource HyperlinkTextSources.nextItem (obj: HyperlinkTextSource)
HyperlinkTextSource HyperlinkTextSources.previousItem (obj: HyperlinkTextSource)
Return
Array of HyperlinkTextSource Character.findHyperlinks ([sortOrder: RangeSortOrder])
Array of HyperlinkTextSource HyperlinkTextSource.getElements ()
HyperlinkTextSource HyperlinkTextSources.[] (index: number)
HyperlinkTextSource HyperlinkTextSources.add (source: Text[, withProperties: Object])
HyperlinkTextSource HyperlinkTextSources.anyItem ()
Array of HyperlinkTextSource HyperlinkTextSources.everyItem ()
HyperlinkTextSource HyperlinkTextSources.firstItem ()
HyperlinkTextSource HyperlinkTextSources.item (index: varies)
HyperlinkTextSource HyperlinkTextSources.itemByID (id: number)
HyperlinkTextSource HyperlinkTextSources.itemByName (name: string)
Array of HyperlinkTextSource HyperlinkTextSources.itemByRange (from: varies, to: varies)
HyperlinkTextSource HyperlinkTextSources.lastItem ()
HyperlinkTextSource HyperlinkTextSources.middleItem ()
HyperlinkTextSource HyperlinkTextSources.nextItem (obj: HyperlinkTextSource)
HyperlinkTextSource HyperlinkTextSources.previousItem (obj: HyperlinkTextSource)
Array of HyperlinkTextSource InsertionPoint.findHyperlinks ([sortOrder: RangeSortOrder])
Array of HyperlinkTextSource Line.findHyperlinks ([sortOrder: RangeSortOrder])
Array of HyperlinkTextSource Paragraph.findHyperlinks ([sortOrder: RangeSortOrder])
Array of HyperlinkTextSource Text.findHyperlinks ([sortOrder: RangeSortOrder])
Array of HyperlinkTextSource TextColumn.findHyperlinks ([sortOrder: RangeSortOrder])
Array of HyperlinkTextSource TextStyleRange.findHyperlinks ([sortOrder: RangeSortOrder])
Array of HyperlinkTextSource Word.findHyperlinks ([sortOrder: RangeSortOrder])
| Jongware, 29-Apr-2012 v3.0.3i | Contents :: Index |