Object

Button

A button.

Hierarchy

Button

10 preference objects

Properties

Type	Access	Description
Flip	read/write	Indicates whether the Button has been flipped independently of its parent object and, if yes, the direction in which the Button was flipped.
Number	read/write	The horizontal scale of the Button relative to its containing object.
Number	read/write	The rotation angle of the Button relative to its containing object. (Range: -360 to 360)
Number	read/write	The skewing angle of the Button relative to its containing object. (Range: -360 to 360)
Number	read/write	The vertical scale of the Button relative to its containing object.
Number	read/write	The index of the active state in the object's states collection.
Article[]	readonly	The list of all articles this page item is part of
Graphic[]	readonly	Lists all graphics contained by the Button.
PageItem[]	readonly	Lists all page items contained by the Button.
Boolean	read/write	If true, the master page item can be overridden.
AnchoredObjectSetting	readonly	Anchored object settings.
AnimationBehaviors<AnimationBehavior>	readonly	A collection of animation behaviors.
AnimationSetting	readonly	The page item animation settings.
ObjectStyle	read/write	The object style applied to the Button.
ArrowHeadAlignmentEnum	read/write	The arrowhead alignment applied to the Button.
XMLItem	readonly	The XML element associated with the Button.
Behaviors<Behavior>	readonly	A collection of behavior objects.
CornerOptions	read/write	The shape to apply to the bottom left corner of rectangular shapes.
Number \| String unit	read/write	The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
CornerOptions	read/write	The shape to apply to the bottom right corner of rectangular shapes.
Number \| String unit	read/write	The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
ClearFormBehaviors<ClearFormBehavior>	readonly	A collection of clear form behavior objects.
ContentTransparencySetting	readonly	Transparency settings for the content of the Button.
String	read/write	The description of the Button.
EndCap	read/write	The end shape of an open path.
EndJoin	read/write	The corner join applied to the Button.
EndnoteTextFrames<EndnoteTextFrame>	readonly	A collection of endnote text frames.
EPSs<EPS>	readonly	A collection of EPS files.
EPSTexts<EPSText>	readonly	EPSTexts
EventListeners<EventListener>	readonly	A collection of event listeners.
Events<Event>	readonly	A collection of events.
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Button. . Can also accept: String.
Number 0–100	read/write	The percent of tint to use in the Button's fill color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
FillTransparencySetting	readonly	Transparency settings for the fill applied to the Button.
Flip	read/write	The direction in which to flip the printed image.
Swatch	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
Number 0–100	read/write	The tint as a percentage of the gap color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
Number[] \| String[] unit	read/write	The bounds of the Button excluding the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
GotoAnchorBehaviors<GotoAnchorBehavior>	readonly	A collection of goto anchor behavior objects.
GotoFirstPageBehaviors<GotoFirstPageBehavior>	readonly	A collection of goto first page behavior objects.
GotoLastPageBehaviors<GotoLastPageBehavior>	readonly	A collection of goto last page behavior objects.
GotoNextPageBehaviors<GotoNextPageBehavior>	readonly	A collection of goto next page behavior objects.
GotoNextStateBehaviors<GotoNextStateBehavior>	readonly	A collection of goto next state behaviors.
GotoNextViewBehaviors<GotoNextViewBehavior>	readonly	A collection of goto next view behavior objects.
GotoPageBehaviors<GotoPageBehavior>	readonly	A collection of go to page behavior objects.
GotoPreviousPageBehaviors<GotoPreviousPageBehavior>	readonly	A collection of goto previous page behavior objects.
GotoPreviousStateBehaviors<GotoPreviousStateBehavior>	readonly	A collection of goto previous state behaviors.
GotoPreviousViewBehaviors<GotoPreviousViewBehavior>	readonly	A collection of goto previous view behavior objects.
GotoStateBehaviors<GotoStateBehavior>	readonly	A collection of goto state behaviors.
GotoURLBehaviors<GotoURLBehavior>	readonly	A collection of goto URL behavior objects.
Number	read/write	The angle of a linear gradient applied to the fill of the Button. (Range: -180 to 180)
Number \| String unit	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Button.
Number[] \| String[] unit	read/write	The starting point (in page coordinates) of a gradient applied to the fill of the Button, in the format [x, y].
Number	read/write	The angle of a linear gradient applied to the stroke of the Button. (Range: -180 to 180)
Number \| String unit	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Button.
Number[] \| String[] unit	read/write	The starting point (in page coordinates) of a gradient applied to the stroke of the Button, in the format [x, y].
GraphicLines<GraphicLine>	readonly	A collection of graphic lines.
Graphics<Graphic>	readonly	A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
Groups<Group>	readonly	A collection of groups.
Boolean	read/write	If true, the form field/push button is hidden until triggered in the exported PDF.
DimensionsConstraints[]	read/write	The left margin, width, and right margin constraints this item is subject to when using the object-based layout rule.
Number	read/write	The horizontal scaling applied to the Button.
Number	readonly	The unique ID of the Button.
Images<Image>	readonly	A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
Number	readonly	The index of the Button within its containing object.
Boolean	readonly	Returns true if the object specifier resolves to valid objects.
Layer	read/write	The layer that the Button is on.
String	read/write	A property that can be set to any string.
Number 1–1000	read/write	The scaling applied to the arrowhead at the start of the path. (Range: 1 to 1000)
ArrowHead	read/write	The arrowhead applied to the start of the path.
LinkedPageItemOption	readonly	Linked Page Item options
Boolean	read/write	If true, the Button is locked.
Number = 4 1–500	read/write	The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.
MovieBehaviors<MovieBehavior>	readonly	A collection of movie behavior objects.
String	read/write	The name of the Button.
Boolean	read/write	If true, the Button does not print.
OpenFileBehaviors<OpenFileBehavior>	readonly	A collection of open file behavior objects.
Ovals<Oval>	readonly	A collection of ellipses.
Boolean	read/write	If true, the Button's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
Boolean	read/write	If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
Boolean	read/write	If true, the Button's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
Boolean	readonly	If true, the object originated on a master spread and was overridden. If false, the object either originated on a master spread and was not overridden, or the object did not originate on a master page.
Graphic \| Guide \| Movie \| PageItem \| Sound	readonly	An object that originated on a master page and has been overridden. Can return: PageItem, Guide, Graphic, Movie or Sound.
PageItems<PageItem>	readonly	The page items collection, which can be used to process all page items in a container (such as a document, page, or group), regardless of type.
GraphicLine \| Group \| MasterSpread \| Oval \| PlaceGun \| Polygon \| Rectangle \| SplineItem \| Spread \| Character \| Snippet	readonly	The parent of the Button (a Snippet, PlaceGun, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group or Character).
Page	readonly	The page on which this page item appears.
Paths<Path>	readonly	A collection of paths.
PDFs<PDF>	readonly	A collection of PDF files.
PICTs<PICT>	readonly	A collection of PICT graphics.
Polygons<Polygon>	readonly	A collection of polygons.
Preferences<Preference>	readonly	A collection of preferences objects.
PrintFormBehaviors<PrintFormBehavior>	readonly	A collection of print form behavior objects.
Boolean	read/write	If true, the form field/push button is printable in the exported PDF.
Object	read/write	A property that allows setting of several properties at the same time.
Rectangles<Rectangle>	readonly	A collection of rectangles.
Number 1–1000	read/write	The scaling applied to the arrowhead at the end of the path. (Range: 1 to 1000)
ArrowHead	read/write	The arrowhead applied to the end of the path.
Number	read/write	The rotatation angle of the Button. (Range: -360 to 360)
Number	read/write	The skewing angle applied to the Button. (Range: -360 to 360)
ShowHideFieldsBehaviors<ShowHideFieldsBehavior>	readonly	A collection of show/hide fields behavior objects.
SoundBehaviors<SoundBehavior>	readonly	A collection of sound behavior objects.
SplineItems<SplineItem>	readonly	The spline items collection.
States<State>	readonly	A collection of states.
StrokeAlignment	read/write	The stroke alignment applied to the Button.
Swatch \| String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Button. Can also accept: String.
StrokeCornerAdjustment	read/write	The corner adjustment applied to the Button.
Number[] \| String[] unit	read/write	The dash and gap measurements that define the pattern of a custom dashed line. Define up to six values (in points) in the format [dash1, gap1, dash2, gap2, dash3, gap3].
Number 0–100	read/write	The percent of tint to use in object's stroke color. (To specify a tint percent, use a number in the range of 0 to 100; to use the inherited or overridden value, use -1.)
StrokeTransparencySetting	readonly	Transparency settings for the stroke.
StrokeStyle \| String	read/write	The name of the stroke style to apply. Can also accept: String.
Number \| String unit	read/write	The weight (in points) to apply to the Button's stroke.
SubmitFormBehaviors<SubmitFormBehavior>	readonly	A collection of submit form behavior objects.
SVGs<SVG>	readonly	A collection of SVG files.
TextFrames<TextFrame>	readonly	A collection of text frames.
TextWrapPreference	readonly	The text wrap preference properties that define the default formatting for wrapping text around objects.
TimingSetting	readonly	The object timing settings.
CornerOptions	read/write	The shape to be applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes.Note: corner option differs from end join in which you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends on the stroke weight.
Number \| String unit	read/write	The radius in measurement units of the corner effect applied to the top left corner of rectangular shapes and all corners of non-rectangular shapes
CornerOptions	read/write	The shape to apply to the top right corner of rectangular shapes
Number \| String unit	read/write	The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
TransparencySetting	readonly	Transparency settings.
DimensionsConstraints[]	read/write	The top margin, height, and bottom margin constraints this item is subject to when using the object-based layout rule.
Number	read/write	The vertical scaling applied to the Button.
ViewZoomBehaviors<ViewZoomBehavior>	readonly	A collection of view zoom behavior objects.
Boolean	read/write	If true, the Button is visible.
Number[] \| String[] unit	read/write	The bounds of the Button including the stroke width, in the format [y1, x1, y2, x2], which give the coordinates of the top-left and bottom-right corners of the bounding box.
WMFs<WMF>	readonly	A collection of WMF graphics.

