Adobe InDesign CS2 (4.0) Object Model JS: Dialog

InDesign CS2

Class

Dialog

 A dialog.

QuickLinks

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

Hierarchy

Application
Dialog
DialogColumn

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 readonlyA collection of dialog columns.
idnumber readonlyThe unique ID of the Dialog.
indexnumber readonlyThe index of the Dialog within its containing object.
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

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 Object 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 show ()
Displays the dialog.

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

string toSpecifier ()
Retrieves the object specifier.

Used in:

array of Dialog Dialogs.itemByRange (from: any, to: any)

Dialog Dialogs.nextItem (obj: Dialog)

Dialog Dialogs.previousItem (obj: Dialog)

Return

Dialog Dialogs.add ([withProperties: Object])

Dialog Dialogs.anyItem ()

Array of Dialog Dialogs.everyItem ()

Dialog Dialogs.firstItem ()

Dialog Dialogs.item (index: any)

Dialog Dialogs.itemByID (id: number)

Dialog Dialogs.itemByName (name: string)

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

Dialog Dialogs.lastItem ()

Dialog Dialogs.middleItem ()

Dialog Dialogs.nextItem (obj: Dialog)

Dialog Dialogs.previousItem (obj: Dialog)

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