SmartShape object

The following table lists the properties of the SmartShape object, along with their data types and, where appropriate, acceptable values and notes. Read-only properties are marked with a bullet (•).

Property	Data type	Notes
`altOptKeyDown` •	Boolean	Indicates whether the Alt/Option key is pressed (`true` if pressed, otherwise `false`).
`constrainDragInsertAspect`	Boolean	Determines if, while dragging a shape on the canvas, the aspect ratio is constrained (`true` if constrained, otherwise `false`).
`constrainDragInsertAspectKey`	string	The key value that will cause the aspect ratio to be constrained during a `DragInsert` operation.
`ctrlCmdKeyDown` •	Boolean	Indicates whether the Control/Command key is pressed (`true` if pressed, otherwise `false`).
`currentControlPoint` •	object	Returns the current control point object.
`currentControlPointIndex` •	integer	Returns the index number of the current control point.
`currentControlPointName` •	string	Returns the name of the current control point.
`currentMousePos`	point	Location of the mouse during the current drag message.
`elem` •	object	Objects defined as part of the current Auto Shape.
`getsDragEvents`	Boolean	Sets notification for drag events (`true` notifies the smartshape for every mouse movement, `false` sets no notification).
`livePreview`	Boolean	Sets live preview. A value of `true` enables live preview, and disables wire-frame preview handled by Fireworks. Live preview is slower than wire-frame preview. If you want the user to set this value, write a function handling the DragControlPoint message from Fireworks (see Fireworks messages.
`mouseDownPos` •	point	Location of the mouse during a mouse click.
`operation` •	string	Message received from Fireworks, see Fireworks messages for possible messages.
`prevMousePos` •	point	Location of the mouse at the previous drag message.
`shiftKeyDown` •	Boolean	Indicates whether the Shift key is pressed.

Property

Data type

Notes

altOptKeyDown •

Boolean

Indicates whether the Alt/Option key is pressed (true if pressed, otherwise false).

constrainDragInsertAspect

Boolean

Determines if, while dragging a shape on the canvas, the aspect ratio is constrained (true if constrained, otherwise false).

constrainDragInsertAspectKey

string

The key value that will cause the aspect ratio to be constrained during a DragInsert operation.

ctrlCmdKeyDown •

Boolean

Indicates whether the Control/Command key is pressed (true if pressed, otherwise false).

currentControlPoint •

object

Returns the current control point object.

currentControlPointIndex •

integer

Returns the index number of the current control point.

currentControlPointName •

string

Returns the name of the current control point.

currentMousePos

point

Location of the mouse during the current drag message.

elem •

object

Objects defined as part of the current Auto Shape.

getsDragEvents

Boolean

Sets notification for drag events (true notifies the smartshape for every mouse movement, false sets no notification).

livePreview

Boolean

Sets live preview. A value of true enables live preview, and disables wire-frame preview handled by Fireworks. Live preview is slower than wire-frame preview.

If you want the user to set this value, write a function handling the DragControlPoint message from Fireworks (see Fireworks messages.

mouseDownPos •

point

Location of the mouse during a mouse click.

operation •

string

Message received from Fireworks, see Fireworks messages for possible messages.

prevMousePos •

point

Location of the mouse at the previous drag message.

shiftKeyDown •

Boolean

Indicates whether the Shift key is pressed.

The following table lists the method of the SmartShape object, along with its parameter.

Method	Parameter	Definition
`GetDefaultMoveParms()`	object	Returns an object that has all of the default move parameters set.

Method

Parameter

Definition

GetDefaultMoveParms()

object

Returns an object that has all of the default move parameters set.

Style object

The following table lists the properties of the Style object, along with their data types and, where appropriate, acceptable values and notes. All Style object properties are read-only.

Property (read-only)	Data type	Notes
`effectList`	object	EffectList object (see EffectList object).
`name`	string	The name displayed in the Style panel.
`pathAttributes`	object	PathAttrs object (see PathAttrs object).
`tdTagText`	string	A string that contains all the attributes of a table cell except `colspan` and `rowspan`. Should be in a format similar to the following: `"bgcolor="ff0000" valign="top""`
`textBold`	Boolean	Whether to make the specified text bold; used only if `use_textStyles` is set to `true`.
`textFont`	string	The font to apply to text; used only if `use_textFont` is set to `true`.
`textItalic`	Boolean	Whether to make the affected text italic; used only if `use_textStyles` is set to `true`.
`textSize`	string	String of the form `"#pt"`, where `#` is a numeric value.
`textUnderline`	Boolean	Whether to underline the affected text; used only if `use_textStyles` is set to `true`.
`use_brush`	Boolean	If set to `true`, applies the `brush` property of the pathAttrs object when applying the style. If set to `false`, ignores the `brush` property. The default value is `false`.
`use_brushColor`	Boolean	If set to `true`, applies the `brushColor` property of the pathAttrs object when applying the style. If set to `false`, ignores the `brushColor` property. The default value is `false`.
`use_effectList`	Boolean	If set to `true`, applies the `effects` property of the EffectList object when applying the style. If set to `false`, ignores the `effects` property. The default value is `false`.
`use_fill`	Boolean	If set to `true`, applies the `fill` property of the pathAttrs object when applying the style. If set to `false`, ignores the `fill` property. The default value is `false`.
`use_fillColor`	Boolean	If set to `true`, applies the `fillColor` property of the pathAttrs object when applying the style. If set to `false`, ignores the `fillColor` property. The default value is `false`.
`use_textFont`	Boolean	If set to `true`, applies the `textFont` property of the pathAttrs object when applying the style. If set to `false`, ignores the `textFont` property. The default value is `false`.
`use_textSize`	Boolean	If set to `true`, applies the `textSize` property of the pathAttrs object when applying the style. If set to `false`, ignores the `textSize` property. The default value is `false`.
`use_textStyles`	Boolean	If set to `true`, applies the `textStyles` property of the pathAttrs object when applying the style. If set to `false`, ignores the `textStyles` property. The default value is `false`.

Property (read-only)

Data type

Notes

effectList

object

EffectList object (see EffectList object).

name

string

The name displayed in the Style panel.

pathAttributes

object

PathAttrs object (see PathAttrs object).

tdTagText

string

A string that contains all the attributes of a table cell except colspan and rowspan. Should be in a format similar to the following: "bgcolor="ff0000" valign="top""

textBold

Boolean

Whether to make the specified text bold; used only if use_textStyles is set to true.

textFont

string

The font to apply to text; used only if use_textFont is set to true.

textItalic

Boolean

Whether to make the affected text italic; used only if use_textStyles is set to true.

textSize

string

String of the form "#pt", where # is a numeric value.

textUnderline

Boolean

Whether to underline the affected text; used only if use_textStyles is set to true.

use_brush

Boolean

If set to true, applies the brush property of the pathAttrs object when applying the style. If set to false, ignores the brush property. The default value is false.

use_brushColor

Boolean

If set to true, applies the brushColor property of the pathAttrs object when applying the style. If set to false, ignores the brushColor property. The default value is false.

use_effectList

Boolean

If set to true, applies the effects property of the EffectList object when applying the style. If set to false, ignores the effects property. The default value is false.

use_fill

Boolean

If set to true, applies the fill property of the pathAttrs object when applying the style. If set to false, ignores the fill property. The default value is false.

use_fillColor

Boolean

If set to true, applies the fillColor property of the pathAttrs object when applying the style. If set to false, ignores the fillColor property. The default value is false.

use_textFont

Boolean

If set to true, applies the textFont property of the pathAttrs object when applying the style. If set to false, ignores the textFont property. The default value is false.

use_textSize

Boolean

If set to true, applies the textSize property of the pathAttrs object when applying the style. If set to false, ignores the textSize property. The default value is false.

use_textStyles

Boolean

If set to true, applies the textStyles property of the pathAttrs object when applying the style. If set to false, ignores the textStyles property. The default value is false.

Comments

extdw_doc said on Sep 15, 2005 at 12:07 PM :

The Style object topic is tagged with an incorrect paragraph format making it seem subordinate to the SmartShape object. The Style object is equivalent to the other objects within Fireworks documents and should have an equivalent heading.