Button

A button.

Go to Property Listing | Method Listing

Objects:

AnchoredObjectSetting, ArrowHead, Behaviors, Boolean, CloseWindowBehaviors, ContentTransparencySetting, CornerOptions, DisplaySettingOptions, EPSs, EndCap, EndJoin, FillTransparencySetting, Flip, FrameFittingOption, GotoAnchorBehaviors, GotoFirstPageBehaviors, GotoLastPageBehaviors, GotoNextPageBehaviors, GotoNextViewBehaviors, GotoPageBehaviors, GotoPreviousPageBehaviors, GotoPreviousViewBehaviors, GotoURLBehaviors, Graphic, GraphicLines, Graphics, Groups, Guide, Images, Layer, LockStateValues, Movie, MovieBehaviors, Number, Object, ObjectStyle, OpenFileBehaviors, Ovals, PDFs, PICTs, PageItem, PageItems, Polygons, QuitBehaviors, Rectangles, ShowHideFieldsBehaviors, Sound, SoundBehaviors, States, String, StrokeAlignment, StrokeCornerAdjustment, StrokeStyle, StrokeTransparencySetting, Swatch, TextFrames, TextWrapPreference, TransparencySetting, ViewZoomBehaviors, VisibilityInPdf, WMFs, XMLItem

Preferences:

FrameFittingOption, TextWrapPreference

Hierarchy:

Superclass: FormField

Class: Button

Property Listing

