Adobe InDesign CS6 Server (8.0) Object Model JS: TextColumns

InDesign Server CS6

Class

TextColumns

 A collection of text columns.

See also TextColumn.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

TextColumn anyItem ()
Returns any TextColumn in the collection.

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

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

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

TextColumn item (index: varies)
Returns the TextColumn with the specified index or name.

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

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

ParameterTypeDescription
fromLong Integer
String
TextColumn
The TextColumn, index, or name at the beginning of the range. Can accept: TextColumn, Long Integer or String.
toLong Integer
String
TextColumn
The TextColumn, index, or name at the end of the range. Can accept: TextColumn, Long Integer or String.

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

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

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

ParameterTypeDescription
objTextColumnThe TextColumn whose index comes before the desired TextColumn.

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

ParameterTypeDescription
objTextColumnThe index of the TextColumn that follows the desired TextColumn.

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

Element of

Cell.textColumns

Change.textColumns

Character.textColumns

Footnote.textColumns

HiddenText.textColumns

InsertionPoint.textColumns

Line.textColumns

Note.textColumns

Paragraph.textColumns

Story.textColumns

Text.textColumns

TextColumn.textColumns

TextFrame.textColumns

TextPath.textColumns

TextStyleRange.textColumns

Word.textColumns

XMLElement.textColumns

XmlStory.textColumns

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