Button

A button.

Go to Property Listing | Method Listing

Objects:

AnchoredObjectSetting, ArrowHead, Behaviors, BlendMode, Boolean, CloseWindowBehaviors, CornerEffects, DisplaySettingOptions, EPSs, EndCap, EndJoin, FeatherCornerType, FeatherMode, GotoAnchorBehaviors, GotoFirstPageBehaviors, GotoLastPageBehaviors, GotoNextPageBehaviors, GotoNextViewBehaviors, 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, ShadowMode, ShowHideFieldsBehaviors, Sound, SoundBehaviors, States, String, StrokeAlignment, StrokeCornerAdjustment, StrokeStyle, Swatch, TextFrames, TextWrapPreference, ViewZoomBehaviors, VisibilityInPdf, WMFs, XMLItem

Preferences:

TextWrapPreference

Hierarchy:

Superclass: FormField

Class: Button

Property Listing

Property	Type	Access	Description
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.
anchoredObjectSettings	AnchoredObjectSetting	readonly	Anchored object settings.
appearanceName	String	readonly	The appearance applied to the button.
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.
blendMode	BlendMode BlendMode.COLOR BlendMode.COLOR_BURN BlendMode.COLOR_DODGE BlendMode.DARKEN BlendMode.DIFFERENCE BlendMode.EXCLUSION BlendMode.HARD_LIGHT BlendMode.HUE BlendMode.LIGHTEN BlendMode.LUMINOSITY BlendMode.MULTIPLY BlendMode.NORMAL BlendMode.OVERLAY BlendMode.SATURATION BlendMode.SCREEN BlendMode.SOFT_LIGHT	read/write	The blend mode used to combine the background with the color of the Button.
closeWindowBehaviors	CloseWindowBehaviors CloseWindowBehavior	readonly	A collection of close window behavior objects.
cornerEffect	CornerEffects CornerEffects.BEVEL_CORNER CornerEffects.FANCY_CORNER CornerEffects.INSET_CORNER CornerEffects.INVERSE_ROUNDED_CORNER CornerEffects.NONE CornerEffects.ROUNDED_CORNER	read/write	The shape to apply to corner points in a path. Note: corner effect differs from end join in that you can set a radius for a corner effect, whereas the rounded or beveled effect of an end join depends upon the stroke weight.
cornerRadius	Number	read/write	The radius of the corner
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.
featherCornerType	FeatherCornerType FeatherCornerType.DIFFUSION FeatherCornerType.ROUNDED FeatherCornerType.SHARP	read/write	The type of feathering.
featherMode	FeatherMode FeatherMode.NONE FeatherMode.STANDARD	read/write	The feather-enabling mode.
featherNoise	Number (range 0 - 100)	read/write	The amount (as a percentage) of noise to apply to the feather. (Range: 0 to 100)
featherWidth	Number String	read/write	The width of the feathering.
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.)
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.
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.
isolateBlending	Boolean	read/write	If true, the Button blends in isolation.
itemLayer	Layer	read/write	The layer that the Button is on.
knockoutGroup	Boolean	read/write	If true, the Button is a knockout group.
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. (Range: 1 to 500)
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.
opacity	Number (range 0 - 100)	read/write	The opacity of the Button. (Range: 0 to 100)
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 Document Group InsertionPoint Layer 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, Document, Layer, InsertionPoint 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)
shadowBlendMode	BlendMode BlendMode.COLOR BlendMode.COLOR_BURN BlendMode.COLOR_DODGE BlendMode.DARKEN BlendMode.DIFFERENCE BlendMode.EXCLUSION BlendMode.HARD_LIGHT BlendMode.HUE BlendMode.LIGHTEN BlendMode.LUMINOSITY BlendMode.MULTIPLY BlendMode.NORMAL BlendMode.OVERLAY BlendMode.SATURATION BlendMode.SCREEN BlendMode.SOFT_LIGHT	read/write	The blend mode to use for drawing the shadow.
shadowBlurRadius	Number String	read/write	The radius of the shadow blur.
shadowColor	Swatch	read/write	The swatch (color or mixed ink) applied to the shadow.
shadowMode	ShadowMode ShadowMode.DROP ShadowMode.NONE	read/write	The shadow mode.
shadowNoise	Number (range 0 - 100)	read/write	The amount (as a percentage) of noise to apply to the shadow. (Range: 0 to 100)
shadowOpacity	Number (range 0 - 100)	read/write	The opacity of the shadow. (Range: 0 to 100)
shadowSpread	Number (range 0 - 100)	read/write	The amount (as a percentage) of the blur radius to use as the shadow footprint. (Range: 0 to 100) For information, see shadow blur radius.
shadowXOffset	Number String	read/write	The horizontal offset of the shadow.
shadowYOffset	Number String	read/write	The vertical offset of the shadow.
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.)
strokeType	StrokeStyle	read/write	The stroke type
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.
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 applyAppearance (using:String)

