Adobe InDesign CS5 Server (7.0) Object Model JS: CrossReferenceFormat

InDesign Server CS5

Class

CrossReferenceFormat

 A cross reference format object.

QuickLinks

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

Hierarchy

Document
CrossReferenceFormat
BuildingBlock | Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
appliedCharacterStyleCharacterStyle r/wCharacter style of the cross reference format.
buildingBlocksBuildingBlocks readonlyA collection of cross reference building blocks.
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
idnumber readonlyThe unique ID of the CrossReferenceFormat.
indexnumber readonlyThe index of the CrossReferenceFormat 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 CrossReferenceFormat.
parentDocument readonlyThe parent of the CrossReferenceFormat (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 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.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

void remove ()
Deletes the CrossReferenceFormat.

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)

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

string toSpecifier ()
Retrieves the object specifier.

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, 23-Mar-2011 v3.0.3dContents :: Index