Adobe InCopy CS5.5 (7.5) Object Model JS: Columns

InCopy CS5.5

Class

Columns

 A collection of table columns.

See also Column.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

Column [] (index: number)
Returns the Column with the specified index.

ParameterTypeDescription
indexnumberThe index.

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

ParameterTypeDescription
atLocationOptions:
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)
referenceCell
Column
Row
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)
withPropertiesObjectInitial 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: varies)
Returns the Column with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

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

ParameterTypeDescription
namestringThe name.

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

ParameterTypeDescription
fromColumn
Long Integer
String
The Column, index, or name at the beginning of the range. Can accept: Column, Long Integer or String.
toColumn
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.

ParameterTypeDescription
objColumnThe Column whose index comes before the desired Column.

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

ParameterTypeDescription
objColumnThe 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

Jongware, 29-Apr-2012 v3.0.3iContents :: Index