Property	Type	Access	Description
absoluteFlip	Flip Flip.BOTH Flip.HORIZONTAL Flip.HORIZONTAL_AND_VERTICAL Flip.NONE Flip.VERTICAL	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.
absoluteHorizontalScale	Number	read/write	The horizontal scale of the Button relative to its containing object.
absoluteRotationAngle	Number	read/write	The rotation angle of the Button relative to its containing object. (Range: -360 to 360)
absoluteShearAngle	Number	read/write	The skewing angle of the Button relative to its containing object. (Range: -360 to 360)
absoluteVerticalScale	Number	read/write	The vertical scale of the Button relative to its containing object.
allGraphics	Array of Graphic	readonly	Lists all graphics contained by the Button.
allPageItems	Array of PageItem	readonly	Lists all page items contained by the Button.
allowOverrides	Boolean	read/write	If true, the master page item can be overridden.
anchoredObjectSettings	AnchoredObjectSetting	readonly	Anchored object settings.
appliedObjectStyle	ObjectStyle	read/write	The object style applied to the Button.
associatedXMLElement	XMLItem	readonly	The XML element associated with the Button.
behaviors	Behaviors Behavior	readonly	A collection of behavior objects.
closeWindowBehaviors	CloseWindowBehaviors CloseWindowBehavior	readonly	A collection of close window behavior objects.
contentTransparencySettings	ContentTransparencySetting	readonly	Transparency settings for the content of the Button.
cornerOption	CornerOptions CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER CornerOptions.INSET_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.NONE CornerOptions.ROUNDED_CORNER	read/write	The shape to apply to corner points in a path. Note: corner option differs from end join in that you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends upon the stroke weight.
cornerRadius	Number String	read/write	The radius in measurement units of the corner effect.
description	String	read/write	The description of the Button.
endCap	EndCap EndCap.BUTT_END_CAP EndCap.PROJECTING_END_CAP EndCap.ROUND_END_CAP	read/write	The end shape of an open path.
endJoin	EndJoin EndJoin.BEVEL_END_JOIN EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN	read/write	The corner join applied to the Button.
epss	EPSs EPS	readonly	A collection of EPS files.
fillColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Button. . Can also accept: String.
fillTint	Number (range 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.)
fillTransparencySettings	FillTransparencySetting	readonly	Transparency settings for the fill applied to the Button.
flip	Flip Flip.BOTH Flip.HORIZONTAL Flip.HORIZONTAL_AND_VERTICAL Flip.NONE Flip.VERTICAL	read/write	The direction in which to flip the printed image.
frameFittingOptions	FrameFittingOption	readonly	The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application.
gapColor	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.
gapTint	Number (range 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.)
geometricBounds	Array of Number Array of String	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	GotoAnchorBehaviors GotoAnchorBehavior	readonly	A collection of goto anchor behavior objects.
gotoFirstPageBehaviors	GotoFirstPageBehaviors GotoFirstPageBehavior	readonly	A collection of goto first page behavior objects.
gotoLastPageBehaviors	GotoLastPageBehaviors GotoLastPageBehavior	readonly	A collection of goto last page behavior objects.
gotoNextPageBehaviors	GotoNextPageBehaviors GotoNextPageBehavior	readonly	A collection of goto next page behavior objects.
gotoNextViewBehaviors	GotoNextViewBehaviors GotoNextViewBehavior	readonly	A collection of goto next view behavior objects.
gotoPageBehaviors	GotoPageBehaviors GotoPageBehavior	readonly	A collection of go to page behavior objects.
gotoPreviousPageBehaviors	GotoPreviousPageBehaviors GotoPreviousPageBehavior	readonly	A collection of goto previous page behavior objects.
gotoPreviousViewBehaviors	GotoPreviousViewBehaviors GotoPreviousViewBehavior	readonly	A collection of goto previous view behavior objects.
gotoURLBehaviors	GotoURLBehaviors GotoURLBehavior	readonly	A collection of goto URL behavior objects.
gradientFillAngle	Number	read/write	The angle of a linear gradient applied to the fill of the Button. (Range: -180 to 180)
gradientFillLength	Number String	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Button.
gradientFillStart	Array of Number Array of String	read/write	The starting point (in page coordinates) of a gradient applied to the fill of the Button, in the format [x, y].
gradientStrokeAngle	Number	read/write	The angle of a linear gradient applied to the stroke of the Button. (Range: -180 to 180)
gradientStrokeLength	Number String	read/write	The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Button.
gradientStrokeStart	Array of Number Array of String	read/write	The starting point (in page coordinates) of a gradient applied to the stroke of the Button, in the format [x, y].
graphicLines	GraphicLines GraphicLine	readonly	A collection of graphic lines.
graphics	Graphics Graphic	readonly	A collection of imported graphics in any graphic file format (vector, metafile, or bitmap).
groups	Groups Group	readonly	A collection of groups.
horizontalScale	Number	read/write	The horizontal scaling applied to the Button.
id	Number	readonly	The unique ID of the Button.
images	Images Image	readonly	A collection of bitmap images in any bitmap file format (including TIFF, JPEG, or GIF).
index	Number	readonly	The index of the Button within its containing object.
isValid	Boolean	readonly	Returns true if the object specifier resolves to valid objects.
itemLayer	Layer	read/write	The layer that the Button is on.
label	String	read/write	A property that can be set to any string.
leftLineEnd	ArrowHead ArrowHead.BARBED_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD	read/write	The arrowhead applied to the start of the path.
localDisplaySetting	DisplaySettingOptions DisplaySettingOptions.DEFAULT_VALUE DisplaySettingOptions.HIGH_QUALITY DisplaySettingOptions.OPTIMIZED DisplaySettingOptions.TYPICAL	read/write	Display performance options for the Button.
lockState	LockStateValues LockStateValues.CHECKED_IN_STORY LockStateValues.CHECKED_OUT_STORY LockStateValues.EMBEDDED_STORY LockStateValues.LOCKED_STORY LockStateValues.MISSING_LOCK_STATE LockStateValues.MIXED_LOCK_STATE LockStateValues.NONE LockStateValues.UNMANAGED_STORY	readonly	The lock state.
locked	Boolean	read/write	If true, the Button is locked.
miterLimit	Number (range 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	MovieBehaviors MovieBehavior	readonly	A collection of movie behavior objects.
name	String	read/write	The name of the Button.
nonprinting	Boolean	read/write	If true, the Button does not print.
openFileBehaviors	OpenFileBehaviors OpenFileBehavior	readonly	A collection of open file behavior objects.
ovals	Ovals Oval	readonly	A collection of ellipses.
overprintFill	Boolean	read/write	If true, the Button's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
overprintGap	Boolean	read/write	If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
overprintStroke	Boolean	read/write	If true, the Button's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
overridden	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.
overriddenMasterPageItem	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	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.
parent	Cell Character Group Line MasterSpread Paragraph Story Table Text TextColumn TextFrame TextStyleRange Word Page Spread	readonly	The parent of the Button (a Spread, MasterSpread, Group, TextFrame, Story, Text, Character, Word, Line, TextColumn, Paragraph, TextStyleRange, Cell, Table or Page).
pdfs	PDFs PDF	readonly	A collection of PDF files.
picts	PICTs PICT	readonly	A collection of PICT graphics.
polygons	Polygons Polygon	readonly	A collection of polygons.
properties	Object	read/write	A property that allows setting of several properties at the same time.
quitBehaviors	QuitBehaviors QuitBehavior	readonly	A collection of quit behavior objects.
rectangles	Rectangles Rectangle	readonly	A collection of rectangles.
rightLineEnd	ArrowHead ArrowHead.BARBED_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD	read/write	The arrowhead applied to the end of the path.
rotationAngle	Number	read/write	The rotatation angle of the Button. (Range: -360 to 360)
shearAngle	Number	read/write	The skewing angle applied to the Button. (Range: -360 to 360)
showHideFieldsBehaviors	ShowHideFieldsBehaviors ShowHideFieldsBehavior	readonly	A collection of show/hide fields behavior objects.
soundBehaviors	SoundBehaviors SoundBehavior	readonly	A collection of sound behavior objects.
states	States State	readonly	A collection of states.
strokeAlignment	StrokeAlignment StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT	read/write	The stroke alignment applied to the Button.
strokeColor	Swatch String	read/write	The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Button. Can also accept: String.
strokeCornerAdjustment	StrokeCornerAdjustment StrokeCornerAdjustment.DASHES StrokeCornerAdjustment.DASHES_AND_GAPS StrokeCornerAdjustment.GAPS StrokeCornerAdjustment.NONE	read/write	The corner adjustment applied to the Button.
strokeDashAndGap	Array of Number Array of String	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].
strokeTint	Number (range 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.)
strokeTransparencySettings	StrokeTransparencySetting	readonly	Transparency settings for the stroke.
strokeType	StrokeStyle String	read/write	The name of the stroke style to apply. Can also accept: String.
strokeWeight	Number String	read/write	The weight (in points) to apply to the Button's stroke.
textFrames	TextFrames TextFrame	readonly	A collection of text frames.
textWrapPreferences	TextWrapPreference	readonly	The text wrap preference properties that define the default formatting for wrapping text around objects.
transparencySettings	TransparencySetting	readonly	Transparency settings.
verticalScale	Number	read/write	The vertical scaling applied to the Button.
viewZoomBehaviors	ViewZoomBehaviors ViewZoomBehavior	readonly	A collection of view zoom behavior objects.
visibilityInPdf	VisibilityInPdf VisibilityInPdf.HIDDEN_BUT_PRINTABLE_IN_PDF VisibilityInPdf.HIDDEN_IN_PDF VisibilityInPdf.VISIBLE_BUT_DOES_NOT_PRINT_IN_PDF VisibilityInPdf.VISIBLE_IN_PDF	read/write	The field's visibility in the PDF document.
visibleBounds	Array of Number Array of String	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	WMFs WMF	readonly	A collection of WMF graphics.