Events

Name	Description
	Dispatched after a Button is placed. This event bubbles. This event is not cancelable.
	Dispatched before a Button is placed. This event bubbles. This event is cancelable.

Methods

→ EventListener

Adds an event listener.

eventType String The event type.

handler File | JavaScriptFunction The event handler. Can accept: File or JavaScript Function.

captures? Boolean This parameter is obsolete.

→ void

Applies the specified object style.

using ObjectStyle The object style to apply.

clearingOverrides? Boolean If true, clears the Button's existing attributes before applying the style.

clearingOverridesThroughRootObjectStyle? Boolean If true, clears attributes and formatting applied to the Button that are not defined in the object style.

→ void

Tag the object or the parent story using default tags defined in XML preference.

→ void

Brings the Button forward one level in its layer.

→ void

Brings the Button to the front of its layer or in front of a particular item.

reference? PageItem The reference object to bring the object in front of (must have same parent)

→ PageItem[]

Finds objects that match the find what value and replace the objects with the change to value.

reverseOrder? Boolean If true, returns the results in reverse order.

→ void

Clear overrides for object style

→ void

Clears transformations from the Button. Transformations include rotation, scaling, flipping, fitting, and shearing.

→ Varies[]

Duplicate an object and place it into the target page item.

pageItems PageItem[] One or more page items to place or load

