Adobe InCopy CS6 (8.0) Object Model JS: CustomTextVariablePreference

InCopy CS6

Class

CustomTextVariablePreference

 The preferences for a custom text variable. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

TextVariable
Preference
CustomTextVariablePreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
contentsSpecialCharactersString r/wThe contents of the text. Can return: String or SpecialCharacters enumerator.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
parentTextVariable readonlyThe parent of the CustomTextVariablePreference (a TextVariable).
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)

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

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

string toSpecifier ()
Retrieves the object specifier.

Element of

TextVariable.variableOptions

Return

Array of CustomTextVariablePreference CustomTextVariablePreference.getElements ()

Jongware, 29-Apr-2012 v3.0.3iContents :: Index