TextBoxes
A collection of text boxes.
Go to Property Listing | Method Listing
Methods:
[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource
Property Listing
|
Property |
Type |
Access |
Description |
|---|---|---|---|
|
readonly |
The number of objects in the collection. |
Method Listing
TextBox [] (index:Number)
Returns the TextBox with the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
The index. |
TextBox add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document Layer MasterSpread Page Spread PageItem, withProperties:Object)
Creates a new TextBox
|
Parameter |
Type |
Description |
|---|---|---|
|
layer |
The layer on which to create the TextBox. (Optional) |
|
|
at |
The location at which to insert the TextBox relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN) |
|
|
reference |
The reference object. Note: Required when the at parameter is before or after. Can accept: Document, Spread, MasterSpread, Page, Layer or PageItem. (Optional) |
|
|
withProperties |
Initial 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.
TextBox everyItem ()
Returns every TextBox in the collection.
TextBox firstItem ()
Returns the first TextBox in the collection.
TextBox item (index:Varies LongInteger String)
Returns the TextBox with the specified index or name.
|
Parameter |
Type |
Description |
|---|---|---|
|
index |
LongInteger |
The index or name. Can accept: Long Integer or String. |
TextBox itemByID (id:Number)
Returns the TextBox with the specified ID.
|
Parameter |
Type |
Description |
|---|---|---|
|
id |
The ID. |
TextBox itemByName (name:String)
Returns the TextBox with the specified name.
|
Parameter |
Type |
Description |
|---|---|---|
|
name |
The name. |
TextBox itemByRange (from:Varies LongInteger TextBox String, to:Varies LongInteger TextBox String)
Returns the TextBoxes within the specified range.
|
Parameter |
Type |
Description |
|---|---|---|
|
from |
LongInteger |
The TextBox, index, or name at the beginning of the range. Can accept: TextBox, Long Integer or String. |
|
to |
LongInteger |
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.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The TextBox whose index comes before the desired TextBox. |
TextBox previousItem (obj:TextBox)
Returns the TextBox with the index previous to the specified index.
|
Parameter |
Type |
Description |
|---|---|---|
|
obj |
The index of the TextBox that follows the desired TextBox. |
String toSource ()
Generates a string which, if executed, will return the TextBox.
Object of
PlaceGun.textBoxes
Document.textBoxes
Layer.textBoxes
Spread.textBoxes
Page.textBoxes
MasterSpread.textBoxes
Oval.textBoxes
Rectangle.textBoxes
GraphicLine.textBoxes
Polygon.textBoxes
Group.textBoxes
SplineItem.textBoxes
Snippet.textBoxes
Cell.textBoxes
Table.textBoxes
Text.textBoxes
Character.textBoxes
Word.textBoxes
Line.textBoxes
TextColumn.textBoxes
Paragraph.textBoxes
TextStyleRange.textBoxes
InsertionPoint.textBoxes
TextFrame.textBoxes
Story.textBoxes
EndnoteTextFrame.textBoxes
XmlStory.textBoxes
ShowHideFieldsBehavior.fieldsToHide
Page.tabOrder
ShowHideFieldsBehavior.fieldsToShow