Method Listing

PageItem addPath (with:Array of PageItem)

Creates a new page item by combining the Button with other objects. Deletes the objects if they do not intersect.

Parameter	Type	Description
with	Array of PageItem	The object(s) to add.

undefined applyObjectStyle (using:ObjectStyle, [clearingOverrides:Boolean=Boolean], [clearingOverridesThroughRootObjectStyle:Boolean=Boolean])

Applies the specified object style.

Parameter	Type	Description
using	ObjectStyle	The object style to apply.
clearingOverrides	Boolean	If true, clears the Button's existing attributes before applying the style. (Optional) (default: true)
clearingOverridesThroughRootObjectStyle	Boolean	If true, clears attributes and formatting applied to the Button that are not defined in the object style. (Optional) (default: false)

Parameter

Type

Description

using

ObjectStyle

The object style to apply.

clearingOverrides

Boolean

If true, clears the Button's existing attributes before applying the style. (Optional)

(default: true)

clearingOverridesThroughRootObjectStyle

Boolean

If true, clears attributes and formatting applied to the Button that are not defined in the object style. (Optional)

(default: false)

undefined autoTag ()

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

undefined bringForward ()

Brings the Button forward one level in its layer.

undefined bringToFront (reference:PageItem)

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

Parameter	Type	Description
reference	PageItem	The reference object to bring the object in front of (must have same parent) (Optional)

