A hyperlinked page item.
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| hidden | bool | readonly | If true, the HyperlinkPageItemSource is hidden. |
| id | number | readonly | The unique ID of the HyperlinkPageItemSource. |
| index | number | readonly | The index of the HyperlinkPageItemSource 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 HyperlinkPageItemSource. |
| parent | Document | readonly | The parent of the HyperlinkPageItemSource (a Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| sourcePageItem | PageItem | r/w | The hyperlinked page item. |
Methods
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of HyperlinkPageItemSourcegetElements ()
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 HyperlinkPageItemSource.
void showSource ()
Jumps to the hyperlink source.
string toSource ()
Generates a string which, if executed, will return the HyperlinkPageItemSource.
string toSpecifier ()
Retrieves the object specifier.
Used in:
HyperlinkPageItemSources.previousItem (
obj:
HyperlinkPageItemSource )
HyperlinkPageItemSources.nextItem (
obj:
HyperlinkPageItemSource )
Returned by:
Array of HyperlinkPageItemSource HyperlinkPageItemSource .getElements (
)
HyperlinkPageItemSource HyperlinkPageItemSources.add (
source:
PageItem[, withProperties:
Object]
)
HyperlinkPageItemSource HyperlinkPageItemSources.anyItem (
)
Array of HyperlinkPageItemSource HyperlinkPageItemSources.everyItem (
)
HyperlinkPageItemSource HyperlinkPageItemSources.firstItem (
)
HyperlinkPageItemSource HyperlinkPageItemSources.item (
index:
any
)
HyperlinkPageItemSource HyperlinkPageItemSources.itemByID (
id:
number
)
HyperlinkPageItemSource HyperlinkPageItemSources.itemByName (
name:
string
)
Array of HyperlinkPageItemSource HyperlinkPageItemSources.itemByRange (
from:
any, to:
any
)
HyperlinkPageItemSource HyperlinkPageItemSources.lastItem (
)
HyperlinkPageItemSource HyperlinkPageItemSources.middleItem (
)
HyperlinkPageItemSource HyperlinkPageItemSources.nextItem (
obj:
HyperlinkPageItemSource
)
HyperlinkPageItemSource HyperlinkPageItemSources.previousItem (
obj:
HyperlinkPageItemSource
)