InDesign Server2025
API 20.5.0.49
Object

CaptionMetadataVariablePreference

The preferences for a caption metadata variable.

Preference CaptionMetadataVariablePreference
Hierarchy

TextVariable

CaptionMetadataVariablePreference

Properties

NameType AccessDescription
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.
String read/write Name of the metadata provider.
TextVariable readonly The parent of the CaptionMetadataVariablePreference (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.
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 CaptionMetadataVariablePreference.

String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a CaptionMetadataVariablePreference.

Return 1

Methods that return a CaptionMetadataVariablePreference.