A collection of tables.
Go to Property Listing | Method Listing
add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Table add ([to:LocationOptions=LocationOptions], reference:Varies Cell Character InsertionPoint Line Paragraph Story Table Text TextColumn TextFrame TextStyleRange Word XMLElement, withProperties:Object)
Creates a new table.
|
Parameter |
Type |
Description |
|---|---|---|
|
to |
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, TextFrame, Text, Character, Word, Line, Paragraph, TextColumn, InsertionPoint, Story, Cell, TextStyleRange or XMLElement. (Optional) |
|
|
withProperties |
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 Long String)
Returns the Table with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
Long |
The index or name. Can accept: Long or String. |
Table itemByID (id:Number)
Returns the Table with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
Table itemByName (name:String)
Returns the Table with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
Table itemByRange (from:Varies Long Table String, to:Varies Long Table String)
Returns the Tables within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
Long |
The Table, index, or name at the beginning of the range. Can accept: Table, Long or String. |
|
to |
Long |
The Table, index, or name at the end of the range. Can accept: Table, Long 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 |
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 |
The index of the Table that follows the desired Table. |
String toSource ()
Generates a string which, if executed, will return the Table.
Cell.tables
Text.tables
Character.tables
Word.tables
Line.tables
TextColumn.tables
Paragraph.tables
TextStyleRange.tables
InsertionPoint.tables
TextFrame.tables
Story.tables
XMLElement.tables