PageItem changeObject (reverseOrder:Boolean)

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

Parameter	Type	Description
reverseOrder	Boolean	If true, returns the results in reverse order. (Optional)

Boolean checkIn (versionComments:String, [forceSave:Boolean=Boolean])

Checks in the story or stories.

Parameter	Type	Description
versionComments	String	The comment for this version. (Optional)
forceSave	Boolean	If true, forcibly saves a version. (Optional) (default: false)

Parameter

Type

Description

versionComments

String

The comment for this version. (Optional)

forceSave

Boolean

If true, forcibly saves a version. (Optional)

(default: false)

Boolean checkOut ()

Checks out the story.

undefined clearObjectStyleOverrides ()

Clear overrides for object style

undefined clearTransformations ()

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

undefined convertShape (given:ConvertShapeOptions, numberOfSides:Number, insetPercentage:Number, cornerRadius:Number String)

Converts the Button to a different shape.

Parameter	Type	Description
given	ConvertShapeOptions ConvertShapeOptions.CONVERT_TO_BEVELED_RECTANGLE ConvertShapeOptions.CONVERT_TO_CLOSED_PATH ConvertShapeOptions.CONVERT_TO_INVERSE_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_LINE ConvertShapeOptions.CONVERT_TO_OPEN_PATH ConvertShapeOptions.CONVERT_TO_OVAL ConvertShapeOptions.CONVERT_TO_POLYGON ConvertShapeOptions.CONVERT_TO_RECTANGLE ConvertShapeOptions.CONVERT_TO_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_STRAIGHT_LINE ConvertShapeOptions.CONVERT_TO_TRIANGLE	The Button's new shape.
numberOfSides	Number (range 3 - 100)	The number of sides for the resulting polygon. (Range: 3 to 100) (Optional)
insetPercentage	Number (range 0 - 100)	The star inset percentage for the resulting polygon. (Range: 0.0 to 100.0) (Optional)
cornerRadius	Number String	The corner radius of the resulting rectangle. (Optional)

undefined convertToObject ()

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

undefined detach ()

Detaches an overridden master page item from the master page.

PageItem duplicate (to:Array of Varies 2 Units Page Spread Layer, by:Array of Number String)

Duplicates the Button at the specified location or offset.

Parameter	Type	Description
to	Array of 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. (Optional)
by	Array of Number Array of String	Amount by which to offset the new Button from the original Button's position. (Optional)

Parameter

Type

Description

Array of 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. (Optional)

Array of Number

Array of String

Amount by which to offset the new Button from the original Button's position. (Optional)

PageItem excludeOverlapPath (with:Array of PageItem)

Creates a new page item by excluding the overlapping areas of the Button and other objects.

Parameter	Type	Description
with	Array of PageItem	The object(s) to exclude.

undefined exportFile (format:Varies ExportFormat String, to:File, [showingOptions:Boolean=Boolean], using:PDFExportPreset, versionComments:String, [forceSave:Boolean=Boolean])

Exports the object(s) to a file.

