A collection of hyperlink text sources.
Methods
HyperlinkTextSource
add (source:
Text[, withProperties:
Object])
Creates a new hyperlink text source.
| Parameter | Type | Description |
|---|---|---|
| source | Text | The text or insertion point to hyperlink. |
| withProperties | Object | Initial values for properties of the new HyperlinkTextSource (Optional) |
HyperlinkTextSource
anyItem ()
Returns any HyperlinkTextSource in the collection.
number count ()
Displays the number of elements in the HyperlinkTextSource.
Array of HyperlinkTextSource
everyItem ()
Returns every HyperlinkTextSource in the collection.
HyperlinkTextSource
firstItem ()
Returns the first HyperlinkTextSource in the collection.
HyperlinkTextSource
item (index:
any)
Returns the HyperlinkTextSource with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
HyperlinkTextSource
itemByID (id:
number)
Returns the HyperlinkTextSource with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
HyperlinkTextSource
itemByName (name:
string)
Returns the HyperlinkTextSource with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of HyperlinkTextSource
itemByRange (from:
any, to:
any)
Returns the HyperlinkTextSources within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from |
HyperlinkTextSource
Long Integer String |
The HyperlinkTextSource, index, or name at the beginning of the range. Can accept: HyperlinkTextSource, Long Integer or String. |
| to |
HyperlinkTextSource
Long Integer String |
The HyperlinkTextSource, index, or name at the end of the range. Can accept: HyperlinkTextSource, Long Integer or String. |
HyperlinkTextSource
lastItem ()
Returns the last HyperlinkTextSource in the collection.
HyperlinkTextSource
middleItem ()
Returns the middle HyperlinkTextSource in the collection.
HyperlinkTextSource
nextItem (obj:
HyperlinkTextSource)
Returns the HyperlinkTextSource whose index follows the specified HyperlinkTextSource in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | HyperlinkTextSource | The HyperlinkTextSource whose index comes before the desired HyperlinkTextSource. |
HyperlinkTextSource
previousItem (obj:
HyperlinkTextSource)
Returns the HyperlinkTextSource with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | HyperlinkTextSource | The index of the HyperlinkTextSource that follows the desired HyperlinkTextSource. |
string toSource ()
Generates a string which, if executed, will return the HyperlinkTextSource.