Adobe InDesign CS (3.0) Object Model JS: HyperlinkPageDestination

InDesign CS

Class

HyperlinkPageDestination

 A hyperlink destination that is a document page.

QuickLinks

extractLabel, insertLabel, remove, showDestination

Hierarchy

Document
HyperlinkPageDestination

Properties

PropertyTypeAccessDescription
destinationPagePage r/wThe page that the hyperlink points to.
hiddenbool readonlyIf true, the hyperlink is hidden.
idnumber readonlyThe unique ID of the HyperlinkPageDestination.
indexnumber readonlyThe index of the HyperlinkPageDestination within its containing object.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the HyperlinkPageDestination.
nameManuallybool r/wIf true or unspecified, allows a custom destination name; also does not update the name when the destination is moved to a different page. If false, uses the page number as the page destination name and makes the name property read-only for the destination object; also updates the name when the destination is moved to a different page.
parentDocument readonlyThe parent of the HyperlinkPageDestination (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
viewBounds Array of Measurement Unit (Number or String) r/wThe view rectangle, specified in the format [y1, x1, y2, x2]. Note: Valid only when view setting is fixed.
viewPercentagenumber r/wThe zoom percentage (ignored unless view setting is fixed)
viewSettingHyperlinkDestinationPageSetting:
HyperlinkDestinationPageSetting.FIXED
HyperlinkDestinationPageSetting.FIT_VIEW
HyperlinkDestinationPageSetting.FIT_WINDOW
HyperlinkDestinationPageSetting.FIT_WIDTH
HyperlinkDestinationPageSetting.FIT_HEIGHT
HyperlinkDestinationPageSetting.FIT_VISIBLE
HyperlinkDestinationPageSetting.INHERIT_ZOOM
r/wThe destination page size when the page is reached by clicking the hyperlink.

Methods

Instances

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the HyperlinkPageDestination.

void showDestination ()
Jumps to the hyperlink destination.

Element of

Bookmark.destination

Hyperlink.destination

Used in:

Bookmark Bookmarks.add (destination: any[, withProperties: Object])

Hyperlink Hyperlinks.add (hyperlinkSource: any[, hyperlinkDestination: any][, withProperties: Object])

Return

HyperlinkPageDestination HyperlinkPageDestinations.add ([destination: Page][, withProperties: Object])

Jongware, 27-Jun-2010 v3.0.3dContents :: Index