Buttons

A collection of buttons.

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
length	Number	readonly	The number of objects in the collection.

Method Listing

Button add (layer:Layer, [at:LocationOptions=LocationOptions], reference:Varies Document MasterSpread Page Spread Layer, withProperties:Object)

Create a new Button

Parameter	Type	Description
layer	Layer	The layer on which to create the Button. (Optional)
at	LocationOptions LocationOptions.AFTER LocationOptions.AT_BEGINNING LocationOptions.AT_END LocationOptions.BEFORE LocationOptions.UNKNOWN	Location (Optional) (default: LocationOptions.UNKNOWN)
reference	Document MasterSpread Page Spread Layer	Before/after this Button or at the beginning/end of this Document, Spread, Master Spread, Page or Layer. Can accept: Document, Spread, MasterSpread, Page or Layer. (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.

Button everyItem ()

Returns every Button in the collection.

Button firstItem ()

Returns the first Button in the collection.

Button item (index:Varies Long String)

Returns the Button with the specified index or name.

Parameter	Type	Description
index	Long String	The index or name. Can accept: Long or String.

Parameter

Type

Description

index

Long

String

The index or name. Can accept: Long 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.

Button itemByRange (from:Varies Button Long String, to:Varies Button Long String)

Returns the Buttons within the specified range.

Parameter	Type	Description
from	Button Long String	The Button, index, or name at the beginning of the range. Can accept: Button, Long or String.
to	Button Long String	The Button, index, or name at the end of the range. Can accept: Button, Long or String.

Parameter

Type

Description

from

Button

Long

String

The Button, index, or name at the beginning of the range. Can accept: Button, Long or String.

Button

Long

String

The Button, index, or name at the end of the range. Can accept: Button, Long or String.