linkPageItems? Boolean Whether to link pageItems in content placer (if true it will override link stories value)

linkStories? Boolean Whether to link stories in content placer (only applicable for single story, pageItem links will also be created in case of more than one item)

mapStyles? Boolean Whether to map styles in content placer

showingOptions? Boolean Whether to display the link options dialog

→ void

Converts the Button to a different shape.

given ConvertShapeOptions The Button's new shape.

numberOfSides? Number 3–100 The number of sides for the resulting polygon. (Range: 3 to 100)

insetPercentage? Number 0–100 The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0)

cornerRadius? Number | String unit The corner radius of the resulting rectangle.

→ void

Converts the button object to the page item currently in the active state. Page items from other states will be lost.

→ void

Create Email QR Code on the page item or document

emailAddress? String QR code Email Address

subject? String QR code Email Subject

body? String QR code Email Body Message

qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.

withProperties? String[] Initial values for properties of the new Button. Above parameters can also be passed as properties

→ void

Create Hyperlink QR Code on the page item or document

urlLink? String QR code Hyperlink URL

qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.

withProperties? String[] Initial values for properties of the new Button. Above parameters can also be passed as properties

→ void

Create Plain Text QR Code on the page item

plainText? String QR code Plain Text

qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.

withProperties? String[] Initial values for properties of the new Button. Above parameters can also be passed as properties

