A button.
|
Property
|
Type
|
Access
|
Description
|
|
AbsoluteHorizontalScale
|
Double
|
r/w
|
The horizontal scaling percentage applied to the object, not including any scaling applied to its containing object.
|
|
AbsoluteRotationAngle
|
Double
|
r/w
|
The rotation angle applied to the object, not including any rotation applied to its containing object.
|
|
AbsoluteShearAngle
|
Double
|
r/w
|
The shear angle applied to the object, not including any shearing applied to its containing object.
|
|
AbsoluteVerticalScale
|
Double
|
r/w
|
The vertical scaling percentage applied to the object, not including any scaling applied to its containing object.
|
|
AllGraphics
|
Array of Graphics
|
read
|
All graphics contained by the object.
|
|
AllPageItems
|
Array of PageItems
|
read
|
All page items contained by the object.
|
|
AnchoredObjectSettings
|
AnchoredObjectSetting
|
read
|
Anchored object settings for the object.
|
|
AppearanceName
|
String
|
read
|
Name of any appearance of field.
|
|
AppliedObjectStyle
|
ObjectStyle
|
r/w
|
The object style applied to the object.
|
|
AssociatedXMLElement
|
XMLItem
|
read
|
The XML element associated with the object.
|
|
Behaviors
|
Behaviors
|
read
|
Every behavior object.
|
|
BlendMode
|
idBlendMode enumeration
|
r/w
|
The blending mode applied to the object.
|
|
CloseWindowBehaviors
|
CloseWindowBehaviors
|
read
|
Every close window behavior object.
|
|
CornerEffect
|
idCornerEffects enumeration
|
r/w
|
The corner effect applied to the object.
|
|
CornerRadius
|
Double
|
r/w
|
The corner effect radius applied to the object.
|
|
Description
|
String
|
r/w
|
Description.
|
|
EndCap
|
idEndCap enumeration
|
r/w
|
The end cap applied to the stroke of the object.
|
|
EndJoin
|
idEndJoin enumeration
|
r/w
|
The end join applied to the stroke of the object.
|
|
EPSs
|
EPSs
|
read
|
The EPS graphics contained by the object.
|
|
FeatherCornerType
|
idFeatherCornerType enumeration
|
r/w
|
The type of feathering applied to the object.
|
|
FeatherMode
|
idFeatherMode enumeration
|
r/w
|
The feathering mode applied to the object.
|
|
FeatherNoise
|
Double (0 - 100)
|
r/w
|
The amount of noise applied to the feathering applied to the object.
|
|
FeatherWidth
|
Unit (Double or String) (0 - 1000 points)
|
r/w
|
The width of the feathering applied to the object.
|
|
FillColor
|
Swatch, String
|
r/w
|
The fill of the object.
|
|
FillTint
|
Double
|
r/w
|
The tint percentage applied to the fill of the object (-1 indicates 100%).
|
|
GapColor
|
Swatch
|
r/w
|
The gap color applied to the stroke of the object.
|
|
GapTint
|
Double
|
r/w
|
The tint applied to the gap color of the object (-1 indicates 100%).
|
|
GeometricBounds
|
Array of 4 Units (Doubles or Strings)
|
r/w
|
The bounds of the page item excluding the stroke width, in the form (top, left, bottom, right).
|
|
GotoAnchorBehaviors
|
GotoAnchorBehaviors
|
read
|
Every goto anchor behavior object.
|
|
GotoFirstPageBehaviors
|
GotoFirstPageBehaviors
|
read
|
Every goto first page behavior object.
|
|
GotoLastPageBehaviors
|
GotoLastPageBehaviors
|
read
|
Every goto last page behavior object.
|
|
GotoNextPageBehaviors
|
GotoNextPageBehaviors
|
read
|
Every goto next page behavior object.
|
|
GotoNextViewBehaviors
|
GotoNextViewBehaviors
|
read
|
Every goto next view behavior object.
|
|
GotoPreviousPageBehaviors
|
GotoPreviousPageBehaviors
|
read
|
Every goto previous page behavior object.
|
|
GotoPreviousViewBehaviors
|
GotoPreviousViewBehaviors
|
read
|
Every goto previous view behavior object.
|
|
GotoURLBehaviors
|
GotoURLBehaviors
|
read
|
Every goto URL behavior object.
|
|
GradientFillAngle
|
Double
|
r/w
|
The angle of the gradient applied to the fill of the object.
|
|
GradientFillLength
|
Unit (Double or String)
|
r/w
|
Length (for a linear gradient) or radius (for a radial gradient) of the gradient applied to the fill of the object.
|
|
GradientFillStart
|
Array of 2 Units (Doubles or Strings)
|
r/w
|
Starting point (for a linear gradient) or center point (for a radial gradient) of a gradient applied to the fill of the object.
|
|
GradientStrokeAngle
|
Double
|
r/w
|
The angle of the gradient applied to the stroke of the object.
|
|
GradientStrokeLength
|
Unit (Double or String)
|
r/w
|
Length (for a linear gradient) or radius (for a radial gradient) of the gradient applied to the stroke of the object.
|
|
GradientStrokeStart
|
Array of 2 Units (Doubles or Strings)
|
r/w
|
Starting point (for a linear gradient) or center point (for a radial gradient) of a gradient applied to the stroke of the object.
|
|
GraphicLines
|
GraphicLines
|
read
|
The graphic lines contained by the object.
|
|
Graphics
|
Graphics
|
read
|
The graphics contained by the object.
|
|
Groups
|
Groups
|
read
|
The groups contained by the object.
|
|
HorizontalScale
|
Double
|
r/w
|
The horizontal scaling percentage applied to the object, including the scaling applied to its containing object(s).
|
|
Id
|
Long
|
read
|
A unique number identifying the object.
|
|
Images
|
Images
|
read
|
The images contained by the object.
|
|
Index
|
Long
|
read
|
Index of the object within its parent object.
|
|
IsolateBlending
|
Boolean
|
r/w
|
If true, the object will blend in isolation.
|
|
ItemLayer
|
Layer
|
r/w
|
The layer the object is on.
|
|
KnockoutGroup
|
Boolean
|
r/w
|
If true, the object will blend as a knockout group.
|
|
Label
|
String
|
r/w
|
A label that can be set to any string.
|
|
LeftLineEnd
|
idArrowHead enumeration
|
r/w
|
A shape, such as an arrowhead, applied to the left end of the paths of the object. This shape will only appear on open paths.
|
|
LocalDisplaySetting
|
idDisplaySettingOptions enumeration
|
r/w
|
The display settings for the object.
|
|
Locked
|
Boolean
|
r/w
|
If true, the object is locked.
|
|
MiterLimit
|
Double
|
r/w
|
The point at which the rendering of a corner point switches from a miter join to a bevel join.
|
|
MovieBehaviors
|
MovieBehaviors
|
read
|
Movie behaviors collection object.
|
|
Name
|
String
|
r/w
|
The name of the object.
|
|
Nonprinting
|
Boolean
|
r/w
|
If true, the object is non-printing.
|
|
Opacity
|
Double (0 - 100)
|
r/w
|
The opacity of the object.
|
|
OpenFileBehaviors
|
OpenFileBehaviors
|
read
|
Open file behaviors collection object.
|
|
Ovals
|
Ovals
|
read
|
All ovals contained by the object.
|
|
OverprintFill
|
Boolean
|
r/w
|
If true, the fill of the object will overprint.
|
|
OverprintGap
|
Boolean
|
r/w
|
If true, the gap color applied to the stroke of the object will overprint.
|
|
OverprintStroke
|
Boolean
|
r/w
|
If true, the storke of the object will overprint.
|
|
Overridden
|
Boolean
|
read
|
If true, this object originated on a master spread, was overridden, and is still linked to the object on the master spread.
|
|
OverriddenMasterPageItem
|
PageItem, Guide, Graphic, Movie, Sound
|
read
|
A reference to the original object on the master spread (for overridden objects).
|
|
PageItems
|
PageItems
|
read
|
The page items contained by the object.
|
|
Parent
|
Object
|
read
|
The parent of the object.
|
|
PDFs
|
PDFs
|
read
|
The PDF graphics contained by the object.
|
|
PICTs
|
PICTs
|
read
|
The PICT graphics contained by the object.
|
|
Polygons
|
Polygons
|
read
|
The polygons contained by the object.
|
|
QuitBehaviors
|
QuitBehaviors
|
read
|
Quit behaviors collection object.
|
|
Rectangles
|
Rectangles
|
read
|
The rectangles contained by the object.
|
|
RightLineEnd
|
idArrowHead enumeration
|
r/w
|
A shape, such as an arrowhead, applied the right end of the paths of the object. This shape will only appear on open paths.
|
|
RotationAngle
|
Double
|
r/w
|
The rotation angle applied to the object, including any rotation applied to its containing object.
|
|
ShadowBlendMode
|
idBlendMode enumeration
|
r/w
|
The blending mode applied to the drop shadow.
|
|
ShadowBlurRadius
|
Unit (Double or String) (0 - 144 points)
|
r/w
|
The blur radius of the the drop shadow.
|
|
ShadowColor
|
Swatch
|
r/w
|
The color of the drop shadow.
|
|
ShadowMode
|
idShadowMode enumeration
|
r/w
|
The shadow mode of the drop shadow.
|
|
ShadowNoise
|
Double (0 - 100)
|
r/w
|
The amount of noise applied to the drop shadow.
|
|
ShadowOpacity
|
Double (0 - 100)
|
r/w
|
The opacity of the drop shadow.
|
|
ShadowSpread
|
Double (0 - 100)
|
r/w
|
The distance to spread the drop shadow before applying blurring.
|
|
ShadowXOffset
|
Unit (Double or String) (-1000 - 1000 points)
|
r/w
|
The horizontal offset of the drop shadow from the object.
|
|
ShadowYOffset
|
Unit (Double or String) (-1000 - 1000 points)
|
r/w
|
The vertical offset of the drop shadow from the object.
|
|
ShearAngle
|
Double
|
r/w
|
The shear angle of the object, including any shearing applied to its containing object.
|
|
ShowHideFieldsBehaviors
|
ShowHideFieldsBehaviors
|
read
|
Show/hide fields behaviors collection object.
|
|
SoundBehaviors
|
SoundBehaviors
|
read
|
Sound behaviors collection object.
|
|
States
|
States
|
read
|
Every form field appearance state.
|
|
StrokeAlignment
|
idStrokeAlignment enumeration
|
r/w
|
The stroke alignment of the object.
|
|
StrokeColor
|
Swatch, String
|
r/w
|
The stroke color of the object.
|
|
StrokeCornerAdjustment
|
idStrokeCornerAdjustment enumeration
|
r/w
|
The adjustment method to apply to the corners of a dashed stroke.
|
|
StrokeDashAndGap
|
Array of Units (Doubles or Strings)
|
r/w
|
The dash and gap settings of a dashed stroke. A list of up to 6 values.
|
|
StrokeTint
|
Double
|
r/w
|
The tint percentage applied to the stroke (-1 indicates 100%).
|
|
StrokeType
|
StrokeStyle
|
r/w
|
The stroke type.
|
|
StrokeWeight
|
Unit (Double or String)
|
r/w
|
The stroke weight (thickness) of the stroke.
|
|
TextFrames
|
TextFrames
|
read
|
The text frames contained by the object.
|
|
TextWrapPreferences
|
TextWrapPreference
|
read
|
Text wrap preferences for the object.
|
|
VerticalScale
|
Double
|
r/w
|
The vertical scaling percentage applied to the object, including the scaling applied to its containing object(s).
|
|
ViewZoomBehaviors
|
ViewZoomBehaviors
|
read
|
View Zoom behaviors collection object.
|
|
VisibilityInPdf
|
idVisibilityInPdf enumeration
|
r/w
|
Visibility of the item in the output PDF.
|
|
VisibleBounds
|
Array of 4 Units (Doubles or Strings)
|
r/w
|
The bounds of the page item, including the stroke width, in the form (top, left, bottom, right).
|
|
WMFs
|
WMFs
|
read
|
The WMF graphics contained by the object.
|
|
Method
|
Returns
|
Description
|
|
AddPath
|
PageItem
|
Create a new shape by adding the path(s) of this object with the paths of other objects. This method corresponds to the Add pathfinder.
|
|
ApplyAppearance
|
Nothing
|
Apply an appearance.
|
|
BringForward
|
Nothing
|
Brings the object forward.
|
|
BringToFront
|
Nothing
|
Brings object to the front.
|
|
Delete
|
Nothing
|
Deletes the object.
|
|
Detach
|
Nothing
|
Detaches an overridden page item from the master page item.
|
|
Duplicate
|
PageItem
|
Duplicates the object.
|
|
ExcludeOverlapPath
|
PageItem
|
Creates a new shape by excluding area of intersection of this object with the other objects. This method corresponds to the Exclude Overlap pathfinder.
|
|
Export
|
Nothing
|
Exports the object to a file.
|
|
ExtractLabel
|
String
|
Gets the content of the label associated with the specified key (name).
|
|
Fit
|
Nothing
|
Applies fitting options to the content of a frame.
|
|
FlipItem
|
Nothing
|
Flips the object around a specified axis.
|
|
InsertLabel
|
Nothing
|
Sets the content of the label associated with the specified key (name), creating the label if it does not already exist.
|
|
IntersectPath
|
PageItem
|
Create a new shape based on the area(s) of intersection between this object and the other objects. This method corresponds to the Intersect pathfinder.
|
|
MakeCompoundPath
|
PageItem
|
Creates a compound path by adding the paths of this object to the paths of other objects.
|
|
Markup
|
Nothing
|
Mark up layout content with XML preserving the existing content.
|
|
MinusBack
|
PageItem
|
Creates a new shape by reverse subtracting this object from the specified other objects. This method corresponds to the Minus Back pathfinder.
|
|
Move
|
Nothing
|
Moves the object to a new location. One of the parameters is required.
|
|
Override
|
PageItem, Guide, Graphic, Movie or Sound
|
Overrides an item from the master page and places it on the page.
|
|
Place
|
PageItem, Graphic, Movie, Sound, Story or Text
|
Places a file.
|
|
PlaceXML
|
Nothing
|
Places content into the specified XML element (replacing the existing content).
|
|
ReleaseCompoundPath
|
Array of PageItems
|
Releases a compound path and returns the released page items.
|
|
RemoveOverride
|
Nothing
|
Removes a locally overridden master page item.
|
|
ResetScaling
|
Nothing
|
Resets the scaling to 100%. Note that this does not change the size of the object; instead, it makes the current size of the object the basis for future scaling.
|
|
Resize
|
Nothing
|
Resizes the object.
|
|
Rotate
|
Nothing
|
Rotates the object.
|
|
Select
|
Nothing
|
Selects the object.
|
|
SendBackward
|
Nothing
|
Send object backward.
|
|
SendToBack
|
Nothing
|
Send object to the back.
|
|
Shear
|
Nothing
|
Shears the page item.
|
|
Store
|
Asset
|
Stores the object in a library.
|
|
SubtractPath
|
PageItem
|
Create a new shape by subtracting the area(s) of intersection of this object from the specified objects. This method corresponds to the Subtract pathfinder.
|
|
TransformAgain
|
Array of Strings
|
Repeats the last transformation.
|
|
TransformAgainIndividually
|
Array of Strings
|
Transforms the object using the last transformation (applied individually).
|
|
TransformSequenceAgain
|
Array of Strings
|
Transforms the object using the last sequence of transformations.
|
|
TransformSequenceAgainIndividually
|
Array of Strings
|
Transforms the object using the last sequence of transformations (applied individually).
|