Methods
| InstancesTable [] (index:
number)
Returns the Table with the specified index.
| Parameter | Type | Description |
|---|
| index | number | The index. |
Table add ([to:
LocationOptions=LocationOptions.UNKNOWN][, reference:
varies][, withProperties:
Object])
Creates a new table.
| Parameter | Type | Description |
|---|
| to | LocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN | The location of the new table relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN) |
| reference | Cell
Character
InsertionPoint
Line
Paragraph
Story
Table
Text
TextColumn
TextFrame
TextStyleRange
Word
XMLElement
XmlStory | The reference object. Note: Required when the to value specifies before or after. Can accept: Table, XMLElement, XmlStory, TextFrame, 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.
Array of Table everyItem ()
Returns every Table in the collection.
Table firstItem ()
Returns the first Table in the collection.
Table item (index:
varies)
Returns the Table with the specified index or name.
| Parameter | Type | Description |
|---|
| index | Long Integer
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. |
Array of Table itemByRange (from:
varies, to:
varies)
Returns the Tables within the specified range.
| Parameter | Type | Description |
|---|
| from | Long Integer
String
Table | The Table, index, or name at the beginning of the range. Can accept: Table, Long Integer or String. |
| to | Long Integer
String
Table | The Table, index, or name at the end of the range. Can accept: Table, Long Integer or String. |
Table lastItem ()
Returns the last Table in the collection.
Table middleItem ()
Returns the middle Table in the collection.
Table nextItem (obj:
Table)
Returns the Table whose index follows the specified Table in the collection.
| Parameter | Type | Description |
|---|
| obj | Table | The Table whose index comes before the desired Table. |
Table previousItem (obj:
Table)
Returns the Table with the index previous to the specified index.
| Parameter | Type | Description |
|---|
| obj | Table | The index of the Table that follows the desired Table. |
string toSource ()
Generates a string which, if executed, will return the Table.
|