InDesign Server2025
API 20.5.0.49
Object

CustomTextVariablePreference

The preferences for a custom text variable.

Preference CustomTextVariablePreference
Hierarchy

TextVariable

CustomTextVariablePreference

Properties

NameType AccessDescription
String | SpecialCharacters
+52 more
read/write The contents of the text. Can return: String or SpecialCharacters enumerator.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Boolean readonly Returns true if the object specifier resolves to valid objects.
TextVariable readonly The parent of the CustomTextVariablePreference (a TextVariable).
Object read/write A property that allows setting of several properties at the same time.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
Boolean

Removes the event listener.

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

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

String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a CustomTextVariablePreference.

Return 1

Methods that return a CustomTextVariablePreference.