ParagraphDestination
Paragraph destination of a cross reference.
Go to Property Listing | Method Listing
Methods:
addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, showDestination, toSource, toSpecifier
Objects:
Boolean, EventListeners, Events, InsertionPoint, Number, Object, String, Text
Hierarchy:
Superclass: HyperlinkTextDestination
Class: ParagraphDestination
Property Listing
Property |
Type |
Access |
Description |
---|---|---|---|
read/write |
The text or insertion point that the hyperlink points to. Can also accept: Text. |
||
readonly |
A collection of event listeners. |
||
readonly |
A collection of events. |
||
readonly |
If true, the hyperlink is hidden. |
||
readonly |
The unique ID of the ParagraphDestination. |
||
readonly |
The index of the ParagraphDestination within its containing object. |
||
readonly |
Returns true if the object specifier resolves to valid objects. |
||
read/write |
A property that can be set to any string. |
||
read/write |
The name of the ParagraphDestination. |
||
readonly |
The parent of the ParagraphDestination (a Document). |
||
read/write |
A property that allows setting of several properties at the same time. |
Method Listing
EventListener addEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Adds an event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The event type. |
|
handler |
JavaScriptFunction |
The event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
String extractLabel (key:String)
Gets the label value associated with the specified key.
Parameter |
Type |
Description |
---|---|---|
key |
The key. |
ParagraphDestination getElements ()
Resolves the object specifier, creating an array of object references.
undefined insertLabel (key:String, value:String)
Sets the label to the value associated with the specified key.
undefined remove ()
Deletes the ParagraphDestination.
Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])
Removes the event listener.
Parameter |
Type |
Description |
---|---|---|
eventType |
The registered event type. |
|
handler |
JavaScriptFunction |
The registered event handler. Can accept: File or JavaScript Function. |
captures |
This parameter is obsolete. (Optional) (default: false) |
undefined showDestination ()
Jumps to the hyperlink destination.
String toSource ()
Generates a string which, if executed, will return the ParagraphDestination.
String toSpecifier ()
Retrieves the object specifier.
Object of
Event.parent
EventListener.parent
MutationEvent.parent
Hyperlink.destination
Return
ParagraphDestination.getElements()
ParagraphDestinations.anyItem()
ParagraphDestinations.everyItem()
ParagraphDestinations.nextItem()
ParagraphDestinations.previousItem()
ParagraphDestinations.itemByID()
ParagraphDestinations.itemByName()
ParagraphDestinations.itemByRange()
ParagraphDestinations.firstItem()