Parameter	Type	Description
format	ExportFormat ExportFormat.EPS_TYPE ExportFormat.INCOPY_DOCUMENT ExportFormat.INCOPY_MARKUP ExportFormat.INDESIGN_INTERCHANGE ExportFormat.INDESIGN_MARKUP ExportFormat.INDESIGN_SNIPPET ExportFormat.JPG ExportFormat.PDF_TYPE ExportFormat.PNG_FORMAT ExportFormat.RTF ExportFormat.TAGGED_TEXT ExportFormat.TEXT_TYPE ExportFormat.XML 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.
showingOptions	Boolean	If true, displays the export options dialog. (Optional) (default: false)
using	PDFExportPreset	The export style. (Optional)
versionComments	String	The comment for this version. (Optional)
forceSave	Boolean	If true, forcibly saves a version. (Optional) (default: false)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

PageItem findObject (reverseOrder:Boolean)

Finds objects that match the find what value.

Parameter	Type	Description
reverseOrder	Boolean	If true, returns the results in reverse order. (Optional)

undefined fit (given:FitOptions)

Applies the specified fit option to content in a frame.

Parameter	Type	Description
given	FitOptions FitOptions.APPLY_FRAME_FITTING_OPTIONS FitOptions.CENTER_CONTENT FitOptions.CONTENT_TO_FRAME FitOptions.FILL_PROPORTIONALLY FitOptions.FRAME_TO_CONTENT FitOptions.PROPORTIONALLY	The fit option to use.

Parameter

Type

Description

given

FitOptions

FitOptions.APPLY_FRAME_FITTING_OPTIONS

FitOptions.CENTER_CONTENT

FitOptions.CONTENT_TO_FRAME

FitOptions.FILL_PROPORTIONALLY

FitOptions.FRAME_TO_CONTENT

FitOptions.PROPORTIONALLY

The fit option to use.

undefined flipItem (given:Flip, around:Array of Varies 2 Units AnchorPoint)

Flips the Button.

Parameter	Type	Description
given	Flip Flip.BOTH Flip.HORIZONTAL Flip.HORIZONTAL_AND_VERTICAL Flip.NONE Flip.VERTICAL	The axis around which to flip the Button.
around	Array of 2 Units AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR	The point around which to flip the Button. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

Parameter

Type

Description

given

Flip

Flip.BOTH

Flip.HORIZONTAL

Flip.HORIZONTAL_AND_VERTICAL

Flip.NONE

Flip.VERTICAL

The axis around which to flip the Button.

around

Array of 2 Units

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

The point around which to flip the Button. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

Button getElements ()

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

undefined insertLabel (key:String, value:String)

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

Parameter	Type	Description
key	String	The key.
value	String	The value.

PageItem intersectPath (with:Array of PageItem)

Creates a new page item by intersecting the Button with other objects. Returns an error if the objects do not intersect.

Parameter	Type	Description
with	Array of PageItem	The object(s) with which to intersect.

PageItem makeCompoundPath (with:Array of PageItem)

Creates a compound path by combining the path(s) of the Button with the paths of other objects.

Parameter	Type	Description
with	Array of PageItem	The other objects whose paths to include in the new compound path.

undefined markup (using:XMLElement)

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

Parameter	Type	Description
using	XMLElement	The XML element.

PageItem minusBack (with:Array of PageItem)

Creates a new page item by reverse subtracting the overlapping areas of the Button and other objects.

Parameter	Type	Description
with	Array of PageItem	The object(s) to reverse subtract.

undefined move (to:Array of Varies 2 Units Page Spread Layer, by:Array of Number String)

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.

Parameter	Type	Description
to	Array of 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. (Optional)
by	Array of Number Array of String	The amount (in measurement units) to move the Button relative to its current position, in the format (x, y). (Optional)

Parameter

Type

Description

Array of 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. (Optional)

Array of Number

Array of String

The amount (in measurement units) to move the Button relative to its current position, in the format (x, y). (Optional)

Varies override (destinationPage:Page)

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

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

Varies place (fileName:File, [showingOptions:Boolean=Boolean], withProperties:Object)

Places the file.

Parameter	Type	Description
fileName	File	The file to place
showingOptions	Boolean	Whether to display the import options dialog (Optional) (default: false)
withProperties	Object	Initial values for properties of the placed object(s) (Optional)