Applies the specified appearance.

Parameter	Type	Description
using	String	The appearance to apply.

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 bringForward ()

Brings the Button forward one level in its layer.

undefined bringToFront ()

Brings the Button to the front.

Boolean checkIn ()

Checks in the story.

Boolean checkOut ()

Checks out the story.

undefined detach ()

Detaches an overridden master page item from the master page.

PageItem duplicate (by:Array of Number String)

Duplicates the Button.

Parameter	Type	Description
by	Array of Number Array of String	The amount (in points) to offset the new Button, in the format [x, y]. (Optional)

Parameter

Type

Description

Array of Number

Array of String

The amount (in points) to offset the new Button, in the format [x, y]. (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)

Exports the object(s) to a file.

Parameter	Type	Description
format	ExportFormat ExportFormat.EPS_TYPE ExportFormat.INCOPY ExportFormat.INCOPY_CS2_STORY ExportFormat.INDESIGN_INTERCHANGE ExportFormat.INDESIGN_SNIPPET ExportFormat.JPG ExportFormat.PDF_TYPE ExportFormat.RTF ExportFormat.SVG ExportFormat.SVG_COMPRESSED ExportFormat.TAGGED_TEXT ExportFormat.TEXT_TYPE ExportFormat.XML String	The export format. Can accept: ExportFormat enumerator or String.
to	File	The path of the export file.
showingOptions	Boolean	If true, prompts the user to select export options. (Optional) (default: false)
using	PDFExportPreset	The export style to use. (Optional)

String extractLabel (key:String)

Gets the label value associated with the specified key.

Parameter	Type	Description
key	String	The key.

undefined fit (given:FitOptions)

Applies the specified fit option to content in a frame.

Parameter	Type	Description
given	FitOptions 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.CENTER_CONTENT

FitOptions.CONTENT_TO_FRAME

FitOptions.FILL_PROPORTIONALLY

FitOptions.FRAME_TO_CONTENT

FitOptions.PROPORTIONALLY

The fit option to use.

undefined flipItem (given:FlipItemOptions, around:Array of Varies 2 Units AnchorPoint, [transformingContent:Boolean=Boolean])

Flip item about given axis

Parameter	Type	Description
given	FlipItemOptions FlipItemOptions.BOTH FlipItemOptions.HORIZONTAL FlipItemOptions.VERTICAL	flip item options
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 to flip around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
transformingContent	Boolean	If true then both the object and items within it are flipped (Optional) (default: true)

Parameter

Type

Description

given

FlipItemOptions

FlipItemOptions.BOTH

FlipItemOptions.HORIZONTAL

FlipItemOptions.VERTICAL

flip item options

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 to flip around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)

transformingContent

Boolean

If true then both the object and items within it are flipped (Optional)

(default: true)

Object 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, [transformingContent:Boolean=Boolean])

