InDesign2026
API 21.5.1.73
Object

Dialog

A dialog.

Hierarchy

Application

Dialog

DialogColumn

Properties

NameType AccessDescription
Boolean read/write 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<DialogColumn> readonly A collection of dialog columns.
EventListeners<EventListener> readonly A collection of event listeners.
Events<Event> readonly A collection of events.
Number readonly The unique ID of the Dialog.
Number readonly The index of the Dialog within its containing object.
Boolean readonly Returns true if the object specifier resolves to valid objects.
String read/write A property that can be set to any string.
String read/write The name of the Dialog.
Application readonly The parent of the Dialog (a Application).
Object read/write A property that allows setting of several properties at the same time.

Methods

EventListener

Adds an event listener.

eventType String The event type.
handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
void

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

String

Gets the label value associated with the specified key.

key String The key.
Dialog[]

Resolves the object specifier, creating an array of object references.

void

Sets the label to the value associated with the specified key.

key String The key.
value String The value.
Boolean

Removes the event listener.

eventType String The registered event type.
handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.
captures? Boolean This parameter is obsolete.
Boolean

Displays the dialog.

String

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

String

Retrieves the object specifier.

Object of 4

Properties elsewhere that hold a Dialog.

Parameter of 3

Method parameters that accept a Dialog.

Return 14

Methods that return a Dialog.