A cross reference format object.
Go to Property Listing | Method Listing
addEventListener, extractLabel, getElements, insertLabel, remove, removeEventListener, toSource, toSpecifier
Boolean, BuildingBlocks, CharacterStyle, EventListeners, Events, Number, Object, String
Property |
Type |
Access |
Description |
---|---|---|---|
read/write |
Character style of the cross reference format. |
||
readonly |
A collection of cross reference building blocks. |
||
readonly |
A collection of event listeners. |
||
readonly |
A collection of events. |
||
readonly |
The unique ID of the CrossReferenceFormat. |
||
readonly |
The index of the CrossReferenceFormat 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 CrossReferenceFormat. |
||
readonly |
The parent of the CrossReferenceFormat (a Document). |
||
read/write |
A property that allows setting of several properties at the same time. |
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. |
CrossReferenceFormat 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 CrossReferenceFormat.
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) |
String toSource ()
Generates a string which, if executed, will return the CrossReferenceFormat.
String toSpecifier ()
Retrieves the object specifier.
CrossReferenceSource.appliedFormat
BuildingBlock.parent
Event.parent
EventListener.parent
MutationEvent.parent
CrossReferenceFormat.getElements()
CrossReferenceFormats.anyItem()
CrossReferenceFormats.everyItem()
CrossReferenceFormats.nextItem()
CrossReferenceFormats.previousItem()
CrossReferenceFormats.itemByID()
CrossReferenceFormats.itemByName()
CrossReferenceFormats.itemByRange()
CrossReferenceFormats.firstItem()