Tables

A collection of tables.

Go to Property Listing | Method Listing

Methods:

[], add, anyItem, count, everyItem, firstItem, item, itemByID, 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

Table [] (index:Number)

Returns the Table with the specified index.

Parameter	Type	Description
index	Number	The index.

Table add ([to:LocationOptions=LocationOptions], reference:Varies Character EndnoteTextFrame InsertionPoint Line Paragraph Story Table Text TextColumn TextFrame TextStyleRange Word XMLElement XmlStory Cell, withProperties:Object)

Creates a new table.

Parameter	Type	Description
to	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	The location of the new table relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
reference	Character EndnoteTextFrame InsertionPoint Line Paragraph Story Table Text TextColumn TextFrame TextStyleRange Word XMLElement XmlStory Cell	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)

Parameter

Type

Description

LocationOptions

LocationOptions.AFTER

LocationOptions.AT_BEGINNING

LocationOptions.AT_END

LocationOptions.BEFORE

LocationOptions.UNKNOWN

The location of the new table relative to the reference object or within the container object. (Optional)

(default: LocationOptions.UNKNOWN)

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)

Table anyItem ()

Returns any Table in the collection.

Number count ()

Displays the number of elements in the Table.

Table everyItem ()

Returns every Table in the collection.

Table firstItem ()

Returns the first Table in the collection.

Table item (index:Varies LongInteger String)

Returns the Table with the specified index or name.

Parameter	Type	Description
index	LongInteger String	The index or name. Can accept: Long Integer or String.

Parameter

Type

Description

index

LongInteger

String

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

Table itemByID (id:Number)

Returns the Table with the specified ID.

Parameter	Type	Description
id	Number	The ID.

Table itemByName (name:String)

Returns the Table with the specified name.

Parameter	Type	Description
name	String	The name.

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

Returns the Tables within the specified range.

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

Parameter

Type

Description

from

LongInteger

Table

String

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

LongInteger

Table

String

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