Button
QuickLinks
Hierarchy
Properties
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 | readonly | The horizontal scale of the Button relative to its containing object. |
absoluteRotationAngle | number | readonly | The rotation angle of the Button relative to its containing object. (Range: -360 to 360) |
absoluteShearAngle | number | readonly | The skewing angle of the Button relative to its containing object. (Range: -360 to 360) |
absoluteVerticalScale | number | readonly | The vertical scale of the Button relative to its containing object. |
activeStateIndex | number | readonly | The index of the active state in the object's states collection. |
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 | readonly | A collection of animation behaviors. |
associatedXMLElement | XMLItem | readonly | The XML element associated with the Button. |
behaviors | Behaviors | 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 |
readonly | The shape to apply to the bottom left corner of rectangular shapes. |
bottomLeftCornerRadius | Measurement Unit (Number or String) | readonly | 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 |
readonly | The shape to apply to the bottom right corner of rectangular shapes. |
bottomRightCornerRadius | Measurement Unit (Number or String) | readonly | The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes |
description | string | readonly | The description of the Button. |
endCap | EndCap: EndCap.BUTT_END_CAP EndCap.ROUND_END_CAP EndCap.PROJECTING_END_CAP |
readonly | The end shape of an open path. |
endJoin | EndJoin: EndJoin.MITER_END_JOIN EndJoin.ROUND_END_JOIN EndJoin.BEVEL_END_JOIN |
readonly | The corner join applied to the Button. |
epss | EPSs | readonly | A collection of EPS files. |
epstexts | EPSTexts | readonly | EPSTexts |
eventListeners | EventListeners | readonly | A collection of event listeners. |
events | Events | readonly | A collection of events. |
fillColor | String Swatch |
readonly | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the Button. . Can also accept: String. |
fillTint | number | readonly | 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.) |
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 | readonly | 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 | readonly | 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) | readonly | 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 | readonly | A collection of goto anchor behavior objects. |
gotoFirstPageBehaviors | GotoFirstPageBehaviors | readonly | A collection of goto first page behavior objects. |
gotoLastPageBehaviors | GotoLastPageBehaviors | readonly | A collection of goto last page behavior objects. |
gotoNextPageBehaviors | GotoNextPageBehaviors | readonly | A collection of goto next page behavior objects. |
gotoNextStateBehaviors | GotoNextStateBehaviors | readonly | A collection of goto next state behaviors. |
gotoNextViewBehaviors | GotoNextViewBehaviors | readonly | A collection of goto next view behavior objects. |
gotoPageBehaviors | GotoPageBehaviors | readonly | A collection of go to page behavior objects. |
gotoPreviousPageBehaviors | GotoPreviousPageBehaviors | readonly | A collection of goto previous page behavior objects. |
gotoPreviousStateBehaviors | GotoPreviousStateBehaviors | readonly | A collection of goto previous state behaviors. |
gotoPreviousViewBehaviors | GotoPreviousViewBehaviors | readonly | A collection of goto previous view behavior objects. |
gotoStateBehaviors | GotoStateBehaviors | readonly | A collection of goto state behaviors. |
gotoURLBehaviors | GotoURLBehaviors | readonly | A collection of goto URL behavior objects. |
gradientFillAngle | number | readonly | The angle of a linear gradient applied to the fill of the Button. (Range: -180 to 180) |
gradientFillLength | Measurement Unit (Number or String) | readonly | 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) | readonly | The starting point (in page coordinates) of a gradient applied to the fill of the Button, in the format [x, y]. |
gradientStrokeAngle | number | readonly | The angle of a linear gradient applied to the stroke of the Button. (Range: -180 to 180) |
gradientStrokeLength | Measurement Unit (Number or String) | readonly | 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) | readonly | The starting point (in page coordinates) of a gradient applied to the stroke of the Button, in the format [x, y]. |
graphicLines | GraphicLines | readonly | A collection of graphic lines. |
graphics | Graphics | readonly | A collection of imported graphics in any graphic file format (vector, metafile, or bitmap). |
groups | Groups | readonly | A collection of groups. |
horizontalScale | number | readonly | The horizontal scaling applied to the Button. |
id | number | readonly | The unique ID of the Button. |
images | Images | 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 | readonly | 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 |
readonly | The arrowhead applied to the start of the path. |
localDisplaySetting | DisplaySettingOptions: DisplaySettingOptions.HIGH_QUALITY DisplaySettingOptions.TYPICAL DisplaySettingOptions.OPTIMIZED DisplaySettingOptions.DEFAULT_VALUE |
readonly | Display performance options for the Button. |
locked | bool | readonly | If true, the Button is locked. |
miterLimit | number (range: 1 - 500) | readonly | 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 | readonly | A collection of movie behavior objects. |
name | string | readonly | The name of the Button. |
nonprinting | bool | readonly | If true, the Button does not print. |
openFileBehaviors | OpenFileBehaviors | readonly | A collection of open file behavior objects. |
ovals | Ovals | readonly | A collection of ellipses. |
overprintFill | bool | readonly | If true, the Button's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. |
overprintGap | bool | readonly | If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. |
overprintStroke | bool | readonly | 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 | 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 SplineItem Spread |
readonly | The parent of the Button (a PlaceGun, Spread, MasterSpread, SplineItem, Polygon, GraphicLine, Rectangle, Oval, Group or Character). |
parentPage | Page | readonly | The page on which this page item appears. |
paths | Paths | readonly | A collection of paths. |
pdfs | PDFs | readonly | A collection of PDF files. |
picts | PICTs | readonly | A collection of PICT graphics. |
polygons | Polygons | readonly | A collection of polygons. |
preferences | Preferences | readonly | A collection of preferences objects. |
properties | Object | r/w | A property that allows setting of several properties at the same time. |
rectangles | Rectangles | 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 |
readonly | The arrowhead applied to the end of the path. |
rotationAngle | number | readonly | The rotatation angle of the Button. (Range: -360 to 360) |
shearAngle | number | readonly | The skewing angle applied to the Button. (Range: -360 to 360) |
showHideFieldsBehaviors | ShowHideFieldsBehaviors | readonly | A collection of show/hide fields behavior objects. |
soundBehaviors | SoundBehaviors | readonly | A collection of sound behavior objects. |
splineItems | SplineItems | readonly | The spline items collection. |
states | States | readonly | A collection of states. |
strokeAlignment | StrokeAlignment: StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT |
readonly | The stroke alignment applied to the Button. |
strokeColor | String Swatch |
readonly | 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 |
readonly | The corner adjustment applied to the Button. |
strokeDashAndGap | Array of Measurement Unit (Number or String) | readonly | 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 | readonly | 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 | String StrokeStyle |
readonly | The name of the stroke style to apply. Can also accept: String. |
strokeWeight | Measurement Unit (Number or String) | readonly | The weight (in points) to apply to the Button's stroke. |
textFrames | TextFrames | readonly | A collection of text frames. |
textWrapPreferences | TextWrapPreference | readonly | The text wrap preference properties that define the default formatting for wrapping text around objects. |
topLeftCornerOption | CornerOptions: CornerOptions.NONE CornerOptions.ROUNDED_CORNER CornerOptions.INVERSE_ROUNDED_CORNER CornerOptions.INSET_CORNER CornerOptions.BEVEL_CORNER CornerOptions.FANCY_CORNER |
readonly | 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) | readonly | 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 |
readonly | The shape to apply to the top right corner of rectangular shapes |
topRightCornerRadius | Measurement Unit (Number or String) | readonly | The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes |
verticalScale | number | readonly | The vertical scaling applied to the Button. |
viewZoomBehaviors | ViewZoomBehaviors | readonly | A collection of view zoom behavior objects. |
visibilityInPdf | VisibilityInPdf: VisibilityInPdf.VISIBLE_IN_PDF VisibilityInPdf.HIDDEN_IN_PDF VisibilityInPdf.VISIBLE_BUT_DOES_NOT_PRINT_IN_PDF VisibilityInPdf.HIDDEN_BUT_PRINTABLE_IN_PDF |
readonly | The field's visibility in the PDF document. |
visible | bool | r/w | If true, the Button is visible. |
visibleBounds | Array of Measurement Unit (Number or String) | readonly | 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 | readonly | A collection of WMF graphics. |
Class
Property | Type | Access | Description |
---|---|---|---|
AFTER_PLACE | string | readonly | Dispatched after a Button is placed. This event bubbles. This event is not cancelable. (default: afterPlace) |
BEFORE_PLACE | string | readonly | Dispatched before a Button is placed. This event bubbles. This event is cancelable. (default: beforePlace) |
Methods
Instances
EventListener addEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Adds an event listener.
Parameter | Type | Description |
---|---|---|
eventType | string | The event type. |
handler | File JavaScript Function | The event handler. Can accept: File or JavaScript Function. |
captures | bool | This parameter is obsolete. (Optional) (default: false) |
void autoTag ()
Tag the object or the parent story using default tags defined in XML preference.
Array
of PageItem changeObject ([reverseOrder:
bool])
Finds objects that match the find what value and replace the objects with the change to value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
void clearTransformations ()
Clears transformations from the Button. Transformations include rotation, scaling, flipping, fitting, and shearing.
void convertShape (given:
ConvertShapeOptions[, numberOfSides:
number][, insetPercentage:
number][, cornerRadius:
Measurement Unit (Number or String)])
Converts the Button to a different shape.
Parameter | Type | Description |
---|---|---|
given | ConvertShapeOptions: ConvertShapeOptions.CONVERT_TO_RECTANGLE ConvertShapeOptions.CONVERT_TO_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_BEVELED_RECTANGLE ConvertShapeOptions.CONVERT_TO_INVERSE_ROUNDED_RECTANGLE ConvertShapeOptions.CONVERT_TO_OVAL ConvertShapeOptions.CONVERT_TO_TRIANGLE ConvertShapeOptions.CONVERT_TO_POLYGON ConvertShapeOptions.CONVERT_TO_LINE ConvertShapeOptions.CONVERT_TO_STRAIGHT_LINE ConvertShapeOptions.CONVERT_TO_OPEN_PATH ConvertShapeOptions.CONVERT_TO_CLOSED_PATH | 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 | Measurement Unit (Number or String) (range: 0 - 800) | The corner radius of the resulting rectangle. (Optional) |
string extractLabel (key:
string)
Gets the label value associated with the specified key.
Parameter | Type | Description |
---|---|---|
key | string | The key. |
Array
of PageItem findObject ([reverseOrder:
bool])
Finds objects that match the find what value.
Parameter | Type | Description |
---|---|---|
reverseOrder | bool | If true, returns the results in reverse order. (Optional) |
void fit (given:
FitOptions)
Applies the specified fit option to content in a frame.
Parameter | Type | Description |
---|---|---|
given | FitOptions: FitOptions.CONTENT_TO_FRAME FitOptions.CENTER_CONTENT FitOptions.PROPORTIONALLY FitOptions.FILL_PROPORTIONALLY FitOptions.APPLY_FRAME_FITTING_OPTIONS | The fit option to use. |
Array
of Button getElements ()
Resolves the object specifier, creating an array of object references.
void 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. |
void 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. |
void 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) |
void reframe (in:
varies, opposingCorners:
Array
of varies)
Move the bounding box of the page item
Parameter | Type | Description |
---|---|---|
in | boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace:CoordinateSpaces | The bounding box to resize. Can accept: CoordinateSpaces enumerator or Ordered array containing coordinateSpace:CoordinateSpaces enumerator, boundsKind:BoundingBoxLimits enumerator. |
opposingCorners | Array of any | Opposing corners of new bounding box in the given coordinate space |
bool removeEventListener (eventType:
string, handler:
varies[, captures:
bool=false])
Removes the event listener.
Parameter | Type | Description |
---|---|---|
eventType | string | The registered event type. |
handler | File JavaScript Function | The registered event handler. Can accept: File or JavaScript Function. |
captures | bool | This parameter is obsolete. (Optional) (default: false) |
void resize (in:
varies, from:
varies, by:
ResizeMethods, values:
Array
of varies[, resizeIndividually:
bool=true][, consideringRulerUnits:
bool=false])
Resize the page item.
Parameter | Type | Description |
---|---|---|
in | BoundingBoxLimits boundsKind:BoundingBoxLimits CoordinateSpaces Ordered array containing coordinateSpace: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 Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers | 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 : Array of Reals CoordinateSpaces ResizeConstraints | 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 | bool | 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 | bool | 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) |
any resolve (location:
varies, in:
CoordinateSpaces[, consideringRulerUnits:
bool=false])
Get the coordinates of the given location in the specified coordinate system.
Parameter | Type | Description |
---|---|---|
location | AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers | 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.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES | The coordinate space to use. |
consideringRulerUnits | bool | 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) |
string toSource ()
Generates a string which, if executed, will return the Button.
string toSpecifier ()
Retrieves the object specifier.
void transform (in:
CoordinateSpaces, from:
varies, withMatrix:
varies[, replacingCurrent:
varies][, consideringRulerUnits:
bool=false])
Transform the page item.
Parameter | Type | Description |
---|---|---|
in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES | The coordinate space to use |
from | AnchorPoint AnchorPoint Array of 2 Reals Array of Arrays of 2 Reals BoundingBoxLimits CoordinateSpaces Long Integers | 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 Long Integer MatrixContent | 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 | bool | 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) |
Array
of TransformationMatrix transformValuesOf (in:
CoordinateSpaces)
Get the transformation values of the page item.
Parameter | Type | Description |
---|---|---|
in | CoordinateSpaces: CoordinateSpaces.PASTEBOARD_COORDINATES CoordinateSpaces.PARENT_COORDINATES CoordinateSpaces.INNER_COORDINATES CoordinateSpaces.SPREAD_COORDINATES | The coordinate space to use |
Element of
AnimationBehavior.parent
Behavior.parent
GotoAnchorBehavior.parent
GotoFirstPageBehavior.parent
GotoLastPageBehavior.parent
GotoNextPageBehavior.parent
GotoNextStateBehavior.parent
GotoNextViewBehavior.parent
GotoPageBehavior.parent
GotoPreviousPageBehavior.parent
GotoPreviousStateBehavior.parent
GotoPreviousViewBehavior.parent
GotoStateBehavior.parent
GotoURLBehavior.parent
MovieBehavior.parent
OpenFileBehavior.parent
Page.tabOrder
ShowHideFieldsBehavior.fieldsToHide
ShowHideFieldsBehavior.fieldsToShow
ShowHideFieldsBehavior.parent
SoundBehavior.parent
State.parent
ViewZoomBehavior.parent
Used in:
Button Buttons.nextItem (obj: Button)
Button Buttons.previousItem (obj: Button)
Return
Array of Button Button.getElements ()
Button Buttons.[] (index: number)
Button Buttons.add ([layer: Layer][, at: LocationOptions=LocationOptions.UNKNOWN][, reference: varies][, withProperties: Object])
Button Buttons.anyItem ()
Array of Button Buttons.everyItem ()
Button Buttons.firstItem ()
Button Buttons.item (index: varies)
Button Buttons.itemByID (id: number)
Button Buttons.itemByName (name: string)
Array of Button Buttons.itemByRange (from: varies, to: varies)
Button Buttons.lastItem ()
Button Buttons.middleItem ()
Button Buttons.nextItem (obj: Button)
Button Buttons.previousItem (obj: Button)
Jongware, 23-Mar-2011 v3.0.3d | Contents :: Index |