HyperlinkPageItemSources
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
HyperlinkPageItemSource add (source:
PageItem[, withProperties:
Object])
Creates a new hyperlink page item source.
| Parameter | Type | Description |
|---|---|---|
| source | PageItem | The page item to hyperlink. |
| withProperties | Object | Initial values for properties of the new HyperlinkPageItemSource (Optional) |
HyperlinkPageItemSource anyItem ()
Returns any HyperlinkPageItemSource in the collection.
number count ()
Displays the number of elements in the HyperlinkPageItemSource.
Array
of HyperlinkPageItemSource everyItem ()
Returns every HyperlinkPageItemSource in the collection.
HyperlinkPageItemSource firstItem ()
Returns the first HyperlinkPageItemSource in the collection.
HyperlinkPageItemSource item (index:
any)
Returns the HyperlinkPageItemSource with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long String | The index or name. Can accept: Long or String. |
HyperlinkPageItemSource itemByID (id:
number)
Returns the HyperlinkPageItemSource with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
HyperlinkPageItemSource itemByName (name:
string)
Returns the HyperlinkPageItemSource with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array
of HyperlinkPageItemSource itemByRange (from:
any, to:
any)
Returns the HyperlinkPageItemSources within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | HyperlinkPageItemSource Long String | The HyperlinkPageItemSource, index, or name at the beginning of the range. Can accept: HyperlinkPageItemSource, Long or String. |
| to | HyperlinkPageItemSource Long String | The HyperlinkPageItemSource, index, or name at the end of the range. Can accept: HyperlinkPageItemSource, Long or String. |
HyperlinkPageItemSource lastItem ()
Returns the last HyperlinkPageItemSource in the collection.
HyperlinkPageItemSource middleItem ()
Returns the middle HyperlinkPageItemSource in the collection.
HyperlinkPageItemSource nextItem (obj:
HyperlinkPageItemSource)
Returns the HyperlinkPageItemSource whose index follows the specified HyperlinkPageItemSource in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | HyperlinkPageItemSource | The HyperlinkPageItemSource whose index comes before the desired HyperlinkPageItemSource. |
HyperlinkPageItemSource previousItem (obj:
HyperlinkPageItemSource)
Returns the HyperlinkPageItemSource with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | HyperlinkPageItemSource | The index of the HyperlinkPageItemSource that follows the desired HyperlinkPageItemSource. |
string toSource ()
Generates a string which, if executed, will return the HyperlinkPageItemSource.
Element of
Document.hyperlinkPageItemSources
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |