Symbol style (automation interface)
A Symbol Style object stores an item's style settings, that is, its icon, image, font, color, node style and flow style settings.
If the Symbol Style is scoped to a Package (that is created from the Package), the Symbol Style item is shown in Modeler.
If the Symbol Style is scoped to any other item, that Symbol Style is created when the Edit button is clicked on the Style tab of the scoping item's Property Pages or symbol's View Options, and the Symbol Style is not shown in Modeler.
ATTRIBUTES:
Background Colour
A string describing the background color as an RGB value. A value of -1 specifies that the Background Color has not been set.
Access is read/write.
Background Hollow
A string indicating whether the background color has been set to Hollow. Possible values are TRUE or FALSE.
If setting to TRUE, set Background Hollow Set to TRUE as well.
Access is read/write.
Background Hollow Set
A string indicating whether the background color has been set to Hollow. Possible values are TRUE or FALSE.
If setting to TRUE, set Background Hollow to TRUE as well.
Access is read/write.
Fill Colour
A string describing the fill color as an RGB value. A value of -1 specifies that the Fill Color has not been set.
Access is read/write.
Fill Hollow
A string indicating whether the fill color has been set to Hollow. Possible values are TRUE or FALSE.
If setting to TRUE, set Fill Hollow Set to TRUE as well.
Access is read/write.
Fill Hollow Set
A string indicating whether the fill color has been set to Hollow. Possible values are TRUE or FALSE.
If setting to TRUE, set Fill Hollow to TRUE as well.
Access is read/write.
Flow Line Thickness
A string that specifies the line width of links. Possible values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 or 12. A value of -1 means Default.
Access is read/write.
Flow Presentation
A string that specifies the presentation of links. Possible values are as follows:
• 0 means Default.
• 1 means Straight.
• 2 means Curved.
• 3 means Rounded Waypoints.
Access is read/write.
Flow Shadowing
A string that specifies whether links have shadows. Possible values are as follows:
0 means Default.
1 means Off.
2 means On.
Access is read/write.
Font Name
A string describing the name of the font used for Symbols. A blank value specifies that the Font name has not been set for Symbols.
Access is read/write.
Font Size
A string describing the size of the font used for Symbols. A value of -1 specifies that the Font size has not been set for Symbols.
Access is read/write.
Icon
Stores a selected icon file.
Access is read/write.
Icon Available
A string indicating that an icon has been selected. Possible values are TRUE or FALSE. The image is stored using the Icon attribute.
Access is read/write.
Image Available
A string indicating that an image has been selected. Possible values are TRUE or FALSE. The image is stored using the Windows Meta File attribute.
Access is read/write.
Line Colour
A string describing the line color as an RGB value. A value of -1 specifies that the Line Color has not been set.
Access is read/write.
Maintain Aspect Ratio
A string indicating that the aspect ratio of the image is to be maintained when used as a symbol on a diagram. Possible values are TRUE or FALSE.
Access is read/write.
Name Only
A string indicating that only the name of an item is to be displayed with the image when used as a symbol on a diagram. Possible values are TRUE or FALSE.
Access is read/write.
Node Fill Style
A string that specifies the presentation of a node symbol.
• 0 means Default.
• 1 means Flat.
• 2 means 2D Gradient.
• 3 means 3D Beveled.
Access is read/write.
Node Line Thickness
A string that specifies the width of node symbol lines. Possible values are 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11 or 12. A value of -1 means Default.
Access is read/write.
Node Shadowing
A string that specifies whether node symbols have shadows. Possible values are as follows:
0 means Default.
1 means Off.
2 means On.
Access is read/write.
RTF Font Effects
A string describing the effects (bold, italic, strikeout and underline) that apply to the text in Rich Text properties. A value of -1 specifies that no effects have been set for Rich Text properties.
The value is an accumulation of the individual effects:
• Strikeout adds 8 to the value.
• Underline adds 4 to the value.
• Italic adds 2 to the value.
• Bold adds 1 to the value.
For example, a value of 5 means Underline and Bold apply, but Strikeout and Italic do not apply.
Access is read/write.
RTF Text Colour
A string describing the text color of text in Rich Text properties as an RGB value. A value of -1 specifies that the Text Color has not been set for text in Rich Text properties.
Access is read/write.
RTF Font Name
A string describing the name of the font used for text in Rich Text properties. A blank value specifies that the Font name has not been set for text in Rich Text properties.
Access is read/write.
RTF Font Size
A string describing the size of the font used for text in Rich Text properties. A value of -1 specifies that the Font size has not been set for text in Rich Text properties.
Access is read/write.
Show Compartment Headings
A string that specifies that the name of the Stereotype or Tag Definition for which each compartment is created is shown. Possible values are TRUE or FALSE.
Access is read/write.
Show Reference Full Names
A string that specifies that the full name of each referenced item is shown. Possible values are TRUE or FALSE.
Access is read/write.
Show Reference Signatures
A string that specifies that for each referenced item, its type is shown. Possible values are TRUE or FALSE.
Access is read/write.
Show Reference Types
A string that specifies that for referenced items that have signatures, the signature is shown. Possible values are TRUE or FALSE.
Access is read/write.
Style Tag
Specifies whether the Symbol Style is being used for a Stereotype, or as symbol view options. Possible values are as follows:
• 1 means it is used as a Stereotype's Symbol Style.
• 2 means it is being used as a symbol's view options.
Access is read/write.
Text Colour
A string describing the text color of Symbols as an RGB value. A value of -1 specifies that the Text Color has not been set for Symbols.
Access is read/write.
Token Text Effects
A string describing the effects (bold, italic, strikeout and underline) that apply to Model Object References in Rich Text properties. A value of -1 specifies that no effects have been set for Model Object References.
The value is an accumulation of the individual effects:
• Strikeout adds 8 to the value.
• Underline adds 4 to the value.
• Italic adds 2 to the value.
• Bold adds 1 to the value.
For example, a value of 5 means Underline and Bold apply, but Strikeout and Italic do not apply.
Access is read/write.
Token Text Colour
A string describing the text color of Model Object References in Rich Text properties as an RGB value. A value of -1 specifies that the Text Color has not been set for Model Object References.
Access is read/write.
Token Text Name
A string describing the name of the font used for Model Object References in Rich Text properties. A blank value specifies that the Font name has not been set for Model Object References.
Access is read/write.
Token Text Size
A string describing the size of the font used for Model Object References in Rich Text properties. A value of -1 specifies that the Font size has not been set for Model Object References.
Access is read/write.
View Show Constraint Text
A string that specifies that for each referenced item, its constraints are shown. Possible values are TRUE or FALSE.
Access is read/write.
Windows Meta File
Stores a selected image file. To use the image, the Image Available attribute must be set to TRUE.
Access is read/write.
ASSOCIATIONS
Compartment
Relationship with Stereotypes and Tag Definitions that are set up as compartments for item that owns the Symbol Style.
Multiplicity is 0+, access is read/write.
Meta Model Item
Relationship to the model item types that apply the Symbol Style. The Meta Model Item association applies only to Package scoped Symbol Styles.
Multiplicity is 0-1, access is read/write.
Model Object
Relationship with that item or diagram that owns the Symbol Style.
Multiplicity is 0-1, access is read/write.
Owning Stereotype
Relationship with a Stereotype that owns the Symbol Style.
Multiplicity is 0-1, access is read/write.
Symbol
Relationship with a symbol that owns the Symbol Style.
Multiplicity is 0-1, access is read/write.
Valid Stereotypes
Relationship with the Stereotypes that use this symbol style.
Multiplicity is 0-1, access is read-only.