Adobe InDesign CS5 (7.0) Object Model JS: Buttons

InDesign CS5

Class

Buttons

 A collection of buttons.

QuickLinks

[], add, anyItem, count, everyItem, firstItem, item, itemByID, itemByName, itemByRange, lastItem, middleItem, nextItem, previousItem, toSource

Properties

PropertyTypeAccessDescription
lengthnumber readonlyThe number of objects in the collection.

Methods

Instances

Button [] (index: number)
Returns the Button with the specified index.

ParameterTypeDescription
indexnumberThe index.

Button add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Creates a new Button

ParameterTypeDescription
layerLayerThe layer on which to create the Button. (Optional)
atLocationOptions:
LocationOptions.BEFORE
LocationOptions.AFTER
LocationOptions.AT_END
LocationOptions.AT_BEGINNING
LocationOptions.UNKNOWN
The location at which to insert the Button relative to the reference object or within the container object. (Optional) (default: LocationOptions.UNKNOWN)
referenceDocument
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)
withPropertiesObjectInitial 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: varies)
Returns the Button with the specified index or name.

ParameterTypeDescription
indexLong Integer
String
The index or name. Can accept: Long Integer or String.

Button itemByID (id: number)
Returns the Button with the specified ID.

ParameterTypeDescription
idnumberThe ID.

Button itemByName (name: string)
Returns the Button with the specified name.

ParameterTypeDescription
namestringThe name.

Array of Button itemByRange (from: varies, to: varies)
Returns the Buttons within the specified range.

ParameterTypeDescription
fromButton
Long Integer
String
The Button, index, or name at the beginning of the range. Can accept: Button, Long Integer or String.
toButton
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.

ParameterTypeDescription
objButtonThe Button whose index comes before the desired Button.

Button previousItem (obj: Button)
Returns the Button with the index previous to the specified index.

ParameterTypeDescription
objButtonThe index of the Button that follows the desired Button.

string toSource ()
Generates a string which, if executed, will return the Button.

Element of

Cell.buttons

Character.buttons

Document.buttons

GraphicLine.buttons

Group.buttons

InsertionPoint.buttons

Layer.buttons

Line.buttons

MasterSpread.buttons

Oval.buttons

Page.buttons

Paragraph.buttons

PlaceGun.buttons

Polygon.buttons

Rectangle.buttons

Snippet.buttons

SplineItem.buttons

Spread.buttons

Story.buttons

Table.buttons

Text.buttons

TextColumn.buttons

TextFrame.buttons

TextStyleRange.buttons

Word.buttons

XmlStory.buttons

Jongware, 20-Jun-2010 v3.0.3dContents :: Index