Rows

A collection of table rows.

Methods:

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

Property Listing

Property

Type

Access

Description

length

Number

readonly

The number of objects in the collection.

Method Listing

Row [] (index:Number)

Returns the Row with the specified index.

Parameter

Type

Description

index

Number

The index.

Varies add ([at:LocationOptions=LocationOptions], reference:Varies Cell Column Row Table, withProperties:Object)

Creates a new Row.

Parameter

Type

Description

at

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The Row's location relative to the reference object or within the table. (Optional)

(default: LocationOptions.UNKNOWN)

reference

Cell

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)

withProperties

Object

Initial 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.

Row everyItem ()

Returns every Row in the collection.

Row firstItem ()

Returns the first Row in the collection.

Row item (index:Varies LongInteger String)

Returns the Row with the specified index or name.

Parameter

Type

Description

index

LongInteger

String

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

Row itemByName (name:String)

Returns the Row with the specified name.

Parameter

Type

Description

name

String

The name.

Row itemByRange (from:Varies LongInteger Row String, to:Varies LongInteger Row String)

Returns the Rows within the specified range.

Parameter

Type

Description

from

LongInteger

Row

String

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

to

LongInteger

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.

Parameter

Type

Description

obj

Row

The Row whose index comes before the desired Row.

Row previousItem (obj:Row)

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

Parameter

Type

Description

obj

Row

The index of the Row that follows the desired Row.

String toSource ()

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

Object of

Cell.rows

Table.rows

Column.rows

Row.rows