Adobe InCopy CS5 (7.0) Object Model JS: Rows

InCopy CS5

Class

Rows

 A collection of table rows.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

any add ([at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new Row.

ParameterTypeDescription
atLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The Row's location relative to the reference object or within the table. (Optional) (default: LocationOptions.UNKNOWN)
referenceCell
Column
Row
Table
The reference object. Note: The reference object must be within the table. Required only when the at value contains before or after. Can accept: Row, Column, Cell or Table. (Optional)
withPropertiesObjectInitial values for properties of the new Row (Optional)

Row anyItem ()
Returns any Row in the collection.

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

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

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

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

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

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromLong Integer
Row
String
The Row, index, or name at the beginning of the range. Can accept: Row, Long Integer or String.
toLong Integer
Row
String
The Row, index, or name at the end of the range. Can accept: Row, Long Integer or String.

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

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

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

ParameterTypeDescription
objRowThe Row whose index comes before the desired Row.

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

ParameterTypeDescription
objRowThe index of the Row that follows the desired Row.

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

Element of

Cell.rows

Column.rows

Row.rows

Table.rows

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