Adobe InDesign CS4 (6.0) Object Model JS: ParagraphDestination

InDesign CS4

Class

ParagraphDestination

 Paragraph destination of a cross reference. Base Class: HyperlinkTextDestination

QuickLinks

extractLabel, getElements, insertLabel, remove, showDestination, toSource, toSpecifier

Hierarchy

Document
HyperlinkTextDestination
ParagraphDestination

Properties

PropertyTypeAccessDescription
destinationTextInsertionPointText r/wThe text or insertion point that the hyperlink points to. Can also accept: Text.
hiddenbool readonlyIf true, the hyperlink is hidden.
idnumber readonlyThe unique ID of the ParagraphDestination.
indexnumber readonlyThe index of the ParagraphDestination 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 ParagraphDestination.
parentDocument readonlyThe parent of the ParagraphDestination (a Document).
propertiesObject r/wA property that allows setting of several properties at the same time.

Methods

Instances

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

ParameterTypeDescription
keystringThe key.

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

void showDestination ()
Jumps to the hyperlink destination.

string toSource ()
Generates a string which, if executed, will return the ParagraphDestination.

string toSpecifier ()
Retrieves the object specifier.

Element of

Hyperlink.destination

Used in:

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

array of ParagraphDestination ParagraphDestinations.itemByRange (from: any, to: any)

ParagraphDestination ParagraphDestinations.nextItem (obj: ParagraphDestination)

ParagraphDestination ParagraphDestinations.previousItem (obj: ParagraphDestination)

Return

Array of ParagraphDestination ParagraphDestination.getElements ()

ParagraphDestination ParagraphDestinations.[] (index: number)

ParagraphDestination ParagraphDestinations.add (destination: Text[, withProperties: Object])

ParagraphDestination ParagraphDestinations.anyItem ()

Array of ParagraphDestination ParagraphDestinations.everyItem ()

ParagraphDestination ParagraphDestinations.firstItem ()

ParagraphDestination ParagraphDestinations.item (index: any)

ParagraphDestination ParagraphDestinations.itemByID (id: number)

ParagraphDestination ParagraphDestinations.itemByName (name: string)

Array of ParagraphDestination ParagraphDestinations.itemByRange (from: any, to: any)

ParagraphDestination ParagraphDestinations.lastItem ()

ParagraphDestination ParagraphDestinations.middleItem ()

ParagraphDestination ParagraphDestinations.nextItem (obj: ParagraphDestination)

ParagraphDestination ParagraphDestinations.previousItem (obj: ParagraphDestination)

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