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. |
| contentEffectsEnablingSettings | ObjectStyleContentEffectsCategorySettings | readonly | The content effects enabling settings. |
| contentTransparencySettings | ContentTransparencySetting | readonly | Transparency settings for the content of the ObjectStyle. |
| cornerOption | 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 corner points in a path. Note: corner option differs from end join in that you can set a radius for a corner option, whereas the rounded or beveled effect of an end join depends upon the stroke weight. |
| cornerRadius | Measurement Unit (Number or String) | r/w | The radius in measurement units of the corner effect. |
| enableAnchoredObjectOptions | bool | r/w | If true, the object style will apply an anchored object setting. |
| enableFill | bool | r/w | If true, the object style will apply a fill. |
| enableFrameFittingOptions | bool | r/w | If true, the object style will apply frame fitting options. |
| 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. |
| enableStrokeAndCornerOptions | bool | r/w | If true, the object style will apply stroke options and corner options. |
| 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. |
| 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. |
| fillColor | String Swatch |
r/w | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the ObjectStyle. . Can also accept: String. |
| fillEffectsEnablingSettings | ObjectStyleFillEffectsCategorySettings | readonly | The fill effects enabling settings. |
| 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.) |
| fillTransparencySettings | FillTransparencySetting | readonly | Transparency settings for the fill applied to the ObjectStyle. |
| frameFittingOptions | FrameFittingOption | r/w | The frame fitting option to apply to placed or pasted content. Can be applied to a frame, object style, or document or to the application. |
| 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. |
| isValid | bool | readonly | Returns true if the object specifier resolves to valid objects. |
| 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 (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) |
| name | string | r/w | The name of the ObjectStyle. |
| nonprinting | bool | r/w | If true, the ObjectStyle does not print. |
| objectEffectsEnablingSettings | ObjectStyleObjectEffectsCategorySettings | readonly | The object effects enabling settings. |
| 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 ObjectStyleGroup |
readonly | The parent of the ObjectStyle (a Document, Application or ObjectStyleGroup). |
| 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. |
| 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]. |
| strokeEffectsEnablingSettings | ObjectStyleStrokeEffectsCategorySettings | readonly | The stroke effects enabling settings. |
| 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 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. |
| transparencySettings | TransparencySetting | readonly | Transparency settings. |
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 ObjectStyle 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:
any])
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 new location relative to the reference object or within the container object. |
| reference | Application Document ObjectStyle ObjectStyleGroup | The reference object. Note: Required when the to parameter is before or after. Can accept: ObjectStyle, ObjectStyleGroup, Document or Application. (Optional) |
void remove ([replacingWith:
ObjectStyle])
Deletes the style.
| Parameter | Type | Description |
|---|---|---|
| replacingWith | ObjectStyle | The style to apply in place of the deleted style. (Optional) |
string toSource ()
Generates a string which, if executed, will return the ObjectStyle.
string toSpecifier ()
Retrieves the object specifier.
Element of
AnchoredObjectDefault.anchoredObjectStyle
AnchoredObjectSetting.parent
Application.allObjectStyles
BaselineFrameGridOption.parent
Button.appliedObjectStyle
ChangeObjectPreference.appliedObjectStyles
ContentTransparencySetting.parent
Document.allObjectStyles
EPS.appliedObjectStyle
FillTransparencySetting.parent
FindObjectPreference.appliedObjectStyles
FormField.appliedObjectStyle
Graphic.appliedObjectStyle
GraphicLine.appliedObjectStyle
Group.appliedObjectStyle
Image.appliedObjectStyle
ImportedPage.appliedObjectStyle
ObjectStyle.basedOn
ObjectStyleContentEffectsCategorySettings.parent
ObjectStyleFillEffectsCategorySettings.parent
ObjectStyleGroup.allObjectStyles
ObjectStyleObjectEffectsCategorySettings.parent
ObjectStyleStrokeEffectsCategorySettings.parent
Oval.appliedObjectStyle
PDF.appliedObjectStyle
PICT.appliedObjectStyle
PageItem.appliedObjectStyle
PageItemDefault.appliedGraphicObjectStyle
PageItemDefault.appliedGridObjectStyle
PageItemDefault.appliedTextObjectStyle
Polygon.appliedObjectStyle
Rectangle.appliedObjectStyle
StoryPreference.parent
StrokeTransparencySetting.parent
TextFrame.appliedObjectStyle
TextFramePreference.parent
TextWrapPreference.parent
TransparencySetting.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 Graphic.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])
void ImportedPage.applyObjectStyle (using: ObjectStyle[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
ObjectStyle ObjectStyle.move (to: LocationOptions[, reference: any])
void ObjectStyle.remove ([replacingWith: ObjectStyle])
ObjectStyleGroup ObjectStyleGroup.move (to: LocationOptions[, reference: any])
void ObjectStyleGroup.remove ([replacingWith: 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 PageItemDefault.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])
void XMLElement.applyObjectStyle (using: any[, clearingOverrides: bool=true][, clearingOverridesThroughRootObjectStyle: bool=false])
Return
ObjectStyle ObjectStyle.duplicate ()
Array of ObjectStyle ObjectStyle.getElements ()
ObjectStyle ObjectStyle.move (to: LocationOptions[, reference: any])
ObjectStyle ObjectStyles.[] (index: number)
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, 20-Jun-2010 v3.0.3d | Contents :: Index |