Property | Type | Access | Description |
absoluteFlip | Flip: Flip.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH |
r/w | 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 |
r/w | The horizontal scale of the Button relative to its containing object. |
absoluteRotationAngle | number |
r/w | The rotation angle of the Button relative to its containing object. (Range: -360 to 360) |
absoluteShearAngle | number |
r/w | The skewing angle of the Button relative to its containing object. (Range: -360 to 360) |
absoluteVerticalScale | number |
r/w | The vertical scale of the Button relative to its containing object. |
activeStateIndex | number |
r/w | The index of the active state in the object's states collection. |
allArticles | Array of Article |
readonly | The list of all articles this page item is part of |
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 | bool |
r/w | If true, the master page item can be overridden. |
anchoredObjectSettings | AnchoredObjectSetting |
readonly | Anchored object settings. |
animationBehaviors | AnimationBehaviors AnimationBehavior |
readonly | A collection of animation behaviors. |
animationSettings | AnimationSetting |
readonly | The page item animation settings. |
appliedObjectStyle | ObjectStyle |
r/w | 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. |
bottomLeftCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The shape to apply to the bottom left corner of rectangular shapes. |
bottomLeftCornerRadius | Measurement Unit (Number or String) |
r/w | The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes |
bottomRightCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The shape to apply to the bottom right corner of rectangular shapes. |
bottomRightCornerRadius | Measurement Unit (Number or String) |
r/w | The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes |
clearFormBehaviors | ClearFormBehaviors ClearFormBehavior |
readonly | A collection of clear form behavior objects. |
contentTransparencySettings | ContentTransparencySetting |
readonly | Transparency settings for the content of the Button. |
description | string |
r/w | The description of the Button. |
endCap | EndCap: EndCap.BUTT_END_CAP EndCap.ROUND_END_CAP EndCap.PROJECTING_END_CAP |
r/w | The end shape of an open path. |
endJoin | EndJoin: EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN EndJoin.BEVEL_END_JOIN |
r/w | The corner join applied to the Button. |
epss | EPSs EPS |
readonly | A collection of EPS files. |
epstexts | EPSTexts EPSText |
readonly | EPSTexts |
eventListeners | EventListeners EventListener |
readonly | A collection of event listeners. |
events | Events Event |
readonly | A collection of events. |
fillColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Button. . Can also accept: String. |
fillTint | number |
r/w | 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.NONE Flip.HORIZONTAL Flip.VERTICAL Flip.HORIZONTAL_AND_VERTICAL Flip.BOTH |
r/w | The direction in which to flip the printed image. |
gapColor | Swatch |
r/w | 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 |
r/w | 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 Measurement Unit (Number or String) |
r/w | 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. |
gotoNextStateBehaviors | GotoNextStateBehaviors GotoNextStateBehavior |
readonly | A collection of goto next state behaviors. |
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. |
gotoPreviousStateBehaviors | GotoPreviousStateBehaviors GotoPreviousStateBehavior |
readonly | A collection of goto previous state behaviors. |
gotoPreviousViewBehaviors | GotoPreviousViewBehaviors GotoPreviousViewBehavior |
readonly | A collection of goto previous view behavior objects. |
gotoStateBehaviors | GotoStateBehaviors GotoStateBehavior |
readonly | A collection of goto state behaviors. |
gotoURLBehaviors | GotoURLBehaviors GotoURLBehavior |
readonly | A collection of goto URL behavior objects. |
gradientFillAngle | number |
r/w | The angle of a linear gradient applied to the fill of the Button. (Range: -180 to 180) |
gradientFillLength | Measurement Unit (Number or String) |
r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the fill of the Button. |
gradientFillStart | Array of Measurement Unit (Number or String) |
r/w | The starting point (in page coordinates) of a gradient applied to the fill of the Button, in the format [x, y]. |
gradientStrokeAngle | number |
r/w | The angle of a linear gradient applied to the stroke of the Button. (Range: -180 to 180) |
gradientStrokeLength | Measurement Unit (Number or String) |
r/w | The length (for a linear gradient) or radius (for a radial gradient) applied to the stroke of the Button. |
gradientStrokeStart | Array of Measurement Unit (Number or String) |
r/w | 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. |
hiddenUntilTriggered | bool |
r/w | If true, the form field/push button is hidden until triggered in the exported PDF. |
horizontalLayoutConstraints | Array of DimensionsConstraints: DimensionsConstraints.FIXED_DIMENSION DimensionsConstraints.FLEXIBLE_DIMENSION |
r/w | The left margin, width, and right margin constraints this item is subject to when using the object-based layout rule. |
horizontalScale | number |
r/w | 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 | bool |
readonly | Returns true if the object specifier resolves to valid objects. |
itemLayer | Layer |
r/w | The layer that the Button is on. |
label | string |
r/w | A property that can be set to any string. |
leftLineEnd | ArrowHead: ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD |
r/w | The arrowhead applied to the start of the path. |
linkedPageItemOptions | LinkedPageItemOption |
readonly | Linked Page Item options |
locked | bool |
r/w | If true, the Button is locked. |
miterLimit | number (range: 1 - 500) |
r/w | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. (default: 4) |
movieBehaviors | MovieBehaviors MovieBehavior |
readonly | A collection of movie behavior objects. |
name | string |
r/w | The name of the Button. |
nonprinting | bool |
r/w | 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 | bool |
r/w | If true, the Button's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. |
overprintGap | bool |
r/w | If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. |
overprintStroke | bool |
r/w | If true, the Button's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. |
overridden | bool |
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 | Character GraphicLine Group MasterSpread Oval PlaceGun Polygon Rectangle Snippet SplineItem Spread |
readonly | The parent of the Button (a PlaceGun, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group, Character or Snippet). |
parentPage | Page |
readonly | The page on which this page item appears. |
paths | Paths Path |
readonly | A collection of paths. |
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. |
preferences | Preferences Preference |
readonly | A collection of preferences objects. |
printFormBehaviors | PrintFormBehaviors PrintFormBehavior |
readonly | A collection of print form behavior objects. |
printableInPdf | bool |
r/w | If true, the form field/push button is printable in the exported PDF. |
properties | Object |
r/w | A property that allows setting of several properties at the same time. |
rectangles | Rectangles Rectangle |
readonly | A collection of rectangles. |
rightLineEnd | ArrowHead: ArrowHead.NONE ArrowHead.SIMPLE_ARROW_HEAD ArrowHead.SIMPLE_WIDE_ARROW_HEAD ArrowHead.TRIANGLE_ARROW_HEAD ArrowHead.TRIANGLE_WIDE_ARROW_HEAD ArrowHead.BARBED_ARROW_HEAD ArrowHead.CURVED_ARROW_HEAD ArrowHead.CIRCLE_ARROW_HEAD ArrowHead.CIRCLE_SOLID_ARROW_HEAD ArrowHead.SQUARE_ARROW_HEAD ArrowHead.SQUARE_SOLID_ARROW_HEAD ArrowHead.BAR_ARROW_HEAD |
r/w | The arrowhead applied to the end of the path. |
rotationAngle | number |
r/w | The rotatation angle of the Button. (Range: -360 to 360) |
shearAngle | number |
r/w | 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. |
splineItems | SplineItems SplineItem |
readonly | The spline items collection. |
states | States State |
readonly | A collection of states. |
strokeAlignment | StrokeAlignment: StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT |
r/w | The stroke alignment applied to the Button. |
strokeColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the Button. Can also accept: String. |
strokeCornerAdjustment | StrokeCornerAdjustment: StrokeCornerAdjustment.NONE StrokeCornerAdjustment.DASHES StrokeCornerAdjustment.GAPS StrokeCornerAdjustment.DASHES_AND_GAPS |
r/w | The corner adjustment applied to the Button. |
strokeDashAndGap | Array of Measurement Unit (Number or String) |
r/w | 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 |
r/w | 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 | String StrokeStyle |
r/w | The name of the stroke style to apply. Can also accept: String. |
strokeWeight | Measurement Unit (Number or String) |
r/w | The weight (in points) to apply to the Button's stroke. |
submitFormBehaviors | SubmitFormBehaviors SubmitFormBehavior |
readonly | A collection of submit form behavior objects. |
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. |
timingSettings | TimingSetting |
readonly | The object timing settings. |
topLeftCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | 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. |
topLeftCornerRadius | Measurement Unit (Number or String) |
r/w | 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 |
topRightCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
r/w | The shape to apply to the top right corner of rectangular shapes |
topRightCornerRadius | Measurement Unit (Number or String) |
r/w | The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes |
transparencySettings | TransparencySetting |
readonly | Transparency settings. |
verticalLayoutConstraints | Array of DimensionsConstraints: DimensionsConstraints.FIXED_DIMENSION DimensionsConstraints.FLEXIBLE_DIMENSION |
r/w | The top margin, height, and bottom margin constraints this item is subject to when using the object-based layout rule. |
verticalScale | number |
r/w | The vertical scaling applied to the Button. |
viewZoomBehaviors | ViewZoomBehaviors ViewZoomBehavior |
readonly | A collection of view zoom behavior objects. |
visible | bool |
r/w | If true, the Button is visible. |
visibleBounds | Array of Measurement Unit (Number or String) |
r/w | 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. |