Columns

A collection of table columns.

Methods

any add ([at: LocationOptions=UNKNOWN][, reference: any][, withProperties: Object])
Creates a new Column.

Parameter Type Description
at LocationOptions :
BEFORE
AFTER
AT_END
AT_BEGINNING
UNKNOWN		 The Column's location relative to the reference object or within the table. (Optional) (default: UNKNOWN)
reference Row
Column
Cell
Table 		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)

Column anyItem ()
Returns any Column in the collection.

number count ()
Displays the number of elements in the Column.

Array of Column everyItem ()
Returns every Column in the collection.

Column firstItem ()
Returns the first Column in the collection.

Column item (index: any)
Returns the Column with the specified index or name.

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

Column itemByName (name: string)
Returns the Column with the specified name.

Parameter Type Description
name string The name.

Array of Column itemByRange (from: any, to: any)
Returns the Columns within the specified range.

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

Column lastItem ()
Returns the last Column in the collection.

Column middleItem ()
Returns the middle Column in the collection.

Column nextItem (obj: Column)
Returns the Column whose index follows the specified Column in the collection.

Parameter Type Description
obj Column The Column whose index comes before the desired Column.

Column previousItem (obj: Column)
Returns the Column with the index previous to the specified index.

Parameter Type Description
obj Column The index of the Column that follows the desired Column.

string toSource ()
Generates a string which, if executed, will return the Column.

Element of:

Cell.columns
Column.columns
Row.columns
Table.columns