→ void

Create Text Msg QR Code on the page item or document

cellNumber? String QR code Text Phone Number

textMessage? String QR code Text Message

qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.

withProperties? String[] Initial values for properties of the new Button. Above parameters can also be passed as properties

→ void

Create Business Card QR Code on the page item or load on document's placegun

firstName? String QR code Business Card First Name

lastName? String QR code Business Card Last Name

jobTitle? String QR code Business Card Title

cellPhone? String QR code Business Card Cell Phone Number

phone? String QR code Business Card Phone Number

email? String QR code Business Card Email Address

organisation? String QR code Business Card Organisation

streetAddress? String QR code Business Card Street Address

city? String QR code Business Card City

adrState? String QR code Business Card State

country? String QR code Business Card Country

postalCode? String QR code Business Card Postal Code

website? String QR code Business Card URL

qrCodeSwatch? Swatch | String Swatch to be applied on generated QR Code Graphic . Can accept: Swatch or String.

withProperties? String[] Initial values for properties of the new Button. Above parameters can also be passed as properties

→ void

Detaches an overridden master page item from the master page.

→ PageItem

Duplicates the Button at the specified location or offset.

to? 2 Units[] | Page[] | Spread[] | Layer[] The location of the new Button, specified in coordinates in the format [x, y]. Can accept: Array of 2 Units, Spread, Page or Layer.

by? Number[] | String[] unit Amount by which to offset the new Button from the original Button's position.

→ void

Exports the object(s) to a file.

format ExportFormat | String The export format, specified as an enumeration value or as an extension that appears in the Save as type or Format menu in the Export dialog. Can accept: ExportFormat enumerator or String.

to File The path to the export file.

using? PDFExportPreset The export style.

versionComments? String The comment for this version.

forceSave? Boolean If true, forcibly saves a version.

→ String

Gets the label value associated with the specified key.

key String The key.

→ PageItem[]

Finds objects that match the find what value.

reverseOrder? Boolean If true, returns the results in reverse order.

→ void

Applies the specified fit option to content in a frame.

given FitOptions The fit option to use.

→ void

Flips the Button.

given Flip The axis around which to flip the Button.

around? 2 Units[] | AnchorPoint[] The point around which to flip the Button. Can accept: Array of 2 Units or AnchorPoint enumerator.

→ Button[]

Resolves the object specifier, creating an array of object references.

→ void

Sets the label to the value associated with the specified key.

key String The key.

value String The value.

→ void

Associates the page item with the specified XML element while preserving existing content.

using XMLElement The XML element.

→ void

Moves the Button to a new location. Note: Either the 'to' or 'by' parameter is required; if both parameters are defined, only the to value is used.

to? 2 Units[] | Page[] | Spread[] | Layer[] The new location of the Button,in the format (x, y). Can accept: Array of 2 Units, Spread, Page or Layer.

by? Number[] | String[] unit The amount (in measurement units) to move the Button relative to its current position, in the format (x, y).

→ Varies

Overrides a master page item and places the item on the document page as a new object.

destinationPage Page The document page that contains the master page item to override.

→ void

Places XML content into the specified object. Note: Replaces any existing content.

using XMLElement The XML element whose content you want to place.

→ void

Apply an item's scaling to its content if possible.

to? Number[] The scale factors to be left on the item. The default is {1.0, 1.0}.

→ void

Move the bounding box of the page item

in CoordinateSpaces | BoundingBoxLimits | Array The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.

opposingCorners Varies[] Opposing corners of new bounding box in the given coordinate space

→ void

Deletes the Button.

