InDesign2026
API 21.5.1.73
Collection of Dialog

Dialogs

A collection of dialogs.

Properties

NameType AccessDescription
Number readonly The number of objects in the collection.

Methods

Dialog

Returns the Dialog with the specified index.

index Number The index.
Dialog

Creates a new Dialog.

withProperties? Object Initial values for properties of the new Dialog
Dialog

Returns any Dialog in the collection.

Number

Displays the number of elements in the Dialog.

Dialog[]

Returns every Dialog in the collection.

Dialog

Returns the first Dialog in the collection.

Dialog

Returns the Dialog with the specified index or name.

index LongInteger | String The index or name. Can accept: Long Integer or String.
Dialog

Returns the Dialog with the specified ID.

id Number The ID.
Dialog

Returns the Dialog with the specified name.

name String The name.
Dialog[]

Returns the Dialogs within the specified range.

from Dialog | LongInteger | String The Dialog, index, or name at the beginning of the range. Can accept: Dialog, Long Integer or String.
to Dialog | LongInteger | String The Dialog, index, or name at the end of the range. Can accept: Dialog, Long Integer or String.
Dialog

Returns the last Dialog in the collection.

Dialog

Returns the middle Dialog in the collection.

Dialog

Returns the Dialog whose index follows the specified Dialog in the collection.

obj Dialog The Dialog whose index comes before the desired Dialog.
Dialog

Returns the Dialog with the index previous to the specified index.

obj Dialog The index of the Dialog that follows the desired Dialog.
String

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

Object of 1

Properties elsewhere that hold a Dialogs.