Adobe InDesign CS6 (8.0) Object Model JS: TextEditboxes

InDesign CS6

Class

TextEditboxes

 A collection of text editboxes.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

TextEditbox add ([withProperties: Object])
Creates a new TextEditbox.

ParameterTypeDescription
withPropertiesObjectInitial values for properties of the new TextEditbox (Optional)

TextEditbox anyItem ()
Returns any TextEditbox in the collection.

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

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

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

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

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

TextEditbox itemByID (id: number)
Returns the TextEditbox with the specified ID.

ParameterTypeDescription
idnumberThe ID.

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

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

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

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

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

ParameterTypeDescription
objTextEditboxThe TextEditbox whose index comes before the desired TextEditbox.

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

ParameterTypeDescription
objTextEditboxThe index of the TextEditbox that follows the desired TextEditbox.

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

Element of

BorderPanel.textEditboxes

DialogColumn.textEditboxes

DialogRow.textEditboxes

EnablingGroup.textEditboxes

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