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 [] (index:Number)

Returns the Button with the specified index.

Parameter	Type	Description
index	Number	The index.

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

Creates 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	The location at which to insert the Button relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
reference	Document Layer MasterSpread Page Spread 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.

Button everyItem ()

Returns every Button in the collection.

Button firstItem ()

Returns the first Button in the collection.

Button item (index:Varies LongInteger String)

Returns the Button with the specified index or name.

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

Parameter

Type

Description

index

LongInteger

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.

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

Returns the Buttons within the specified range.

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

Parameter

Type

Description

from

Button

LongInteger

String

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

Button

LongInteger

String

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