TablesTables

Instance Properties

Methods

add(

[to=LocationOptions.UNKNOWN], reference ​[, withProperties])

→ Table

Creates a new table.

to	LocationOptions The location of the new table relative to the reference object or within the container object. (Optional)
reference	The reference object. Note: Required when the to value specifies before or after. Can accept: Table, XMLElement, XmlStory, TextFrame, EndnoteTextFrame, Text, InsertionPoint, TextStyleRange, Paragraph, TextColumn, Line, Word, Character, Story or Cell. (Optional)
withProperties	Object Initial values for properties of the new Table (Optional)

anyItem(

)

→ Table

Returns any Table in the collection.

count(

)

→ number

Displays the number of elements in the Table.

everyItem(

)

→ Table

Returns every Table in the collection.

firstItem(

)

→ Table

Returns the first Table in the collection.

item(

index)

→ Table

Returns the Table with the specified index or name.

index

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

itemByID(

id)

→ Table

Returns the Table with the specified ID.

id	number The ID.

itemByName(

name)

→ Table

Returns the Table with the specified name.

name	string The name.

itemByRange(

from, to)

→ Table

Returns the Tables within the specified range.

from	The Table, index, or name at the beginning of the range. Can accept: Table, Long Integer or String.
to	The Table, index, or name at the end of the range. Can accept: Table, Long Integer or String.

lastItem(

)

→ Table

Returns the last Table in the collection.

middleItem(

)

→ Table

Returns the middle Table in the collection.

nextItem(

obj)

→ Table

Returns the Table whose index follows the specified Table in the collection.

obj	Table The Table whose index comes before the desired Table.

previousItem(

obj)

→ Table

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

obj	Table The index of the Table that follows the desired Table.

toSource(

)

→ string

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