Adobe InCopy CS5.5 (7.5) Object Model JS: DialogColumns

InCopy CS5.5

Class

DialogColumns

 A collection of dialog columns.

See also DialogColumn.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

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

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

DialogColumn anyItem ()
Returns any DialogColumn in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
fromDialogColumn
Long Integer
String
The DialogColumn, index, or name at the beginning of the range. Can accept: DialogColumn, Long Integer or String.
toDialogColumn
Long Integer
String
The DialogColumn, index, or name at the end of the range. Can accept: DialogColumn, Long Integer or String.

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

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

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

ParameterTypeDescription
objDialogColumnThe DialogColumn whose index comes before the desired DialogColumn.

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

ParameterTypeDescription
objDialogColumnThe index of the DialogColumn that follows the desired DialogColumn.

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

Element of

BorderPanel.dialogColumns

Dialog.dialogColumns

DialogRow.dialogColumns

EnablingGroup.dialogColumns

Jongware, 29-Apr-2012 v3.0.3iContents :: Index