Class

TextBoxes

 A collection of text boxes.

QuickLinks

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

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

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

ParameterTypeDescription
indexnumberThe index.

TextBox add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new TextBox

ParameterTypeDescription
layerLayerThe layer on which to create the TextBox. (Optional)
atLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location at which to insert the TextBox relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
referenceDocument
Layer
MasterSpread
Page
PageItem
Spread
The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional)
withPropertiesObjectInitial values for properties of the new TextBox (Optional)

TextBox anyItem ()
Returns any TextBox in the collection.

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

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

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

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

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

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

ParameterTypeDescription
idnumberThe ID.

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

ParameterTypeDescription
namestringThe name.

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

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

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

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

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

ParameterTypeDescription
objTextBoxThe TextBox whose index comes before the desired TextBox.

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

ParameterTypeDescription
objTextBoxThe index of the TextBox that follows the desired TextBox.

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

Element of

Cell.textBoxes

Character.textBoxes

Document.textBoxes

GraphicLine.textBoxes

Group.textBoxes

InsertionPoint.textBoxes

Layer.textBoxes

Line.textBoxes

MasterSpread.textBoxes

Oval.textBoxes

Page.tabOrder

Page.textBoxes

Paragraph.textBoxes

PlaceGun.textBoxes

Polygon.textBoxes

Rectangle.textBoxes

ShowHideFieldsBehavior.fieldsToHide

ShowHideFieldsBehavior.fieldsToShow

Snippet.textBoxes

SplineItem.textBoxes

Spread.textBoxes

Story.textBoxes

Table.textBoxes

Text.textBoxes

TextColumn.textBoxes

TextFrame.textBoxes

TextStyleRange.textBoxes

Word.textBoxes

XmlStory.textBoxes

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