InDesign2026
API 21.5.1.73
Object

DateVariablePreference

The preferences for a date variable.

Preference DateVariablePreference
Hierarchy

TextVariable

DateVariablePreference

Properties

NameType AccessDescription
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
String read/write The date format.
Boolean readonly Returns true if the object specifier resolves to valid objects.
TextVariable readonly The parent of the DateVariablePreference (a TextVariable).
Object read/write A property that allows setting of several properties at the same time.
String read/write The text that follows the value of the variable. (Limit: 128 characters)
String read/write The text that precedes the value of the variable. (Limit: 128 characters)

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.
DateVariablePreference[]

Resolves the object specifier, creating an array of object references.

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

String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a DateVariablePreference.

Return 1

Methods that return a DateVariablePreference.