Adobe InCopy CS6 (8.0) Object Model JS: Dialog

InCopy CS6

Class

Dialog

 A dialog.

QuickLinks

addEventListener, destroy, extractLabel, getElements, insertLabel, removeEventListener, show, toSource, toSpecifier

Hierarchy

Application
Dialog
DialogColumn | Event | EventListener | MutationEvent

Properties

PropertyTypeAccessDescription
canCancelbool r/wIf true, creates a Cancel button in the dialog that allows users to close the dialog without saving any selections. If false, the dialog contains an OK button but no Cancel button.
dialogColumnsDialogColumns DialogColumn readonlyA collection of dialog columns.
eventListenersEventListeners EventListener readonlyA collection of event listeners.
eventsEvents Event readonlyA collection of events.
idnumber readonlyThe unique ID of the Dialog.
indexnumber readonlyThe index of the Dialog within its containing object.
isValidbool readonlyReturns true if the object specifier resolves to valid objects.
labelstring r/wA property that can be set to any string.
namestring r/wThe name of the Dialog.
parentApplication readonlyThe parent of the Dialog (a Application).
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)

void destroy ()
Destroys the dialog object. Note: Dialog objects remain in memory until you destroy them or quit the program.

string extractLabel (key: string)
Gets the label value associated with the specified key.

ParameterTypeDescription
keystringThe key.

Array of Dialog getElements ()
Resolves the object specifier, creating an array of object references.

void insertLabel (key: string, value: string)
Sets the label to the value associated with the specified key.

ParameterTypeDescription
keystringThe key.
valuestringThe value.

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)

bool show ()
Displays the dialog.

string toSource ()
Generates a string which, if executed, will return the Dialog.

string toSpecifier ()
Retrieves the object specifier.

Used in:

Dialog Dialogs.nextItem (obj: Dialog)

Dialog Dialogs.previousItem (obj: Dialog)

Return

Array of Dialog Dialog.getElements ()

Dialog Dialogs.[] (index: number)

Dialog Dialogs.add ([withProperties: Object])

Dialog Dialogs.anyItem ()

Array of Dialog Dialogs.everyItem ()

Dialog Dialogs.firstItem ()

Dialog Dialogs.item (index: varies)

Dialog Dialogs.itemByID (id: number)

Dialog Dialogs.itemByName (name: string)

Array of Dialog Dialogs.itemByRange (from: varies, to: varies)

Dialog Dialogs.lastItem ()

Dialog Dialogs.middleItem ()

Dialog Dialogs.nextItem (obj: Dialog)

Dialog Dialogs.previousItem (obj: Dialog)

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