TextBoxes
QuickLinks
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| length | number | readonly | The number of objects in the collection. |
Methods
Instances
TextBox [] (index:
number)
Returns the TextBox with the specified index.
| Parameter | Type | Description |
|---|---|---|
| index | number | The index. |
TextBox add ([layer:
Layer][, at:
LocationOptions=LocationOptions.UNKNOWN][, reference:
varies][, withProperties:
Object])
Creates a new TextBox
| Parameter | Type | Description |
|---|---|---|
| layer | Layer | The layer on which to create the TextBox. (Optional) |
| at | LocationOptions: 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) |
| reference | Document 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) |
| withProperties | Object | 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.
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.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String | 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 | number | The ID. |
TextBox itemByName (name:
string)
Returns the TextBox with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of TextBox itemByRange (from:
varies, to:
varies)
Returns the TextBoxes within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from | Long Integer String TextBox | The TextBox, index, or name at the beginning of the range. Can accept: TextBox, Long Integer or String. |
| to | Long 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.
| Parameter | Type | Description |
|---|---|---|
| obj | TextBox | 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 | TextBox | The 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.3i | Contents :: Index |