Parameter

Type

Description

fileName

File

The file to place

showingOptions

Boolean

Whether to display the import options dialog (Optional)

(default: false)

withProperties

Object

Initial values for properties of the placed object(s) (Optional)

undefined placeXML (using:XMLElement)

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

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

undefined redefineScaling (to:Array of Number)

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

Parameter	Type	Description
to	Array of Number	The scale factors to be left on the item. The default is {1.0, 1.0}. (Optional)

undefined reframe (in:Varies CoordinateSpaces BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces, opposingCorners:Array of Varies)

Move the bounding box of the page item

Parameter	Type	Description
in	CoordinateSpaces CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.SPREAD_COORDINATES BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces	The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
opposingCorners	Array of Varies	Opposing corners of new bounding box in the given coordinate space

Parameter

Type

Description

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

BoundsKind:BoundingBoxLimits

OrderedarraycontainingcoordinateSpace:CoordinateSpaces

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

opposingCorners

Array of Varies

Opposing corners of new bounding box in the given coordinate space

PageItem releaseCompoundPath ()

Releases a compound path.

undefined remove ()

Deletes the Button.

undefined removeOverride ()

Removes the override from a previously overridden master page item.

undefined resize (in:Varies BoundingBoxLimits CoordinateSpaces BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces, from:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, by:ResizeMethods, values:Array of Varies Reals ResizeConstraintss CoordinateSpacess, [resizeIndividually:Boolean=Boolean], [consideringRulerUnits:Boolean=Boolean])

Resize the page item.

Parameter	Type	Description
in	BoundingBoxLimits BoundingBoxLimits.GEOMETRIC_PATH_BOUNDS BoundingBoxLimits.OUTER_STROKE_BOUNDS CoordinateSpaces CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.SPREAD_COORDINATES BoundsKind:BoundingBoxLimits OrderedarraycontainingcoordinateSpace:CoordinateSpaces	The bounding box to resize. Can accept: CoordinateSpaces enumerator, BoundingBoxLimits enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator.
from	AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR AnchorPoints AnchorPoint Array of 2 Reals BoundingBoxLimitss BoundingBoxLimits CoordinateSpacess CoordinateSpaces Array of 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 ResizeMethods.ADDING_CURRENT_DIMENSIONS_TO ResizeMethods.MULTIPLYING_CURRENT_DIMENSIONS_BY ResizeMethods.REPLACING_CURRENT_DIMENSIONS_WITH	How the current dimensions are affected by the given values
values	Array of Reals Array of ResizeConstraintss ResizeConstraints Array of CoordinateSpacess CoordinateSpaces	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. (Optional) (default: true)
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. (Optional) (default: false)

Varies resolve (location:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, in:CoordinateSpaces, [consideringRulerUnits:Boolean=Boolean])

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

Parameter	Type	Description
location	AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR AnchorPoints AnchorPoint Array of 2 Reals BoundingBoxLimitss BoundingBoxLimits CoordinateSpacess CoordinateSpaces Array of 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 CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use.
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. (Optional) (default: false)

Parameter

Type

Description

location

AnchorPoint

AnchorPoint.BOTTOM_CENTER_ANCHOR

AnchorPoint.BOTTOM_LEFT_ANCHOR

AnchorPoint.BOTTOM_RIGHT_ANCHOR

AnchorPoint.CENTER_ANCHOR

AnchorPoint.LEFT_CENTER_ANCHOR

AnchorPoint.RIGHT_CENTER_ANCHOR

AnchorPoint.TOP_CENTER_ANCHOR

AnchorPoint.TOP_LEFT_ANCHOR

AnchorPoint.TOP_RIGHT_ANCHOR

AnchorPoints AnchorPoint

Array of 2 Reals

BoundingBoxLimitss BoundingBoxLimits

CoordinateSpacess CoordinateSpaces

Array of 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.

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use.

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. (Optional)

(default: false)

Boolean revert ()

Reverts the document to its state at the last save operation.

undefined select ([existingSelection:SelectionOptions=SelectionOptions])

