Class

ParagraphDestination

 Paragraph destination of a cross reference. Base Class: HyperlinkTextDestination

QuickLinks

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

Hierarchy

Document
HyperlinkTextDestination
ParagraphDestination
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
destinationTextInsertionPoint
Text
r/wThe text or insertion point that the hyperlink points to. Can also accept: Text.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
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

EventListener addEventListener (eventType: string, handler: varies[, captures: bool=false])
Adds an event listener.

ParameterTypeDescription
eventTypestringThe event type.
handlerFile
JavaScript Function
The event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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.

bool removeEventListener (eventType: string, handler: varies[, captures: bool=false])
Removes the event listener.

ParameterTypeDescription
eventTypestringThe registered event type.
handlerFile
JavaScript Function
The registered event handler. Can accept: File or JavaScript Function.
capturesboolThis parameter is obsolete. (Optional) (default: false)

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:

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: varies)

ParagraphDestination ParagraphDestinations.itemByID (id: number)

ParagraphDestination ParagraphDestinations.itemByName (name: string)

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

ParagraphDestination ParagraphDestinations.lastItem ()

ParagraphDestination ParagraphDestinations.middleItem ()

ParagraphDestination ParagraphDestinations.nextItem (obj: ParagraphDestination)

ParagraphDestination ParagraphDestinations.previousItem (obj: ParagraphDestination)

Jongware, 28-Apr-2012 v3.0.3hContents :: Index