Adobe InDesign CS5.5 Server (7.5) Object Model JS: CaptionMetadataVariablePreference

InDesign Server CS5.5

Class

CaptionMetadataVariablePreference

 The preferences for a caption metadata variable. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

TextVariable
Preference
CaptionMetadataVariablePreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
metadataProviderNamestring r/wName of the metadata provider.
parentTextVariable readonlyThe parent of the CaptionMetadataVariablePreference (a TextVariable).
propertiesObject r/wA property that allows setting of several properties at the same time.
textAfterstring r/wThe text that follows the value of the variable. (Limit: 128 characters)
textBeforestring r/wThe text that precedes the value of the variable. (Limit: 128 characters)

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

string toSpecifier ()
Retrieves the object specifier.

Element of

TextVariable.variableOptions

Return

Array of CaptionMetadataVariablePreference CaptionMetadataVariablePreference.getElements ()

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