Adds an event listener.
Object
ObjectStyle
An object style.
Hierarchy
Application | Document | ObjectStyleGroup
ObjectStyle
18 preference objects
AnchoredObjectSetting | BaselineFrameGridOption | ContentTransparencySetting | FillTransparencySetting | FlexLayoutAttributeOption | FrameFittingOption | ObjectExportOption | ObjectStyleContentEffectsCategorySettings | ObjectStyleFillEffectsCategorySettings | ObjectStyleObjectEffectsCategorySettings | ObjectStyleStrokeEffectsCategorySettings | Preference | StoryPreference | StrokeTransparencySetting | TextFramePreference | TextWrapPreference | TransformAttributeOption | TransparencySetting
Properties
| Name | Type | Access | Description |
|---|---|---|---|
| AnchoredObjectSetting | read/write | Anchored object settings. | |
| ParagraphStyle | String | read/write | The paragraph style applied to the text. Can also accept: String. | |
| Boolean | read/write | 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). | |
| ArrowHeadAlignmentEnum | read/write | The arrowhead alignment applied to the ObjectStyle. | |
| ObjectStyle | String | read/write | The style that this style is based on. Can return: ObjectStyle or String. | |
| BaselineFrameGridOption | read/write | Baseline frame grid option settings. | |
| CornerOptions | read/write | The shape to apply to the bottom left corner of rectangular shapes. | |
| Number | String unit | read/write | The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes | |
| CornerOptions | read/write | The shape to apply to the bottom right corner of rectangular shapes. | |
| Number | String unit | read/write | The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes | |
| ObjectStyleContentEffectsCategorySettings | readonly | The content effects enabling settings. | |
| ContentTransparencySetting | readonly | Transparency settings for the content of the ObjectStyle. | |
| Boolean | read/write | Emit CSS | |
| Boolean | read/write | If true, the object style will apply an anchored object setting. | |
| Boolean | read/write | If true, the object style will apply an epub tag and class. | |
| Boolean | read/write | If true, the object style will apply a fill. | |
| Boolean | read/write | If true, enables the flex layout attributes | |
| Boolean | read/write | If true, the object style will apply frame fitting options. | |
| Boolean | read/write | If true, the object style will apply alt text export options. | |
| Boolean | read/write | If true, the object style will apply epub export options. | |
| Boolean | read/write | If true, the object style will apply tagged pdf export options. | |
| Boolean | read/write | If true, the object style will apply a paragraph style. | |
| Boolean | read/write | If true, the object style will apply story options. | |
| Boolean | read/write | If true, the object style will apply a stroke. | |
| Boolean | read/write | If true, the object style will apply stroke options and corner options. | |
| Boolean | read/write | If true, the object style will apply auto-sizing text frame options. | |
| Boolean | read/write | If true, the object style will apply baseline text frame options. | |
| Boolean | read/write | Enable the text frame column rule options category of object style | |
| Boolean | read/write | Enable the text frame footnote options category of object style | |
| Boolean | read/write | If true, the object style will apply general text frame options. | |
| Boolean | read/write | If true, the object style will apply text wrap, contour, and non-printing settings. | |
| Boolean | read/write | If true, enables the Dimension and Position attributes | |
| EndCap | read/write | The end shape of an open path. | |
| EndJoin | read/write | The corner join applied to the ObjectStyle. | |
| String | read/write | The epub aria label as recommended by IDPF | |
| EpubAriaLabelSourceType | read/write | The source to use when generating the aria-label during EPUB export. | |
| String | read/write | The epub aria role as recommended by IDPF | |
| EventListeners |
readonly | A collection of event listeners. | |
| Events |
readonly | A collection of events. | |
| Swatch | String | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the fill of the ObjectStyle. . Can also accept: String. | |
| ObjectStyleFillEffectsCategorySettings | readonly | The fill effects enabling settings. | |
| Number 0–100 | read/write | 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.) | |
| FillTransparencySetting | readonly | Transparency settings for the fill applied to the ObjectStyle. | |
| FlexLayoutAttributeOption | read/write | The flex layout attribute options to apply to any flex object. | |
| FrameFittingOption | read/write | 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. | |
| Swatch | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type. | |
| Number 0–100 | read/write | 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.) | |
| Number | read/write | The angle of a linear gradient applied to the fill of the ObjectStyle. (Range: -180 to 180) | |
| Number | read/write | The angle of a linear gradient applied to the stroke of the ObjectStyle. (Range: -180 to 180) | |
| Number | readonly | The unique ID of the ObjectStyle. | |
| Boolean | read/write | If true, class attribute will be generated for the style | |
| Number | readonly | The index of the ObjectStyle within its containing object. | |
| Boolean | readonly | Returns true if the object specifier resolves to valid objects. | |
| String | read/write | A property that can be set to any string. | |
| Number 1–1000 | read/write | The scaling applied to the arrowhead at the start of the path. (Range: 1 to 1000) | |
| ArrowHead | read/write | The arrowhead applied to the start of the path. | |
| Number = 4 1–500 | read/write | The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. | |
| String | read/write | The name of the ObjectStyle. | |
| Boolean | read/write | If true, the ObjectStyle does not print. | |
| ObjectStyleObjectEffectsCategorySettings | readonly | The object effects enabling settings. | |
| ObjectExportOption | readonly | Export options for the object | |
| ObjectStyleExportTagMaps |
readonly | A collection of object style export tag maps. | |
| Boolean | read/write | If true, the ObjectStyle's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors. | |
| Boolean | read/write | If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors. | |
| Boolean | read/write | If true, the ObjectStyle's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors. | |
| Application | Document | ObjectStyleGroup | readonly | The parent of the ObjectStyle (a Document, Application or ObjectStyleGroup). | |
| Preferences |
readonly | A collection of preferences objects. | |
| Object | read/write | A property that allows setting of several properties at the same time. | |
| Number 1–1000 | read/write | The scaling applied to the arrowhead at the end of the path. (Range: 1 to 1000) | |
| ArrowHead | read/write | The arrowhead applied to the end of the path. | |
| StoryPreference | read/write | Story preference settings. | |
| StrokeAlignment | read/write | The stroke alignment applied to the ObjectStyle. | |
| Swatch | String | read/write | The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the ObjectStyle. Can also accept: String. | |
| ObjectStyleStrokeEffectsCategorySettings | readonly | The stroke effects enabling settings. | |
| Number 0–100 | read/write | 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.) | |
| StrokeTransparencySetting | readonly | Transparency settings for the stroke. | |
| StrokeStyle | String | read/write | The name of the stroke style to apply. Can also accept: String. | |
| Number | String unit | read/write | The weight (in points) to apply to the ObjectStyle's stroke. | |
| TextFramePreference | read/write | Text frame preference settings. | |
| TextWrapPreference | read/write | The text wrap preference properties that define the default formatting for wrapping text around objects. | |
| CornerOptions | read/write | 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. | |
| Number | String unit | read/write | 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 | |
| CornerOptions | read/write | The shape to apply to the top right corner of rectangular shapes | |
| Number | String unit | read/write | The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes | |
| TransformAttributeOption | read/write | The layout attribute options to apply to any page item. | |
| TransparencySetting | readonly | Transparency settings. |
Methods
Duplicates the ObjectStyle.
→ String
Gets the label value associated with the specified key.
→ ObjectStyle[]
Resolves the object specifier, creating an array of object references.
→ void
Sets the label to the value associated with the specified key.
Moves the ObjectStyle to the specified location.
to
LocationOptions
The new location relative to the reference object or within the container object.
reference?
Document | ObjectStyle | ObjectStyleGroup | Application
The reference object. Note: Required when the to parameter is before or after. Can accept: ObjectStyle, ObjectStyleGroup, Document or Application.
→ void
Deletes the style.
→ Boolean
Removes the event listener.
→ Boolean
Sets the given dimension attribute state to enabled or disabled state
attributeState
Boolean
Attribute state to be set, set true to enable and false to disable the attributes
→ Boolean
Sets the given position attribute state to enabled or disabled state
attributeState
Boolean
Attribute state to be set, set true to enable and false to disable the attributes
→ String
Generates a string which, if executed, will return the ObjectStyle.
→ String
Retrieves the object specifier.
Object of 64
Properties elsewhere that hold a ObjectStyle.
AnchoredObjectDefault.anchoredObjectStyleAnchoredObjectSetting.parentApplication.allObjectStylesBaselineFrameGridOption.parentButton.appliedObjectStyleChangeObjectPreference.appliedObjectStylesCheckBox.appliedObjectStyleComboBox.appliedObjectStyleContentTransparencySetting.parentDocument.allObjectStylesEPS.appliedObjectStyleEPSText.appliedObjectStyleEndnoteTextFrame.appliedObjectStyleEvent.parentEventListener.parentFillTransparencySetting.parentFindObjectPreference.appliedObjectStylesFlexLayoutAttributeOption.parentFlexObject.appliedObjectStyleFormField.appliedObjectStyleFrameFittingOption.parentGraphic.appliedObjectStyleGraphicLine.appliedObjectStyleGroup.appliedObjectStyleHtmlItem.appliedObjectStyleImage.appliedObjectStyleImportedPage.appliedObjectStyleListBox.appliedObjectStyleMediaItem.appliedObjectStyleMovie.appliedObjectStyleMultiStateObject.appliedObjectStyleMutationEvent.parentObjectExportOption.parentObjectStyle.basedOnObjectStyleContentEffectsCategorySettings.parentObjectStyleExportTagMap.parentObjectStyleFillEffectsCategorySettings.parentObjectStyleGroup.allObjectStylesObjectStyleObjectEffectsCategorySettings.parentObjectStyleStrokeEffectsCategorySettings.parentOval.appliedObjectStylePDF.appliedObjectStylePICT.appliedObjectStylePageItem.appliedObjectStylePageItemDefault.appliedGraphicObjectStylePageItemDefault.appliedGridObjectStylePageItemDefault.appliedTextObjectStylePolygon.appliedObjectStylePreference.parentRadioButton.appliedObjectStyleRectangle.appliedObjectStyleSVG.appliedObjectStyleSignatureField.appliedObjectStyleSound.appliedObjectStyleSplineItem.appliedObjectStyleStoryPreference.parentStrokeTransparencySetting.parentTextBox.appliedObjectStyleTextFrame.appliedObjectStyleTextFramePreference.parentTextWrapPreference.parentTransformAttributeOption.parentTransparencySetting.parentWMF.appliedObjectStyle
Parameter of 41
Method parameters that accept a ObjectStyle.
Button.applyObjectStyle(using)CheckBox.applyObjectStyle(using)ComboBox.applyObjectStyle(using)EPS.applyObjectStyle(using)EPSText.applyObjectStyle(using)EndnoteTextFrame.applyObjectStyle(using)FlexObject.applyObjectStyle(using)FormField.applyObjectStyle(using)Graphic.applyObjectStyle(using)GraphicLine.applyObjectStyle(using)Group.applyObjectStyle(using)HtmlItem.applyObjectStyle(using)Image.applyObjectStyle(using)ImportedPage.applyObjectStyle(using)ListBox.applyObjectStyle(using)MediaItem.applyObjectStyle(using)Movie.applyObjectStyle(using)MultiStateObject.applyObjectStyle(using)ObjectStyle.move(reference)ObjectStyle.remove(replacingWith)ObjectStyleGroup.move(reference)ObjectStyleGroup.remove(replacingWith)ObjectStyles.itemByRange(from)ObjectStyles.nextItem(obj)ObjectStyles.previousItem(obj)Oval.applyObjectStyle(using)PDF.applyObjectStyle(using)PICT.applyObjectStyle(using)PageItem.applyObjectStyle(using)PageItemDefault.applyObjectStyle(using)Polygon.applyObjectStyle(using)RadioButton.applyObjectStyle(using)Rectangle.applyObjectStyle(using)SVG.applyObjectStyle(using)SignatureField.applyObjectStyle(using)Sound.applyObjectStyle(using)SplineItem.applyObjectStyle(using)TextBox.applyObjectStyle(using)TextFrame.applyObjectStyle(using)WMF.applyObjectStyle(using)XMLElement.applyObjectStyle(using)
Return 16
Methods that return a ObjectStyle.
ObjectStyle.duplicate()ObjectStyle.getElements()ObjectStyle.move()ObjectStyles.[]()ObjectStyles.add()ObjectStyles.anyItem()ObjectStyles.everyItem()ObjectStyles.firstItem()ObjectStyles.item()ObjectStyles.itemByID()ObjectStyles.itemByName()ObjectStyles.itemByRange()ObjectStyles.lastItem()ObjectStyles.middleItem()ObjectStyles.nextItem()ObjectStyles.previousItem()