Dialog
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| canCancel | bool | r/w | If 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. |
| dialogColumns | DialogColumns DialogColumn | readonly | A collection of dialog columns. |
| eventListeners | EventListeners EventListener | readonly | A collection of event listeners. |
| events | Events Event | readonly | A collection of events. |
| id | number | readonly | The unique ID of the Dialog. |
| index | number | readonly | The index of the Dialog within its containing object. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| label | string | r/w | A property that can be set to any string. |
| name | string | r/w | The name of the Dialog. |
| parent | Application | readonly | The parent of the Dialog (a Application). |
| properties | Object | r/w | A 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.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The event type. |
| handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
| captures | bool | This 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.
| Parameter | Type | Description |
|---|---|---|
| key | string | The 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.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
| value | string | The value. |
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
| Parameter | Type | Description |
|---|---|---|
| eventType | string | The registered event type. |
| handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
| captures | bool | This parameter is obsolete. (Optional) (default: false) |
bool show ()
Displays the dialog.
string toSource ()
Generates a string which, if executed, will return the Dialog.
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.3i | Contents :: Index |