Adobe InCopy CS6 (8.0) Object Model JS: DialogRows

InCopy CS6

Class

DialogRows

 A collection of dialog rows.

See also DialogRow.

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

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

ParameterTypeDescription
indexnumberThe index.

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

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

DialogRow anyItem ()
Returns any DialogRow in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
fromDialogRow
Long Integer
String
The DialogRow, index, or name at the beginning of the range. Can accept: DialogRow, Long Integer or String.
toDialogRow
Long Integer
String
The DialogRow, index, or name at the end of the range. Can accept: DialogRow, Long Integer or String.

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

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

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

ParameterTypeDescription
objDialogRowThe DialogRow whose index comes before the desired DialogRow.

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

ParameterTypeDescription
objDialogRowThe index of the DialogRow that follows the desired DialogRow.

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

Element of

DialogColumn.dialogRows

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