Selects the object.

Parameter	Type	Description
existingSelection	SelectionOptions SelectionOptions.ADD_TO SelectionOptions.REMOVE_FROM SelectionOptions.REPLACE_WITH	The selection status of the Button in relation to previously selected objects. (Optional) (default: SelectionOptions.REPLACE_WITH)

Parameter

Type

Description

existingSelection

SelectionOptions

SelectionOptions.ADD_TO

SelectionOptions.REMOVE_FROM

SelectionOptions.REPLACE_WITH

The selection status of the Button in relation to previously selected objects. (Optional)

(default: SelectionOptions.REPLACE_WITH)

undefined sendBackward ()

Sends the Button back one level in its layer.

undefined sendToBack (reference:PageItem)

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

Parameter	Type	Description
reference	PageItem	The reference object to send the object behind (Optional)

Asset store (using:Library, withProperties:Object)

Stores the object in the specified library.

Parameter	Type	Description
using	Library	The library in which to store the object.
withProperties	Object	Initial values for properties of the new Button (Optional)

PageItem subtractPath (with:Array of PageItem)

Creates a new page item by subtracting the overlapping areas of the Button and other objects.

Parameter	Type	Description
with	Array of PageItem	The object(s) to subtract.

String toSource ()

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

String toSpecifier ()

Retrieves the object specifier.

undefined transform (in:CoordinateSpaces, from:Array of Varies AnchorPoint AnchorPoints 2 Reals BoundingBoxLimitss CoordinateSpacess Arrays of 2 Reals LongIntegers, withMatrix:Array of Varies 6 Reals TransformationMatrix, replacingCurrent:Array of Varies MatrixContent enumerators MatrixContent LongInteger, [consideringRulerUnits:Boolean=Boolean])

Transform the page item.

Parameter	Type	Description
in	CoordinateSpaces CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.SPREAD_COORDINATES	The coordinate space to use
from	AnchorPoint AnchorPoint.BOTTOM_CENTER_ANCHOR AnchorPoint.BOTTOM_LEFT_ANCHOR AnchorPoint.BOTTOM_RIGHT_ANCHOR AnchorPoint.CENTER_ANCHOR AnchorPoint.LEFT_CENTER_ANCHOR AnchorPoint.RIGHT_CENTER_ANCHOR AnchorPoint.TOP_CENTER_ANCHOR AnchorPoint.TOP_LEFT_ANCHOR AnchorPoint.TOP_RIGHT_ANCHOR AnchorPoints AnchorPoint Array of 2 Reals BoundingBoxLimitss BoundingBoxLimits CoordinateSpacess CoordinateSpaces Array of 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	Array of 6 Reals TransformationMatrix	Transform matrix. Can accept: Array of 6 Reals or TransformationMatrix.
replacingCurrent	Array of MatrixContent enumerators MatrixContent MatrixContent.ROTATION_VALUE MatrixContent.SCALE_VALUES MatrixContent.SHEAR_VALUE MatrixContent.TRANSLATION_VALUES 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. (Optional)
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. (Optional) (default: false)

String transformAgain ()

Transforms the Button using the last transformation performed on any object. Transformations include moving, rotating, shearing, scaling, and flipping.

String transformAgainIndividually ()

Transforms the Button using the last transformation performed on any Button. Transformations include moving, rotating, shearing, scaling, and flipping.

String transformSequenceAgain ()

Transforms the Button using the last sequence of transform operations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

String transformSequenceAgainIndividually ()

Transforms the Button using the last sequence of transformations performed on any single object or performed at the same time on any group of objects. Transformations include moving, rotating, shearing, scaling, and flipping.

TransformationMatrix transformValuesOf (in:CoordinateSpaces)

Get the transformation values of the page item.

Parameter

Type

Description

CoordinateSpaces

CoordinateSpaces.INNER_COORDINATES

CoordinateSpaces.PARENT_COORDINATES

CoordinateSpaces.PASTEBOARD_COORDINATES

CoordinateSpaces.SPREAD_COORDINATES

The coordinate space to use