CrossReferenceFormat

A cross reference format object.

Go to Property Listing | Method Listing

Methods:

extractLabel, getElements, insertLabel, remove, toSource, toSpecifier

Objects:

Boolean, BuildingBlocks, CharacterStyle, 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.
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

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.

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

Object of

CrossReferenceSource.appliedFormat

BuildingBlock.parent