Stereotype (automation interface)
A Stereotype applies Tag Definitions to extend the properties of a model item.
For information about using the automation interface to work with Stereotypes, see
Working with Stereotypes and Tag Definitions.
Note that the properties that appear on the Menu, Toolbar and Event UI tabs of a Stereotype's Property Pages are used for advanced customizations and the development of ergonomic profiles.
To write scripts you require a good working knowledge of the VBScript language, the Modeler Meta Model and the Modeler Automation Interface. If you run a script that has errors, those errors can corrupt Modeler model data and make Modeler crash.
ATTRIBUTES:
In addition to the
common attributes.
Always Shown
A string indicating whether the stereotype is shown on all diagrams. Possible values are TRUE or FALSE.
Access is read/write.
Apply Style To New Symbols
If you apply a Stereotype to an item and then add that item to a diagram, the Apply Style to New Symbols attribute of the Stereotype determines whether the Stereotype's Style properties are applied to the diagram symbol.
Access is read/write.
Apply To All Objects
A string indicating whether the stereotype is applied to all objects. Possible values are TRUE or FALSE.
Access is read/write.
Browseable
A string describing whether the stereotype is browsable. Possible values are TRUE or FALSE.
Access is read/write.
Constraints
A textual property describing restrictions on the values that may be assumed.
Access is read/write.
Create As Note
A textual property that specifies whether a stereotyped item is created as a Note (linked to the dragged item) or a standard symbol when dragged on to a diagram.
Access is read/write.
Description
A textual property that gives an overview of the Dictionary Item.
Access is read/write.
Enable Default Value Editing
A string that specifies whether the Enable Default Value Editing property is set to TRUE or FALSE.
When a Stereotype is applied to an Attribute or Role and the Stereotype's Hide Bespoke Property Pages property is set to true, the Default property of Attribute or Role is disabled. The Enable Default Value Editing property specifies that an Attribute's or Role's Default property is enabled, even when the Hide Bespoke Property Pages property is set to true.
Access is read/write.
Hide Bespoke Property Pages
A string that specifies that the Stereotype hides the item specific tabs on an item's Property Pages, so that only the following tabs are shown: General, Custom, Style, Items and any tabs for applied Stereotypes. Possible values are TRUE or FALSE.
Access is read/write.
Hide Creation Commands
A string that specifies that when the Stereotype is applied to an item, that item's context menu will hide the New and Populate submenus and their commands. Possible values are TRUE or FALSE.
Access is read/write.
Hide Meta Type Menus
A string that specifies that when the Stereotype is applied to an item, that item's context menu will not show any context menu commands that have been added to that item through Script items.
Access is read/write.
Keyword
A textual property that provides a title to use for the Stereotype when that Stereotype is used as compartment on a diagram symbol.
Access is read/write.
Name Alias
A string that specifies the alias name for the Stereotype. When an Name Alias is specified, all references to the Stereotype in Modeler use the Name Alias rather than its Name.
Access is read/write.
Overrideable
A string that specifies whether the Stereotype is overrideable or not. When overrideable, the Stereotype can be applied to a Role, Attribute, Association or redefinition in isolation.
Possible values are TRUE or FALSE.
Access is read/write.
Override Type Name
A string describing whether the name of the stereotype overrides the type of any items it stereotypes. Possible values are TRUE or FALSE.
Access is read/write.
ASSOCIATIONS:
In addition to the
common associations
Applied Comment
Relationship to Comments that are applied to the Stereotype.
Multiplicity is 0+, access is read/write.
Applied Constraint
Relationship to Constraints that are applied to the Stereotype.
Multiplicity is 0+, access is read/write.
Category or Package
Relationship to scoping package.
Multiplicity is 0-1, access is read/write.
Relationship to scoping package.
Multiplicity is 0-1, access is read/write.
Meta Model Type
Relationship to valid item types (the Stereotype can be applied only to items whose type is valid)
Multiplicity is 0+, access is read/write.
Model Object
Relationship to the items that are stereotyped by the stereotype.
Multiplicity is 0+, access is read/write.
Owned Comment
Relationship to Comments that are owned by the Stereotype.
Multiplicity is 0+, access is read/write.
Owned Constraint
Relationship to Constraints that are owned by the Stereotype.
Multiplicity is 0+, access is read/write.
Owned Double Click Script
Relationship to a script object that the stereotype uses to specify double click script.
A stereotype's script object is not shown in Modeler, but you can set the script attribute of the owned script object through the UI Events tab of a Stereotype's Property Pages.
|
Modeler creates an owned script object through the Owned Double Click Script association when the Double Click check box is selected on the UI Events tab of the Stereotype's Property Pages.
|
Multiplicity is 0-1, access is read/write.
Owned Menu Script
Relationship to script objects that the stereotype uses to specify menu command scripts.
A stereotype's script objects are not shown in Modeler, but you can set the script attribute of an owned script object through the Menu tab of a Stereotype's Property Pages (double-click the appropriate cell in the Has Script column).
|
Modeler creates an owned script object through the Owned Menu Script association when a new menu command entry is added to the list on the Menu tab of the Stereotype's Property Pages.
|
Multiplicity is 0+, access is read/write.
Owned On Delete Script
Relationship to a script object that the stereotype uses to specify on delete script.
A stereotype's script object is not shown in Modeler, but you can set the script attribute of the owned script object through the Object Events tab of a Stereotype's Property Pages.
|
Modeler creates an owned script object through the Owned On Delete Script association when the On Delete check box is selected on the Object Events tab of the Stereotype's Property Pages.
|
Multiplicity is 0-1, access is read/write.
Owned On Drop Script
Relationship to a script object that the stereotype uses to specify on drop script.
A stereotype's script object is not shown in Modeler, but you can set the script attribute of the owned script object through the UI Events tab of a Stereotype's Property Pages.
|
Modeler creates an owned script object through the Owned On Drop Script association when the On Drop check box is selected on the UI Events tab of the Stereotype's Property Pages.
|
Multiplicity is 0-1, access is read/write.
Owned On Model Close Script
Relationship to a script object that the stereotype uses to specify on model close script.
A stereotype's script object is not shown in Modeler, but you can set the script attribute of the owned script object through the Model Events tab of a Stereotype's Property Pages.
|
Modeler creates an owned script object through the Owned On Model Close Script association when the On Close check box is selected on the Model Events tab of the Stereotype's Property Pages.
|
Multiplicity is 0-1, access is read/write.
Owned On Model Open Script
Relationship to a script object that the stereotype uses to specify on model open script.
A stereotype's script object is not shown in Modeler, but you can set the script attribute of the owned script object through the Model Events tab of a Stereotype's Property Pages.
|
Modeler creates an owned script object through the Owned On Model Open Script association when the On Open check box is selected on the Model Events tab of the Stereotype's Property Pages.
|
Multiplicity is 0-1, access is read/write.
Owned Toolbar Script
Relationship to script objects that the stereotype uses to specify toolbar command scripts.
A stereotype's script objects are not shown in Modeler, but you can set the script attribute of an owned script object through the Toolbar tab of a Stereotype's Property Pages (double-click the appropriate cell in the Has Script column).
|
Modeler creates an owned script object through the Owned Toolbar Script association when a new toolbar command entry is added to the list on the Toolbar tab of the Stereotype's Property Pages.
|
Multiplicity is 0+, access is read/write.
Script
Relationship to all the script objects the stereotype owns.
A stereotype's script objects are not shown in Modeler, but you can set the script attribute of an owned script object through the Menu, ribbon tab, UI Events and Object Events tabs of a Stereotype's Property Pages.
Multiplicity is 0+, access is read/write.
Symbol Style
Relationship to a symbol style object that stores a stereotype's style settings, that is, its icon, image, font and color settings.
Multiplicity is 0-1, access is read/write.
Tag Definition
Relationship to the tag definitions that are applied by the stereotype.
Multiplicity is 0+, access is read/write.