A collection of table columns.
Go to Property Listing | Method Listing
add, count, item, itemByName, itemByRange, firstItem, lastItem, middleItem, previousItem, nextItem, anyItem, everyItem, toSource, []
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
length |
readonly |
The number of objects in the collection. |
Column [] (index:Number)
Returns the Column with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
Varies add ([at:LocationOptions=LocationOptions], reference:Varies, withProperties:Object)
Creates a new Column.
|
Parameter |
Type |
Description |
|---|---|---|
|
at |
LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN |
The Column's location relative to the reference object or within the table. (Optional) (default: LocationOptions.UNKNOWN) |
|
reference |
Varies |
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 |
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.
Column everyItem ()
Returns every Column in the collection.
Column firstItem ()
Returns the first Column in the collection.
Column item (index:Varies)
Returns the Column with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
Varies |
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 |
The name. |
Column itemByRange (from:Varies, to:Varies)
Returns the Columns within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
Varies |
The Column, index, or name at the beginning of the range. Can accept: Column, Long Integer or String. |
|
to |
Varies |
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 |
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 |
The index of the Column that follows the desired Column. |
String toSource ()
Generates a string which, if executed, will return the Column.