A collection of buttons.
Methods
Button
add ([layer:
Layer][, at:
LocationOptions=UNKNOWN][, reference:
any][, withProperties:
Object])
Creates a new Button
| Parameter | Type | Description |
|---|---|---|
| layer | Layer | The layer on which to create the Button. (Optional) |
| at | LocationOptions
: BEFORE AFTER AT_END AT_BEGINNING UNKNOWN |
The location at which to insert the Button relative to the reference object or within the container object. (Optional) (default: UNKNOWN) |
| reference |
Document
Spread MasterSpread Page Layer PageItem |
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 Button (Optional) |
Button
anyItem ()
Returns any Button in the collection.
number count ()
Displays the number of elements in the Button.
Array of Button
everyItem ()
Returns every Button in the collection.
Button
firstItem ()
Returns the first Button in the collection.
Button
item (index:
any)
Returns the Button with the specified index or name.
| Parameter | Type | Description |
|---|---|---|
| index | Long Integer String |
The index or name. Can accept: Long Integer or String. |
Button
itemByID (id:
number)
Returns the Button with the specified ID.
| Parameter | Type | Description |
|---|---|---|
| id | number | The ID. |
Button
itemByName (name:
string)
Returns the Button with the specified name.
| Parameter | Type | Description |
|---|---|---|
| name | string | The name. |
Array of Button
itemByRange (from:
any, to:
any)
Returns the Buttons within the specified range.
| Parameter | Type | Description |
|---|---|---|
| from |
Button
Long Integer String |
The Button, index, or name at the beginning of the range. Can accept: Button, Long Integer or String. |
| to |
Button
Long Integer String |
The Button, index, or name at the end of the range. Can accept: Button, Long Integer or String. |
Button
lastItem ()
Returns the last Button in the collection.
Button
middleItem ()
Returns the middle Button in the collection.
Button
nextItem (obj:
Button)
Returns the Button whose index follows the specified Button in the collection.
| Parameter | Type | Description |
|---|---|---|
| obj | Button | The Button whose index comes before the desired Button. |
Button
previousItem (obj:
Button)
Returns the Button with the index previous to the specified index.
| Parameter | Type | Description |
|---|---|---|
| obj | Button | The index of the Button that follows the desired Button. |
string toSource ()
Generates a string which, if executed, will return the Button.
Element of:
Cell.buttonsCharacter.buttons
Document.buttons
Group.buttons
InsertionPoint.buttons
Layer.buttons
Line.buttons
MasterSpread.buttons
Page.buttons
Paragraph.buttons
Spread.buttons
Story.buttons
Table.buttons
Text.buttons
TextColumn.buttons
TextFrame.buttons
TextStyleRange.buttons
Word.buttons