CrossReferenceSource

A cross reference text source object.

Go to Property Listing | Method Listing

Methods:

extractLabel, getElements, insertLabel, remove, showSource, toSource, toSpecifier, update

Objects:

Boolean, CharacterStyle, CrossReferenceFormat, Number, Object, String, Text

Hierarchy:

Superclass: HyperlinkTextSource

Class: CrossReferenceSource

Property Listing

Property	Type	Access	Description
appliedCharacterStyle	CharacterStyle	read/write	Character style of the hyperlink text source.
appliedFormat	CrossReferenceFormat	read/write	Format used for cross reference source.
hidden	Boolean	readonly	If true, the hyperlink is hidden.
id	Number	readonly	The unique ID of the CrossReferenceSource.
index	Number	readonly	The index of the CrossReferenceSource 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 CrossReferenceSource.
parent	Document	readonly	The parent of the CrossReferenceSource (a Document).
properties	Object	read/write	A property that allows setting of several properties at the same time.
sourceText	Text	read/write	The hyperlinked text or insertion point.

Method Listing

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

CrossReferenceSource 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 CrossReferenceSource.

undefined showSource ()

Jumps to the hyperlink source.

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

undefined update ()

Updates cross reference text source content.

Object of

Hyperlink.source