TablesColumns

A collection of table columns.

Instance Properties

Name Description Access
length number The number of objects in the collection. read-only

Methods

add(
[at], reference ​[, withProperties])
anyItem(
)
 → Column
count(
)
 → number
everyItem(
)
 → Column
firstItem(
)
 → Column
item(
index)
 → Column
itemByName(
name)
 → Column
itemByRange(
from, to)
 → Column
lastItem(
)
 → Column
middleItem(
)
 → Column
nextItem(
obj)
 → Column
previousItem(
obj)
 → Column
toSource(
)
 → string
add(
[at=LocationOptions.UNKNOWN], reference ​[, withProperties])
Creates a new Column.
at LocationOptions The Column's location relative to the reference object or within the table. (Optional)
reference 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 Column (Optional)
anyItem(
)
 → Column
Returns any Column in the collection.
count(
)
 → number
Displays the number of elements in the Column.
everyItem(
)
 → Column
Returns every Column in the collection.
firstItem(
)
 → Column
Returns the first Column in the collection.
item(
index)
 → Column
Returns the Column with the specified index or name.
index The index or name. Can accept: Long Integer or String.
itemByName(
name)
 → Column
Returns the Column with the specified name.
name string The name.
itemByRange(
from, to)
 → Column
Returns the Columns within the specified range.
from The Column, index, or name at the beginning of the range. Can accept: Column, Long Integer or String.
to The Column, index, or name at the end of the range. Can accept: Column, Long Integer or String.
lastItem(
)
 → Column
Returns the last Column in the collection.
middleItem(
)
 → Column
Returns the middle Column in the collection.
nextItem(
obj)
 → Column
Returns the Column whose index follows the specified Column in the collection.
obj Column The Column whose index comes before the desired Column.
previousItem(
obj)
 → Column
Returns the Column with the index previous to the specified index.
obj Column The index of the Column that follows the desired Column.
toSource(
)
 → string
Generates a string which, if executed, will return the Column.