Adobe InDesign CS4 (6.0) Object Model JS: HyperlinkPageItemSource

InDesign CS4

Class

HyperlinkPageItemSource

 A hyperlinked page item.

QuickLinks

extractLabel, getElements, insertLabel, remove, showSource, toSource, toSpecifier

Hierarchy

Document
HyperlinkPageItemSource

Properties

PropertyTypeAccessDescription
hiddenbool readonlyIf true, the hyperlink is hidden.
idnumber readonlyThe unique ID of the HyperlinkPageItemSource.
indexnumber readonlyThe index of the HyperlinkPageItemSource within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the HyperlinkPageItemSource.
parentDocument readonlyThe parent of the HyperlinkPageItemSource (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.
sourcePageItemPageItem r/wThe hyperlinked page item.

Methods

Instances

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

ParameterTypeDescription
keystringThe key.

Array of HyperlinkPageItemSource 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.

ParameterTypeDescription
keystringThe key.
valuestringThe 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.

Element of

Hyperlink.source

Used in:

array of HyperlinkPageItemSource HyperlinkPageItemSources.itemByRange (from: any, to: any)

HyperlinkPageItemSource HyperlinkPageItemSources.nextItem (obj: HyperlinkPageItemSource)

HyperlinkPageItemSource HyperlinkPageItemSources.previousItem (obj: HyperlinkPageItemSource)

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

Return

Array of HyperlinkPageItemSource HyperlinkPageItemSource.getElements ()

HyperlinkPageItemSource HyperlinkPageItemSources.[] (index: number)

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)

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