Adobe InDesign CS5 (7.0) Object Model JS: ButtonPreference

InDesign CS5

Class

ButtonPreference

 Button preferences. Base Class: Preference

QuickLinks

addEventListener, getElements, removeEventListener, toSource, toSpecifier

Hierarchy

Application | Document
Preference
ButtonPreference
Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
eventListenersEventListeners readonlyA collection of event listeners.
eventsEvents readonlyA collection of events.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
namestring r/wThe name of the ButtonPreference.
parentApplicationDocument readonlyThe parent of the ButtonPreference (a Application or Document).
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 ButtonPreference 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 ButtonPreference.

string toSpecifier ()
Retrieves the object specifier.

Element of

Application.buttonPreferences

Document.buttonPreferences

Return

Array of ButtonPreference ButtonPreference.getElements ()

Jongware, 20-Jun-2010 v3.0.3dContents :: Index