ObjectStyle
QuickLinks
Hierarchy
Properties
| Property | Type | Access | Description |
|---|---|---|---|
| anchoredObjectSettings | AnchoredObjectSetting | r/w | Anchored object settings. |
| appliedParagraphStyle | ParagraphStyleString | r/w | The paragraph style applied to the text. Can also accept: String. |
| applyNextParagraphStyle | bool | r/w | If true, applies paragraph styles using Next Paragraph Style settings, beginning with the Next Paragraph Style defined in the paragraph style associated with the object style (if any). |
| basedOn | ObjectStyle String |
r/w | The style that this style is based on. Can return: ObjectStyle or String. |
| baselineFrameGridOptions | BaselineFrameGridOption | r/w | Baseline frame grid option settings. |
| blendMode | BlendMode: BlendMode.NORMAL BlendMode.MULTIPLY BlendMode.SCREEN BlendMode.OVERLAY BlendMode.SOFT_LIGHT BlendMode.HARD_LIGHT BlendMode.COLOR_DODGE BlendMode.COLOR_BURN BlendMode.DARKEN BlendMode.LIGHTEN BlendMode.DIFFERENCE BlendMode.EXCLUSION BlendMode.HUE BlendMode.SATURATION BlendMode.COLOR BlendMode.LUMINOSITY |
r/w | The blend mode used to combine the background with the color of the ObjectStyle. |
| cornerEffect | CornerEffects: CornerEffects.NONE CornerEffects.ROUNDED_CORNER CornerEffects.INVERSE_ROUNDED_CORNER CornerEffects.INSET_CORNER CornerEffects.BEVEL_CORNER CornerEffects.FANCY_CORNER |
r/w | 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 | r/w | The radius of the corner |
| defaultFrameGridObjectStyle | ObjectStyle String |
r/w | The Default Frame Grid Object Style. Can return: ObjectStyle or String. |
| defaultObjectStyle | ObjectStyle String |
r/w | The Default Object Style. Can return: ObjectStyle or String. |
| defaultTextObjectStyle | ObjectStyle String |
r/w | The Default Text Object Style. Can return: ObjectStyle or String. |
| enableAnchoredObjectOptions | bool | r/w | If true, the object style will apply an anchored object setting. |
| enableDropshadowAndFeather | bool | r/w | If true, drop shadow and feather settings can be defined for the object style. |
| enableFill | bool | r/w | If true, the object style will apply a fill. |
| enableParagraphStyle | bool | r/w | If true, the object style will apply a paragraph style. |
| enableStoryOptions | bool | r/w | If true, the object style will apply story options. |
| enableStroke | bool | r/w | If true, the object style will apply a stroke. |
| enableStrokeAndCornerEffects | bool | r/w | If true, the object style will apply stroke effects and corner effects. |
| enableTextFrameBaselineOptions | bool | r/w | If true, the object style will apply baseline text frame options. |
| enableTextFrameGeneralOptions | bool | r/w | If true, the object style will apply general text frame options. |
| enableTextWrapAndOthers | bool | r/w | If true, the object style will apply text wrap, contour, and non-printing settings. |
| enableTransparency | bool | r/w | If true, the object style will apply transparency settings. |
| 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 ObjectStyle. |
| featherCornerType | FeatherCornerType: FeatherCornerType.SHARP FeatherCornerType.ROUNDED FeatherCornerType.DIFFUSION |
r/w | The type of feathering. |
| featherMode | FeatherMode: FeatherMode.NONE FeatherMode.STANDARD |
r/w | The feather-enabling mode. |
| featherNoise | number (range: 0 - 100) | r/w | The amount (as a percentage) of noise to apply to the feather. (Range: 0 to 100) |
| featherWidth | Measurement Unit (Number or String) (range: 0 - 1000) | r/w | The width of the feathering. |
| fillColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the ObjectStyle. . Can also accept: String. |
| fillTint | number | r/w | The percent of tint to use in the ObjectStyle'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 | 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.) |
| gradientFillAngle | number | r/w | The angle of a linear gradient applied to the fill of the ObjectStyle. (Range: -180 to 180) |
| gradientStrokeAngle | number | r/w | The angle of a linear gradient applied to the stroke of the ObjectStyle. (Range: -180 to 180) |
| id | number | readonly | The unique ID of the ObjectStyle. |
| index | number | readonly | The index of the ObjectStyle within its containing object. |
| isolateBlending | bool | r/w | If true, the ObjectStyle blends in isolation. |
| knockoutGroup | bool | r/w | If true, the ObjectStyle is a knockout group. |
| 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. |
| miterLimit | number | r/w | 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) |
| name | string | r/w | The name of the ObjectStyle. |
| nonprinting | bool | r/w | If true, the ObjectStyle does not print. |
| opacity | number (range: 0 - 100) | r/w | The opacity of the ObjectStyle. (Range: 0 to 100) |
| overprintFill | bool | r/w | If true, the ObjectStyle'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 ObjectStyle's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. |
| parent | Application Document |
readonly | The parent of the ObjectStyle (a Document or Application). |
| properties | Object | r/w | A property that allows setting of several properties at the same time. |
| 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. |
| shadowBlendMode | BlendMode: BlendMode.NORMAL BlendMode.MULTIPLY BlendMode.SCREEN BlendMode.OVERLAY BlendMode.SOFT_LIGHT BlendMode.HARD_LIGHT BlendMode.COLOR_DODGE BlendMode.COLOR_BURN BlendMode.DARKEN BlendMode.LIGHTEN BlendMode.DIFFERENCE BlendMode.EXCLUSION BlendMode.HUE BlendMode.SATURATION BlendMode.COLOR BlendMode.LUMINOSITY |
r/w | The blend mode to use for drawing the shadow. |
| shadowBlurRadius | Measurement Unit (Number or String) (range: 0 - 144) | r/w | The radius of the shadow blur. |
| shadowColor | Swatch | r/w | The swatch (color or mixed ink) applied to the shadow. |
| shadowMode | ShadowMode: ShadowMode.NONE ShadowMode.DROP |
r/w | The shadow mode. |
| shadowNoise | number (range: 0 - 100) | r/w | The amount (as a percentage) of noise to apply to the shadow. (Range: 0 to 100) |
| shadowOpacity | number (range: 0 - 100) | r/w | The opacity of the shadow. (Range: 0 to 100) |
| shadowSpread | number (range: 0 - 100) | r/w | 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 | Measurement Unit (Number or String) (range: -1000 - 1000) | r/w | The horizontal offset of the shadow. |
| shadowYOffset | Measurement Unit (Number or String) (range: -1000 - 1000) | r/w | The vertical offset of the shadow. |
| storyPreferences | StoryPreference | r/w | Story preference settings. |
| strokeAlignment | StrokeAlignment: StrokeAlignment.CENTER_ALIGNMENT StrokeAlignment.INSIDE_ALIGNMENT StrokeAlignment.OUTSIDE_ALIGNMENT |
r/w | The stroke alignment applied to the ObjectStyle. |
| strokeColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the ObjectStyle. Can also accept: String. |
| strokeCornerAdjustment | StrokeCornerAdjustment: StrokeCornerAdjustment.NONE StrokeCornerAdjustment.DASHES StrokeCornerAdjustment.GAPS StrokeCornerAdjustment.DASHES_AND_GAPS |
r/w | The corner adjustment applied to the ObjectStyle. |
| 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.) |
| strokeType | StrokeStyle | r/w | The stroke type |
| strokeWeight | Measurement Unit (Number or String) | r/w | The weight (in points) to apply to the ObjectStyle's stroke. |
| textFramePreferences | TextFramePreference | r/w | Text frame preference settings. |
| textWrapPreferences | TextWrapPreference | r/w | The text wrap preference properties that define the default formatting for wrapping text around objects. |
Methods
Instances
ObjectStyle duplicate ()
Duplicates the ObjectStyle.
string extractLabel (key:
string)
Gets the label value associated with the specified key.
| Parameter | Type | Description |
|---|---|---|
| key | string | The key. |
Array
of Object 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. |
ObjectStyle move (to:
LocationOptions[, reference:
ObjectStyle])
Moves the ObjectStyle to the specified location.
| Parameter | Type | Description |
|---|---|---|
| to | LocationOptions: LocationOptions.BEFORE LocationOptions.AFTER LocationOptions.AT_END LocationOptions.AT_BEGINNING LocationOptions.UNKNOWN | The location relative to the reference object or within the containing object. |
| reference | ObjectStyle | The reference object. Note: Required when the to value specifies before or after. (Optional) |
void remove ()
Deletes the ObjectStyle.
string toSource ()
Generates a string which, if executed, will return the ObjectStyle.
Element of
AnchoredObjectDefault.anchoredObjectStyle
AnchoredObjectSetting.parent
BaselineFrameGridOption.parent
Button.appliedObjectStyle
EPS.appliedObjectStyle
FormField.appliedObjectStyle
GraphicLine.appliedObjectStyle
Group.appliedObjectStyle
Image.appliedObjectStyle
ObjectStyle.basedOn
ObjectStyle.defaultFrameGridObjectStyle
ObjectStyle.defaultObjectStyle
ObjectStyle.defaultTextObjectStyle
Oval.appliedObjectStyle
PDF.appliedObjectStyle
PICT.appliedObjectStyle
PageItem.appliedObjectStyle
Polygon.appliedObjectStyle
Rectangle.appliedObjectStyle
StoryPreference.parent
TextFrame.appliedObjectStyle
TextFramePreference.parent
TextWrapPreference.parent
WMF.appliedObjectStyle
Used in:
void Button.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
void EPS.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
void FormField.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
void GraphicLine.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
void Group.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
void Image.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
ObjectStyle ObjectStyle.move (to: LocationOptions[, reference: ObjectStyle])
array of ObjectStyle ObjectStyles.itemByRange (from: any, to: any)
ObjectStyle ObjectStyles.nextItem (obj: ObjectStyle)
ObjectStyle ObjectStyles.previousItem (obj: ObjectStyle)
void Oval.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
void PDF.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
void PICT.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
void PageItem.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
void Polygon.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
void Rectangle.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
void TextFrame.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
void WMF.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
Return
ObjectStyle ObjectStyle.duplicate ()
ObjectStyle ObjectStyle.move (to: LocationOptions[, reference: ObjectStyle])
ObjectStyle ObjectStyles.add ([withProperties: Object])
ObjectStyle ObjectStyles.anyItem ()
Array of ObjectStyle ObjectStyles.everyItem ()
ObjectStyle ObjectStyles.firstItem ()
ObjectStyle ObjectStyles.item (index: any)
ObjectStyle ObjectStyles.itemByID (id: number)
ObjectStyle ObjectStyles.itemByName (name: string)
Array of ObjectStyle ObjectStyles.itemByRange (from: any, to: any)
ObjectStyle ObjectStyles.lastItem ()
ObjectStyle ObjectStyles.middleItem ()
ObjectStyle ObjectStyles.nextItem (obj: ObjectStyle)
ObjectStyle ObjectStyles.previousItem (obj: ObjectStyle)
| Jongware, 27-Jun-2010 v3.0.3d | Contents :: Index |