Package | com.adobe.indesign |
Class | public class ObjectStyle |
Inheritance | ObjectStyle ![]() ![]() |
Since : | CS5 |
Property | Defined By | ||
---|---|---|---|
anchoredObjectSettings : AnchoredObjectSetting
Anchored object settings. | ObjectStyle | ||
appliedParagraphStyle : ParagraphStyle
The paragraph style applied to the text. | ObjectStyle | ||
applyNextParagraphStyle : Boolean
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). | ObjectStyle | ||
basedOn : Object
The style that this style is based on. | ObjectStyle | ||
baselineFrameGridOptions : BaselineFrameGridOption
Baseline frame grid option settings. | ObjectStyle | ||
bottomLeftCornerOption : CornerOptions
The shape to apply to the bottom left corner of rectangular shapes. | ObjectStyle | ||
bottomLeftCornerRadius : Object
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
| ObjectStyle | ||
bottomRightCornerOption : CornerOptions
The shape to apply to the bottom right corner of rectangular shapes. | ObjectStyle | ||
bottomRightCornerRadius : Object
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
| ObjectStyle | ||
contentEffectsEnablingSettings : ObjectStyleContentEffectsCategorySettings [read-only]
The content effects enabling settings. | ObjectStyle | ||
contentTransparencySettings : ContentTransparencySetting [read-only]
Transparency settings for the content of the ObjectStyle. | ObjectStyle | ||
enableAnchoredObjectOptions : Boolean
If true, the object style will apply an anchored object setting. | ObjectStyle | ||
enableFill : Boolean
If true, the object style will apply a fill. | ObjectStyle | ||
enableFrameFittingOptions : Boolean
If true, the object style will apply frame fitting options. | ObjectStyle | ||
enableParagraphStyle : Boolean
If true, the object style will apply a paragraph style. | ObjectStyle | ||
enableStoryOptions : Boolean
If true, the object style will apply story options. | ObjectStyle | ||
enableStroke : Boolean
If true, the object style will apply a stroke. | ObjectStyle | ||
enableStrokeAndCornerOptions : Boolean
If true, the object style will apply stroke options and corner options. | ObjectStyle | ||
enableTextFrameBaselineOptions : Boolean
If true, the object style will apply baseline text frame options. | ObjectStyle | ||
enableTextFrameGeneralOptions : Boolean
If true, the object style will apply general text frame options. | ObjectStyle | ||
enableTextWrapAndOthers : Boolean
If true, the object style will apply text wrap, contour, and non-printing settings. | ObjectStyle | ||
endCap : EndCap
The end shape of an open path. | ObjectStyle | ||
endJoin : EndJoin
The corner join applied to the ObjectStyle. | ObjectStyle | ||
eventListeners : EventListeners [read-only]
A collection of event listeners. | ObjectStyle | ||
events : Events [read-only]
A collection of events. | ObjectStyle | ||
fillColor : Swatch
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the ObjectStyle. | ObjectStyle | ||
fillEffectsEnablingSettings : ObjectStyleFillEffectsCategorySettings [read-only]
The fill effects enabling settings. | ObjectStyle | ||
fillTint : Number
The percent of tint to use in the ObjectStyle's fill color. | ObjectStyle | ||
fillTransparencySettings : FillTransparencySetting [read-only]
Transparency settings for the fill applied to the ObjectStyle. | ObjectStyle | ||
frameFittingOptions : FrameFittingOption
The frame fitting option to apply to placed or pasted content. | ObjectStyle | ||
gapColor : Swatch
The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. | ObjectStyle | ||
gapTint : Number
The tint as a percentage of the gap color. | ObjectStyle | ||
gradientFillAngle : Number
The angle of a linear gradient applied to the fill of the ObjectStyle. | ObjectStyle | ||
gradientStrokeAngle : Number
The angle of a linear gradient applied to the stroke of the ObjectStyle. | ObjectStyle | ||
![]() | hostObjectDelegate : HostObject Getter for the delegate | CSHostObject | |
id : Number [read-only]
The unique ID of the ObjectStyle. | ObjectStyle | ||
index : Number [read-only]
The index of the ObjectStyle within its containing object. | ObjectStyle | ||
isValid : Boolean [read-only]
Returns true if the object specifier resolves to valid objects. | ObjectStyle | ||
label : String
A property that can be set to any string. | ObjectStyle | ||
leftLineEnd : ArrowHead
The arrowhead applied to the start of the path. | ObjectStyle | ||
miterLimit : Number
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join. | ObjectStyle | ||
name : String
The name of the ObjectStyle. | ObjectStyle | ||
nonprinting : Boolean
If true, the ObjectStyle does not print. | ObjectStyle | ||
objectEffectsEnablingSettings : ObjectStyleObjectEffectsCategorySettings [read-only]
The object effects enabling settings. | ObjectStyle | ||
overprintFill : Boolean
If true, the ObjectStyle's fill color overprints any underlying objects. | ObjectStyle | ||
overprintGap : Boolean
If true, the gap color overprints any underlying colors. | ObjectStyle | ||
overprintStroke : Boolean
If true, the ObjectStyle's stroke color overprints any underlying objects. | ObjectStyle | ||
parent : Object [read-only]
The parent of the ObjectStyle (a Document, Application or ObjectStyleGroup). | ObjectStyle | ||
preferences : Preferences [read-only]
A collection of preferences objects. | ObjectStyle | ||
properties : Object
A property that allows setting of several properties at the same time. | ObjectStyle | ||
rightLineEnd : ArrowHead
The arrowhead applied to the end of the path. | ObjectStyle | ||
storyPreferences : StoryPreference
Story preference settings. | ObjectStyle | ||
strokeAlignment : StrokeAlignment
The stroke alignment applied to the ObjectStyle. | ObjectStyle | ||
strokeColor : Swatch
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the ObjectStyle. | ObjectStyle | ||
strokeEffectsEnablingSettings : ObjectStyleStrokeEffectsCategorySettings [read-only]
The stroke effects enabling settings. | ObjectStyle | ||
strokeTint : Number
The percent of tint to use in object's stroke color. | ObjectStyle | ||
strokeTransparencySettings : StrokeTransparencySetting [read-only]
Transparency settings for the stroke. | ObjectStyle | ||
strokeType : StrokeStyle
The name of the stroke style to apply. | ObjectStyle | ||
strokeWeight : Object
The weight (in points) to apply to the ObjectStyle's stroke. | ObjectStyle | ||
textFramePreferences : TextFramePreference
Text frame preference settings. | ObjectStyle | ||
textWrapPreferences : TextWrapPreference
The text wrap preference properties that define the default formatting for wrapping text around objects. | ObjectStyle | ||
topLeftCornerOption : CornerOptions
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. | ObjectStyle | ||
topLeftCornerRadius : Object
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
| ObjectStyle | ||
topRightCornerOption : CornerOptions
The shape to apply to the top right corner of rectangular shapes
| ObjectStyle | ||
topRightCornerRadius : Object
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
| ObjectStyle | ||
transparencySettings : TransparencySetting [read-only]
Transparency settings. | ObjectStyle |
Method | Defined By | ||
---|---|---|---|
addEventListenerObjectStyle(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Adds an event listener. | ObjectStyle | ||
Duplicates the ObjectStyle. | ObjectStyle | ||
extractLabel(keyParam:String = null):String
Gets the label value associated with the specified key. | ObjectStyle | ||
![]() | filterArgsForHBAPI(args:Array):Array [static]
Function to clean up the argument list and put it into a format that
makes sense for HBAPI. | CSHostObject | |
![]() | filterSingleObjectForHBAPI(value:Object):Object [static]
| CSHostObject | |
![]() | getClassObjectForName(className:String):HostObject [static] This returns a "Class" object, meaning, a HostObject that can be used
to make static function calls or get static properties
| CSHostObject | |
getElements():Object
Resolves the object specifier, creating an array of object references. | ObjectStyle | ||
![]() | getSpecialTranslation(className:String, ho:HostObject, expectedReturnType:Class, ownerName:String):* [static] | CSHostObject | |
![]() | hostCall(name:String, expectedReturnType:Class, rawargs:Array):*
Encapsulates a function call to the host
| CSHostObject | |
![]() | hostCallStatic(className:String, methodName:String, expectedReturnType:Class, rawargs:Array):* [static]
Implements a safe call of a static method on the host
| CSHostObject | |
![]() | hostGet(name:String, expectedReturnType:Class):*
Encapsulates a property get to the host
| CSHostObject | |
![]() | hostGetIndex(idx:Object, expectedReturnType:Class):*
Encapsulates a indexed get to the host
| CSHostObject | |
![]() | hostGetStatic(className:String, propertyName:String, expectedReturnType:Class):* [static]
Implements a safe get of a static property on the host
Used by for instance, all the enum implementations. | CSHostObject | |
![]() | hostSet(name:String, rawvalue:*):void
Encapsulates a property set to the host
| CSHostObject | |
![]() | hostSetStatic(className:String, propertyName:String, rawvalue:*):* [static]
Implements a safe set of a static property on the host
| CSHostObject | |
insertLabel(keyParam:String = null, valueParam:String = null):void
Sets the label to the value associated with the specified key. | ObjectStyle | ||
![]() | isDescendedFrom(clz:Class, ancClass:Class):Boolean [static] Efficiently determines whether or not one class descends from
another in inheritance hierarchy- class relationships are cached
by the ClassUtils implementation-
(uses org.as3commons lib to quickly discover class hierarchy. | CSHostObject | |
Moves the ObjectStyle to the specified location. | ObjectStyle | ||
remove(replacingWithParam:ObjectStyle = null):void
Deletes the style. | ObjectStyle | ||
removeEventListenerObjectStyle(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Removes the event listener. | ObjectStyle | ||
![]() | replaceDefaultArgs(args:Array, defaultArgs:Array):Array
Function to tidy up arguments prior to call. | CSHostObject | |
toSpecifier():String
Retrieves the object specifier. | ObjectStyle | ||
![]() | wrapReturnedHostObject(rawObject:Object, expectedReturnType:Class, client:CSHostObject, propertyName:String):* [static]
Method used on static/normal get/ hostcalls
| CSHostObject |
anchoredObjectSettings | property |
anchoredObjectSettings:AnchoredObjectSetting
Since : | CS5 |
Anchored object settings.
public function get anchoredObjectSettings():AnchoredObjectSetting
public function set anchoredObjectSettings(value:AnchoredObjectSetting):void
appliedParagraphStyle | property |
appliedParagraphStyle:ParagraphStyle
Since : | CS5 |
The paragraph style applied to the text. Can also accept: String.
public function get appliedParagraphStyle():ParagraphStyle
public function set appliedParagraphStyle(value:ParagraphStyle):void
applyNextParagraphStyle | property |
applyNextParagraphStyle:Boolean
Since : | CS5 |
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).
public function get applyNextParagraphStyle():Boolean
public function set applyNextParagraphStyle(value:Boolean):void
basedOn | property |
basedOn:Object
Since : | CS5 |
The style that this style is based on. Can return: ObjectStyle or String.
public function get basedOn():Object
public function set basedOn(value:Object):void
baselineFrameGridOptions | property |
baselineFrameGridOptions:BaselineFrameGridOption
Since : | CS5 |
Baseline frame grid option settings.
public function get baselineFrameGridOptions():BaselineFrameGridOption
public function set baselineFrameGridOptions(value:BaselineFrameGridOption):void
bottomLeftCornerOption | property |
bottomLeftCornerOption:CornerOptions
Since : | CS5 |
The shape to apply to the bottom left corner of rectangular shapes.
public function get bottomLeftCornerOption():CornerOptions
public function set bottomLeftCornerOption(value:CornerOptions):void
bottomLeftCornerRadius | property |
bottomLeftCornerRadius:Object
Since : | CS5 |
The radius in measurement units of the corner effect applied to the bottom left corner of rectangular shapes
public function get bottomLeftCornerRadius():Object
public function set bottomLeftCornerRadius(value:Object):void
bottomRightCornerOption | property |
bottomRightCornerOption:CornerOptions
Since : | CS5 |
The shape to apply to the bottom right corner of rectangular shapes.
public function get bottomRightCornerOption():CornerOptions
public function set bottomRightCornerOption(value:CornerOptions):void
bottomRightCornerRadius | property |
bottomRightCornerRadius:Object
Since : | CS5 |
The radius in measurement units of the corner effect applied to the bottom right corner of rectangular shapes
public function get bottomRightCornerRadius():Object
public function set bottomRightCornerRadius(value:Object):void
contentEffectsEnablingSettings | property |
contentEffectsEnablingSettings:ObjectStyleContentEffectsCategorySettings
[read-only] Since : | CS5 |
The content effects enabling settings.
public function get contentEffectsEnablingSettings():ObjectStyleContentEffectsCategorySettings
contentTransparencySettings | property |
contentTransparencySettings:ContentTransparencySetting
[read-only] Since : | CS5 |
Transparency settings for the content of the ObjectStyle.
public function get contentTransparencySettings():ContentTransparencySetting
enableAnchoredObjectOptions | property |
enableAnchoredObjectOptions:Boolean
Since : | CS5 |
If true, the object style will apply an anchored object setting.
public function get enableAnchoredObjectOptions():Boolean
public function set enableAnchoredObjectOptions(value:Boolean):void
enableFill | property |
enableFill:Boolean
Since : | CS5 |
If true, the object style will apply a fill.
public function get enableFill():Boolean
public function set enableFill(value:Boolean):void
enableFrameFittingOptions | property |
enableFrameFittingOptions:Boolean
Since : | CS5 |
If true, the object style will apply frame fitting options.
public function get enableFrameFittingOptions():Boolean
public function set enableFrameFittingOptions(value:Boolean):void
enableParagraphStyle | property |
enableParagraphStyle:Boolean
Since : | CS5 |
If true, the object style will apply a paragraph style.
public function get enableParagraphStyle():Boolean
public function set enableParagraphStyle(value:Boolean):void
enableStoryOptions | property |
enableStoryOptions:Boolean
Since : | CS5 |
If true, the object style will apply story options.
public function get enableStoryOptions():Boolean
public function set enableStoryOptions(value:Boolean):void
enableStroke | property |
enableStroke:Boolean
Since : | CS5 |
If true, the object style will apply a stroke.
public function get enableStroke():Boolean
public function set enableStroke(value:Boolean):void
enableStrokeAndCornerOptions | property |
enableStrokeAndCornerOptions:Boolean
Since : | CS5 |
If true, the object style will apply stroke options and corner options.
public function get enableStrokeAndCornerOptions():Boolean
public function set enableStrokeAndCornerOptions(value:Boolean):void
enableTextFrameBaselineOptions | property |
enableTextFrameBaselineOptions:Boolean
Since : | CS5 |
If true, the object style will apply baseline text frame options.
public function get enableTextFrameBaselineOptions():Boolean
public function set enableTextFrameBaselineOptions(value:Boolean):void
enableTextFrameGeneralOptions | property |
enableTextFrameGeneralOptions:Boolean
Since : | CS5 |
If true, the object style will apply general text frame options.
public function get enableTextFrameGeneralOptions():Boolean
public function set enableTextFrameGeneralOptions(value:Boolean):void
enableTextWrapAndOthers | property |
enableTextWrapAndOthers:Boolean
Since : | CS5 |
If true, the object style will apply text wrap, contour, and non-printing settings.
public function get enableTextWrapAndOthers():Boolean
public function set enableTextWrapAndOthers(value:Boolean):void
endCap | property |
endCap:EndCap
Since : | CS5 |
The end shape of an open path.
public function get endCap():EndCap
public function set endCap(value:EndCap):void
endJoin | property |
endJoin:EndJoin
Since : | CS5 |
The corner join applied to the ObjectStyle.
public function get endJoin():EndJoin
public function set endJoin(value:EndJoin):void
eventListeners | property |
eventListeners:EventListeners
[read-only] Since : | CS5 |
A collection of event listeners.
public function get eventListeners():EventListeners
events | property |
events:Events
[read-only] Since : | CS5 |
A collection of events.
public function get events():Events
fillColor | property |
fillColor:Swatch
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the fill of the ObjectStyle. . Can also accept: String.
public function get fillColor():Swatch
public function set fillColor(value:Swatch):void
fillEffectsEnablingSettings | property |
fillEffectsEnablingSettings:ObjectStyleFillEffectsCategorySettings
[read-only] Since : | CS5 |
The fill effects enabling settings.
public function get fillEffectsEnablingSettings():ObjectStyleFillEffectsCategorySettings
fillTint | property |
fillTint:Number
Since : | CS5 |
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.)
public function get fillTint():Number
public function set fillTint(value:Number):void
fillTransparencySettings | property |
fillTransparencySettings:FillTransparencySetting
[read-only] Since : | CS5 |
Transparency settings for the fill applied to the ObjectStyle.
public function get fillTransparencySettings():FillTransparencySetting
frameFittingOptions | property |
frameFittingOptions:FrameFittingOption
Since : | CS5 |
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.
public function get frameFittingOptions():FrameFittingOption
public function set frameFittingOptions(value:FrameFittingOption):void
gapColor | property |
gapColor:Swatch
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the gap of a dashed, dotted, or striped stroke. For information, see stroke type.
public function get gapColor():Swatch
public function set gapColor(value:Swatch):void
gapTint | property |
gapTint:Number
Since : | CS5 |
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.)
public function get gapTint():Number
public function set gapTint(value:Number):void
gradientFillAngle | property |
gradientFillAngle:Number
Since : | CS5 |
The angle of a linear gradient applied to the fill of the ObjectStyle. (Range: -180 to 180)
public function get gradientFillAngle():Number
public function set gradientFillAngle(value:Number):void
gradientStrokeAngle | property |
gradientStrokeAngle:Number
Since : | CS5 |
The angle of a linear gradient applied to the stroke of the ObjectStyle. (Range: -180 to 180)
public function get gradientStrokeAngle():Number
public function set gradientStrokeAngle(value:Number):void
id | property |
id:Number
[read-only] Since : | CS5 |
The unique ID of the ObjectStyle.
public function get id():Number
index | property |
index:Number
[read-only] Since : | CS5 |
The index of the ObjectStyle within its containing object.
public function get index():Number
isValid | property |
isValid:Boolean
[read-only] Since : | CS5 |
Returns true if the object specifier resolves to valid objects.
public function get isValid():Boolean
label | property |
label:String
Since : | CS5 |
A property that can be set to any string.
public function get label():String
public function set label(value:String):void
leftLineEnd | property |
leftLineEnd:ArrowHead
Since : | CS5 |
The arrowhead applied to the start of the path.
public function get leftLineEnd():ArrowHead
public function set leftLineEnd(value:ArrowHead):void
miterLimit | property |
miterLimit:Number
Since : | CS5 |
The limit of the ratio of stroke width to miter length before a miter (pointed) join becomes a bevel (squared-off) join.
public function get miterLimit():Number
public function set miterLimit(value:Number):void
name | property |
name:String
Since : | CS5 |
The name of the ObjectStyle.
public function get name():String
public function set name(value:String):void
nonprinting | property |
nonprinting:Boolean
Since : | CS5 |
If true, the ObjectStyle does not print.
public function get nonprinting():Boolean
public function set nonprinting(value:Boolean):void
objectEffectsEnablingSettings | property |
objectEffectsEnablingSettings:ObjectStyleObjectEffectsCategorySettings
[read-only] Since : | CS5 |
The object effects enabling settings.
public function get objectEffectsEnablingSettings():ObjectStyleObjectEffectsCategorySettings
overprintFill | property |
overprintFill:Boolean
Since : | CS5 |
If true, the ObjectStyle's fill color overprints any underlying objects. If false, the fill color knocks out the underlying colors.
public function get overprintFill():Boolean
public function set overprintFill(value:Boolean):void
overprintGap | property |
overprintGap:Boolean
Since : | CS5 |
If true, the gap color overprints any underlying colors. If false, the gap color knocks out the underlying colors.
public function get overprintGap():Boolean
public function set overprintGap(value:Boolean):void
overprintStroke | property |
overprintStroke:Boolean
Since : | CS5 |
If true, the ObjectStyle's stroke color overprints any underlying objects. If false, the stroke color knocks out the underlying colors.
public function get overprintStroke():Boolean
public function set overprintStroke(value:Boolean):void
parent | property |
parent:Object
[read-only] Since : | CS5 |
The parent of the ObjectStyle (a Document, Application or ObjectStyleGroup).
public function get parent():Object
preferences | property |
preferences:Preferences
[read-only] Since : | CS5 |
A collection of preferences objects.
public function get preferences():Preferences
properties | property |
properties:Object
Since : | CS5 |
A property that allows setting of several properties at the same time.
public function get properties():Object
public function set properties(value:Object):void
rightLineEnd | property |
rightLineEnd:ArrowHead
Since : | CS5 |
The arrowhead applied to the end of the path.
public function get rightLineEnd():ArrowHead
public function set rightLineEnd(value:ArrowHead):void
storyPreferences | property |
storyPreferences:StoryPreference
Since : | CS5 |
Story preference settings.
public function get storyPreferences():StoryPreference
public function set storyPreferences(value:StoryPreference):void
strokeAlignment | property |
strokeAlignment:StrokeAlignment
Since : | CS5 |
The stroke alignment applied to the ObjectStyle.
public function get strokeAlignment():StrokeAlignment
public function set strokeAlignment(value:StrokeAlignment):void
strokeColor | property |
strokeColor:Swatch
Since : | CS5 |
The swatch (color, gradient, tint, or mixed ink) applied to the stroke of the ObjectStyle. Can also accept: String.
public function get strokeColor():Swatch
public function set strokeColor(value:Swatch):void
strokeEffectsEnablingSettings | property |
strokeEffectsEnablingSettings:ObjectStyleStrokeEffectsCategorySettings
[read-only] Since : | CS5 |
The stroke effects enabling settings.
public function get strokeEffectsEnablingSettings():ObjectStyleStrokeEffectsCategorySettings
strokeTint | property |
strokeTint:Number
Since : | CS5 |
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.)
public function get strokeTint():Number
public function set strokeTint(value:Number):void
strokeTransparencySettings | property |
strokeTransparencySettings:StrokeTransparencySetting
[read-only] Since : | CS5 |
Transparency settings for the stroke.
public function get strokeTransparencySettings():StrokeTransparencySetting
strokeType | property |
strokeType:StrokeStyle
Since : | CS5 |
The name of the stroke style to apply. Can also accept: String.
public function get strokeType():StrokeStyle
public function set strokeType(value:StrokeStyle):void
strokeWeight | property |
strokeWeight:Object
Since : | CS5 |
The weight (in points) to apply to the ObjectStyle's stroke.
public function get strokeWeight():Object
public function set strokeWeight(value:Object):void
textFramePreferences | property |
textFramePreferences:TextFramePreference
Since : | CS5 |
Text frame preference settings.
public function get textFramePreferences():TextFramePreference
public function set textFramePreferences(value:TextFramePreference):void
textWrapPreferences | property |
textWrapPreferences:TextWrapPreference
Since : | CS5 |
The text wrap preference properties that define the default formatting for wrapping text around objects.
public function get textWrapPreferences():TextWrapPreference
public function set textWrapPreferences(value:TextWrapPreference):void
topLeftCornerOption | property |
topLeftCornerOption:CornerOptions
Since : | CS5 |
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.
public function get topLeftCornerOption():CornerOptions
public function set topLeftCornerOption(value:CornerOptions):void
topLeftCornerRadius | property |
topLeftCornerRadius:Object
Since : | CS5 |
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
public function get topLeftCornerRadius():Object
public function set topLeftCornerRadius(value:Object):void
topRightCornerOption | property |
topRightCornerOption:CornerOptions
Since : | CS5 |
The shape to apply to the top right corner of rectangular shapes
public function get topRightCornerOption():CornerOptions
public function set topRightCornerOption(value:CornerOptions):void
topRightCornerRadius | property |
topRightCornerRadius:Object
Since : | CS5 |
The radius in measurement units of the corner effect applied to the top right corner of rectangular shapes
public function get topRightCornerRadius():Object
public function set topRightCornerRadius(value:Object):void
transparencySettings | property |
transparencySettings:TransparencySetting
[read-only] Since : | CS5 |
Transparency settings.
public function get transparencySettings():TransparencySetting
addEventListenerObjectStyle | () | method |
public function addEventListenerObjectStyle(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):EventListener
Since : | CS5 |
Adds an event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The event type.
| |
handlerParam:Object (default = null ) — (Object) The event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
EventListener |
duplicate | () | method |
extractLabel | () | method |
public function extractLabel(keyParam:String = null):String
Since : | CS5 |
Gets the label value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
|
String |
getElements | () | method |
public function getElements():Object
Since : | CS5 |
Resolves the object specifier, creating an array of object references.
ReturnsObject |
insertLabel | () | method |
public function insertLabel(keyParam:String = null, valueParam:String = null):void
Since : | CS5 |
Sets the label to the value associated with the specified key.
Parameters
keyParam:String (default = null ) — (String) The key.
| |
valueParam:String (default = null ) — (String) The value.
|
move | () | method |
public function move(toParam:LocationOptions = null, referenceParam:Object = null):ObjectStyle
Since : | CS5 |
Moves the ObjectStyle to the specified location.
Parameters
toParam:LocationOptions (default = null ) — (LocationOptions) The new location relative to the reference object or within the container object.
| |
referenceParam:Object (default = null ) — (Object) The reference object. Note: Required when the to parameter is before or after. Can accept: ObjectStyle, ObjectStyleGroup, Document or Application. (Optional)
|
ObjectStyle |
remove | () | method |
public function remove(replacingWithParam:ObjectStyle = null):void
Since : | CS5 |
Deletes the style.
Parameters
replacingWithParam:ObjectStyle (default = null ) — (ObjectStyle) The style to apply in place of the deleted style. (Optional)
|
removeEventListenerObjectStyle | () | method |
public function removeEventListenerObjectStyle(eventTypeParam:String = null, handlerParam:Object = null, capturesParam:Boolean = false):Boolean
Since : | CS5 |
Removes the event listener.
Parameters
eventTypeParam:String (default = null ) — (String) The registered event type.
| |
handlerParam:Object (default = null ) — (Object) The registered event handler. Can accept: File or JavaScript Function.
| |
capturesParam:Boolean (default = false ) — (Boolean) This parameter is obsolete. (Optional)
|
Boolean |
toSpecifier | () | method |
public function toSpecifier():String
Since : | CS5 |
Retrieves the object specifier.
ReturnsString |