Move Page Item to a new location. One of the 'To' or 'By' parameters is required.

Parameter	Type	Description
to	Array of 2 Units Page Spread Layer	The new location of the object. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)
by	Array of Number Array of String	Amount by which to move the object relative to its current position (Optional)
transformingContent	Boolean	If true then both the object and items within it are moved (Optional) (default: true)

Parameter

Type

Description

Array of 2 Units

Page

Spread

Layer

The new location of the object. Can accept: Array of 2 Units, Spread, Page or Layer. (Optional)

Array of Number

Array of String

Amount by which to move the object relative to its current position (Optional)

transformingContent

Boolean

If true then both the object and items within it are moved (Optional)

(default: true)

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)

Place a 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.

PageItem releaseCompoundPath ()

Releases a compound path.

undefined remove ()

Deletes the Button.

undefined removeOverride ()

Removes the override from a previously overridden master page item.

undefined resetScaling ()

Resets the Button's scaling to 100%. Note: This does not change the size of the Button. Instead, it makes the current size of the Button the basis for future scaling.

undefined resize (horizontalScale:Number, verticalScale:Number, around:Array of Varies 2 Units AnchorPoint, [consideringCurrentScale:Boolean=Boolean], [transformingContent:Boolean=Boolean], [consideringParentsScale:Boolean=Boolean])

Resize the page item. You must specify either horizontal scale or vertical scale or both.

Parameter	Type	Description
horizontalScale	Number	The percentage of horizontal scale (Optional)
verticalScale	Number	The percentage of vertical scale (Optional)
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 to scale around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentScale	Boolean	If true then the object's current scale and new scale will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false)
transformingContent	Boolean	If true then both the object and items within it are scaled (Optional) (default: true)
consideringParentsScale	Boolean	If true then the object is scaled relative to its parent page item. If false it is scaled relative to the spread. (Optional) (default: false)

Boolean revert ()

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

undefined rotate (by:Number, around:Array of Varies 2 Units AnchorPoint, [consideringCurrentRotation:Boolean=Boolean], [transformingContent:Boolean=Boolean], [consideringParentsRotation:Boolean=Boolean])

Rotate the page item

Parameter	Type	Description
by	Number	Angle by which to rotate the page item
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 to rotate around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
consideringCurrentRotation	Boolean	If true then the object's current rotation and new rotation will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false)
transformingContent	Boolean	If true then both the object and items within it are rotated (Optional) (default: true)
consideringParentsRotation	Boolean	If true then the object is rotated relative to its parent page item. If false it is rotated relative to the spread. Cannot rotate with considering current rotation and considering parents rotation both set at the same time. (Optional) (default: false)

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

Sends the Button to the back.

undefined shear (by:Number, around:Array of Varies 2 Units AnchorPoint, [shearAxisAngle:Number=Number], [consideringCurrentShear:Boolean=Boolean], [transformingContent:Boolean=Boolean], [consideringParentsShear:Boolean=Boolean])

Shear the page item

Parameter	Type	Description
by	Number	Angle by which to shear the object
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 to shear around. Can accept: Array of 2 Units or AnchorPoint enumerator. (Optional)
shearAxisAngle	Number	The amount that the shear axis is rotated. If 0 degree then shear at its horizontal axis. If 90 degrees then shear at the vertical axis. (Optional) (default: 0)
consideringCurrentShear	Boolean	If true then the object's current shear and new shear will be combined. If false then the new value is absolute. The default value is false. (Optional) (default: false)
transformingContent	Boolean	If true then both the object and items within it are sheared (Optional) (default: true)
consideringParentsShear	Boolean	If true then the object is sheared relative to its parent page item. If false it is sheared relative to the spread. Cannot shear with considering current shear and considering parents shear both set at the same time. (Optional) (default: false)

Asset store (using:Library)

Store a page item in a library

Parameter	Type	Description
using	Library	The library in which to store

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.

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.