CrossReferenceFormat
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| appliedCharacterStyle | CharacterStyle | r/w | Character style of the cross reference format. |
| buildingBlocks | BuildingBlocks | readonly | A collection of cross reference building blocks. |
| eventListeners | EventListeners | readonly | A collection of event listeners. |
| events | Events | readonly | A collection of events. |
| id | number | readonly | The unique ID of the CrossReferenceFormat. |
| index | number | readonly | The index of the CrossReferenceFormat within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the CrossReferenceFormat. |
| parent | Document | readonly | The parent of the CrossReferenceFormat (a Document). |
| properties | Object | r/w | A 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array of CrossReferenceFormat 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.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
void remove ()
Deletes the CrossReferenceFormat.
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
string toSource ()
Generates a string which, if executed, will return the CrossReferenceFormat.
Element of
BuildingBlock.parent
CrossReferenceSource.appliedFormat
Used in:
CrossReferenceFormat CrossReferenceFormats.nextItem (obj: CrossReferenceFormat)
CrossReferenceFormat CrossReferenceFormats.previousItem (obj: CrossReferenceFormat)
CrossReferenceSource CrossReferenceSources.add (source: Text, appliedFormat: CrossReferenceFormat[, withProperties: Object])
Return
Array of CrossReferenceFormat CrossReferenceFormat.getElements ()
CrossReferenceFormat CrossReferenceFormats.[] (index: number)
CrossReferenceFormat CrossReferenceFormats.add ([name: string][, withProperties: Object])
CrossReferenceFormat CrossReferenceFormats.anyItem ()
Array of CrossReferenceFormat CrossReferenceFormats.everyItem ()
CrossReferenceFormat CrossReferenceFormats.firstItem ()
CrossReferenceFormat CrossReferenceFormats.item (index: varies)
CrossReferenceFormat CrossReferenceFormats.itemByID (id: number)
CrossReferenceFormat CrossReferenceFormats.itemByName (name: string)
Array of CrossReferenceFormat CrossReferenceFormats.itemByRange (from: varies, to: varies)
CrossReferenceFormat CrossReferenceFormats.lastItem ()
CrossReferenceFormat CrossReferenceFormats.middleItem ()
CrossReferenceFormat CrossReferenceFormats.nextItem (obj: CrossReferenceFormat)
CrossReferenceFormat CrossReferenceFormats.previousItem (obj: CrossReferenceFormat)
| Jongware, 28-Apr-2012 v3.0.3h | Contents :: Index |