Adobe InDesign CS5 (7.0) Object Model JS: HyperlinkExternalPageDestination
From InDesign CS5
HyperlinkExternalPageDestination
A hyperlink destination that is a page in a document other than the document that contains the hyperlink source. For information on hyperlink sources, hyperlink page item source or hyperlink text source.QuickLinks
addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, showDestination, toSource, toSpecifierHierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| destinationPageIndex | number (range: 1 - 9999) | r/w | The index of the page that the hyperlink destination points to. Note: Valid only when hyperlink destination is an external page. |
| documentPath | File | r/w | The path to the document that the hyperlink destination points to. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| hidden | bool | readonly | If true, the hyperlink is hidden. |
| id | number | readonly | The unique ID of the HyperlinkExternalPageDestination. |
| index | number | readonly | The index of the HyperlinkExternalPageDestination 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 | readonly | The name of the HyperlinkExternalPageDestination. |
| parent | Document | readonly | The parent of the HyperlinkExternalPageDestination (a Document). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| viewBounds | bottom:Unit left:Unit Ordered array containing top:Unit right:Unit |
r/w | The view rectangle, specified in the format [y1, x1, y2, x2]. Note: Valid only when view setting is fixed. Can return: Ordered array containing top:Unit, left:Unit, bottom:Unit, right:Unit. |
| viewPercentage | number (range: 5 - 4000) | r/w | The zoom percentage. (Range: 5 to 4000) Note: Valid only when view setting is fixed. |
| viewSetting | HyperlinkDestinationPageSetting: HyperlinkDestinationPageSetting.FIXED HyperlinkDestinationPageSetting.FIT_VIEW HyperlinkDestinationPageSetting.FIT_WINDOW HyperlinkDestinationPageSetting.FIT_WIDTH HyperlinkDestinationPageSetting.FIT_HEIGHT HyperlinkDestinationPageSetting.FIT_VISIBLE HyperlinkDestinationPageSetting.INHERIT_ZOOM |
r/w | The destination page size when the page is reached by clicking the hyperlink. |
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 HyperlinkExternalPageDestination 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 HyperlinkExternalPageDestination.
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 showDestination ()
Jumps to the hyperlink destination.
string toSource ()
Generates a string which, if executed, will return the HyperlinkExternalPageDestination.
string toSpecifier ()
Retrieves the object specifier.
Element of
Bookmark.destination
Hyperlink.destination
Used in:
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.nextItem (obj: HyperlinkExternalPageDestination)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.previousItem (obj: HyperlinkExternalPageDestination)
Return
Array of HyperlinkExternalPageDestination HyperlinkExternalPageDestination.getElements ()
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.[] (index: number)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.add ([destination: Page][, withProperties: Object])
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.anyItem ()
Array of HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.everyItem ()
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.firstItem ()
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.item (index: varies)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.itemByID (id: number)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.itemByName (name: string)
Array of HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.itemByRange (from: varies, to: varies)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.lastItem ()
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.middleItem ()
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.nextItem (obj: HyperlinkExternalPageDestination)
HyperlinkExternalPageDestination HyperlinkExternalPageDestinations.previousItem (obj: HyperlinkExternalPageDestination)
| Jongware, 20-Jun-2010 v3.0.3d | Contents :: Index |