Adobe InCopy CS5 (7.0) Object Model JS: TextVariable

InCopy CS5

previous page next page

Class

TextVariable

A text variable definition in a document.

QuickLinks

addEventListener, convertToText, getElements, remove, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document

TextVariable

Properties

Property	Type	Access	Description
associatedInstances	Array of TextVariableInstance	readonly	Variable instances associated with the text variable.
eventListeners	EventListeners	readonly	A collection of event listeners.
events	Events	readonly	A collection of events.
index	number	readonly	The index of the TextVariable within its containing object.
isValid	bool	readonly	Returns true if the object specifier resolves to valid objects.
name	string	r/w	The name of the TextVariable.
parent	Application Document	readonly	The parent of the TextVariable (a Application or Document).
preferences	Preferences	readonly	A collection of preferences objects.
properties	Object	r/w	A property that allows setting of several properties at the same time.
variableOptions	CaptionMetadataVariablePreference ChapterNumberVariablePreference CustomTextVariablePreference DateVariablePreference FileNameVariablePreference MatchCharacterStylePreference MatchParagraphStylePreference PageNumberVariablePreference	readonly	The preferences associated with the text variable. Can return: PageNumberVariablePreference, ChapterNumberVariablePreference, DateVariablePreference, FileNameVariablePreference, MatchCharacterStylePreference, MatchParagraphStylePreference, CustomTextVariablePreference or CaptionMetadataVariablePreference.
variableType	VariableTypes: VariableTypes.CUSTOM_TEXT_TYPE VariableTypes.FILE_NAME_TYPE VariableTypes.LAST_PAGE_NUMBER_TYPE VariableTypes.CHAPTER_NUMBER_TYPE VariableTypes.OUTPUT_DATE_TYPE VariableTypes.CREATION_DATE_TYPE VariableTypes.MODIFICATION_DATE_TYPE VariableTypes.MATCH_CHARACTER_STYLE_TYPE VariableTypes.MATCH_PARAGRAPH_STYLE_TYPE VariableTypes.XREF_PAGE_NUMBER_TYPE VariableTypes.XREF_CHAPTER_NUMBER_TYPE VariableTypes.LIVE_CAPTION_TYPE	r/w	The variable type.

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)

Array of Text convertToText ()
Convert all of this variable's instances to text.

Array of TextVariable getElements ()
Resolves the object specifier, creating an array of object references.

void remove ()
Deletes the TextVariable.

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)