→ Boolean

Removes the event listener.

eventType String The registered event type.

handler File | JavaScriptFunction The registered event handler. Can accept: File or JavaScript Function.

captures? Boolean This parameter is obsolete.

→ void

Removes the override from a previously overridden master page item.

→ void

Resize the page item.

in BoundingBoxLimits | CoordinateSpaces | BoundingBoxLimits | Array The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.

from AnchorPoint[] | AnchorPoints[] | 2 Reals[] | BoundingBoxLimitss[] | CoordinateSpacess[] | Arrays of 2 Reals[] | LongIntegers[] The transform origin. Legal specifications: relative to bounding box: anchor | {anchor | {x,y}, bounds kind [, coordinate space]}; relative to coordinate space: {x,y} | {{x,y}[, coordinate space]}; relative to layout window ruler: {{x,y}, page index | bounds kind}. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.

by ResizeMethods How the current dimensions are affected by the given values

values Reals[] | ResizeConstraintss[] | CoordinateSpacess[] The width and height values. Legal dimensions specifications: {x, y [, coordinate space]}, {x, resize constraint [, coordinate space]}, or {resize constraint, y [, coordinate space]}; where x and y are real numbers and coordinate space is used to determine _only_ the unit of length for x and y; coordinate space is ignored for the 'current dimensions times' resize method). Can accept: Array of Reals, ResizeConstraints enumerators or CoordinateSpaces enumerators.

resizeIndividually? Boolean If false and multiple page items are targeted, the new dimensions are attained only by moving the individual items rather than resizing them.

consideringRulerUnits? Boolean If true then a ruler location is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page.

→ Varies

Get the coordinates of the given location in the specified coordinate system.

location AnchorPoint[] | AnchorPoints[] | 2 Reals[] | BoundingBoxLimitss[] | CoordinateSpacess[] | Arrays of 2 Reals[] | LongIntegers[] The location requested. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.

in CoordinateSpaces The coordinate space to use.

→ void

Sends the Button back one level in its layer.

→ void

Sends the Button to the back of its layer or behind a particular item (must have same parent).

reference? PageItem The reference object to send the object behind

→ Asset

Stores the object in the specified library.

using Library The library in which to store the object.

withProperties? Object Initial values for properties of the new Button

→ String

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

→ String

Retrieves the object specifier.

→ void

Transform the page item.

in CoordinateSpaces The coordinate space to use

from AnchorPoint[] | AnchorPoints[] | 2 Reals[] | BoundingBoxLimitss[] | CoordinateSpacess[] | Arrays of 2 Reals[] | LongIntegers[] The temporary origin during the transformation. Can accept: Array of 2 Reals, AnchorPoint enumerator or Array of Arrays of 2 Reals, CoordinateSpaces enumerators, AnchorPoint enumerators, BoundingBoxLimits enumerators or Long Integers.

withMatrix 6 Reals[] | TransformationMatrix[] Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.

replacingCurrent? MatrixContent enumerators[] | MatrixContent[] | LongInteger[] Transform components to consider; providing this optional parameter causes the target's existing transform components to be replaced with new values. Without this parameter, the given matrix is concatenated onto the target's existing transform combining the effect of the two. Can accept: MatrixContent enumerator, Array of MatrixContent enumerators or Long Integer.

consideringRulerUnits? Boolean If true then a ruler based origin is interpreted using ruler units rather than points. The default value is false. This parameter has no effect unless the reference point is specified relative to a page.

→ TransformationMatrix[]

Get the transformation values of the page item.

in CoordinateSpaces The coordinate space to use

Object of 40

Properties elsewhere that hold a Button.

Parameter of 3

Method parameters that accept a Button.

Buttons.itemByRange(from)Buttons.nextItem(obj)Buttons.previousItem(obj)

Return 14

Methods that return a Button.

Button.getElements()Buttons.[]()Buttons.add()Buttons.anyItem()Buttons.everyItem()Buttons.firstItem()Buttons.item()Buttons.itemByID()Buttons.itemByName()Buttons.itemByRange()Buttons.lastItem()Buttons.middleItem()Buttons.nextItem()Buttons.previousItem()