Adobe InCopy CS5 (7.0) Object Model JS: Dialogs

InCopy CS5

Class

Dialogs

 A collection of dialogs.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

Dialog [] (index: number)
Returns the Dialog with the specified index.

ParameterTypeDescription
indexnumberThe index.

Dialog add ([withProperties: Object])
Creates a new Dialog.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new Dialog (Optional)

Dialog anyItem ()
Returns any Dialog in the collection.

number count ()
Displays the number of elements in the Dialog.

Array of Dialog everyItem ()
Returns every Dialog in the collection.

Dialog firstItem ()
Returns the first Dialog in the collection.

Dialog item (index: varies)
Returns the Dialog with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

Dialog itemByID (id: number)
Returns the Dialog with the specified ID.

ParameterTypeDescription
idnumberThe ID.

Dialog itemByName (name: string)
Returns the Dialog with the specified name.

ParameterTypeDescription
namestringThe name.

Array of Dialog itemByRange (from: varies, to: varies)
Returns the Dialogs within the specified range.

ParameterTypeDescription
fromDialog
Long Integer
String
The Dialog, index, or name at the beginning of the range. Can accept: Dialog, Long Integer or String.
toDialog
Long Integer
String
The Dialog, index, or name at the end of the range. Can accept: Dialog, Long Integer or String.

Dialog lastItem ()
Returns the last Dialog in the collection.

Dialog middleItem ()
Returns the middle Dialog in the collection.

Dialog nextItem (obj: Dialog)
Returns the Dialog whose index follows the specified Dialog in the collection.

ParameterTypeDescription
objDialogThe Dialog whose index comes before the desired Dialog.

Dialog previousItem (obj: Dialog)
Returns the Dialog with the index previous to the specified index.

ParameterTypeDescription
objDialogThe index of the Dialog that follows the desired Dialog.

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

Element of

Application.dialogs

Jongware, 23-Mar-2011 v3.0.3dContents :: Index