CrossReferenceFormat

A cross reference format object.

Methods:

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

Objects:

Boolean, BuildingBlocks, CharacterStyle, EventListeners, Events, Number, Object, String

Property Listing

Property

Type

Access

Description

appliedCharacterStyle

CharacterStyle

read/write

Character style of the cross reference format.

buildingBlocks

BuildingBlocks BuildingBlock

readonly

A collection of cross reference building blocks.

eventListeners

EventListeners EventListener

readonly

A collection of event listeners.

events

Events Event

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

Boolean

readonly

Returns true if the object specifier resolves to valid objects.

label

String

read/write

A property that can be set to any string.

name

String

read/write

The name of the CrossReferenceFormat.

parent

Document

readonly

The parent of the CrossReferenceFormat (a Document).

properties

Object

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

String

The event type.

handler

File

JavaScriptFunction

The event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

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.

Parameter

Type

Description

key

String

The key.

value

String

The value.

undefined remove ()

Deletes the CrossReferenceFormat.

Boolean removeEventListener (eventType:String, handler:Varies File JavaScriptFunction, [captures:Boolean=Boolean])

Removes the event listener.

Parameter

Type

Description

eventType

String

The registered event type.

handler

File

JavaScriptFunction

The registered event handler. Can accept: File or JavaScript Function.

captures

Boolean

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.

Object of

CrossReferenceSource.appliedFormat

BuildingBlock.parent

Event.parent

EventListener.parent

MutationEvent.parent

Return

CrossReferenceFormats.add()

CrossReferenceFormat.getElements()

CrossReferenceFormats.anyItem()

CrossReferenceFormats.everyItem()

CrossReferenceFormats.nextItem()

CrossReferenceFormats.previousItem()

CrossReferenceFormats.itemByID()

CrossReferenceFormats.item()

CrossReferenceFormats.[]()

CrossReferenceFormats.itemByName()

CrossReferenceFormats.itemByRange()

CrossReferenceFormats.firstItem()

CrossReferenceFormats.lastItem()

CrossReferenceFormats.middleItem()