Tag definition (automation interface)
A Tag Definition defines extended properties that are applied by a Stereotype.
For information about using the automation interface to work with Tag Definitions, see Working with Stereotypes and Tag Definitions.
 |
The Derived and Derivation Script properties of a Tag Definition 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 Tag Definition is shown on all diagrams. Possible values are TRUE or FALSE.
Access is read/write.
Browseable
A string describing whether the Tag Definition 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.
Default Value
A string that specifies the default value for a Tag Definition.
Access is read/write.
Description
A textual property that gives an overview of the dictionary item.
Access is read/write.
Inverse Name
A textual property that provides an inverse name for the Tag Definition.
Access is read/write.
Is Derived
A textual property that specifies that when the Tag Definition is applied to an item, the tagged value of the Tag Definition is derived through the Derivation Script of the Tag Definition.
Access is read/write.
Multiplicity Text
A string that specifies the multiplicity of the Tag Definition. Set as follows for the values available in the drop-down list on the Association's Property Pages:
• ZERO or ONE
• ZERO or MORE
• only ONE (results in a multiplicity of zero or one)
• ONE or MORE (results in a multiplicity of zero or more)
• TBD (results in a multiplicity of zero or more)
Other values represent a User Defined value. For example, 12 to 15 or Thirteen. However, a user defined value can result in only a multiplicity of 'zero or one', or 'zero or more'.
Access is read/write.
Name Alias
A string that specifies the alias name for the Tag Definition. When a Name Alias is specified, all references to the tag definition in Modeler use the Name Alias rather than its Name.
You can use the DisplayName function to get a Tag Definition's Name Alias.
Access is read/write.
Overrideable
A string that specifies whether the Tag Definition is overrideable or not. When overrideable, a tagged value of the Tag Definition can be set for a Role, Attribute, Association or redefinition in isolation.
Possible values are TRUE or FALSE.
Access is read/write.
Released
A string indicating whether the Tag Definition is published. Possible values are TRUE or FALSE.
Access is read/write.
Tag Definition Type
A string that specifies the Tag Definition's data type:
• Boolean - specifies that the data type is Boolean.
• Enumeration - specifies that the data type is Enumeration.
• Reference - specifies that the data type is Reference.
• RTF - specifies that the data type is Rich Text
• String - specifies that the data type is Text.
Access is read/write.
Tag Mergeable
The Mergeable attribute is reserved for future use. Possible values are TRUE or FALSE.
Access is read/write.
Tag Read Only
A string indicating whether the Tag Definition's usage is Read Only. Possible values are TRUE or FALSE.
Access is read/write.
Tag User Visible
A string indicating whether the Tag Definition's usage is Visible. Possible values are TRUE or FALSE.
Access is read/write.
ASSOCIATIONS
In addition to the common associations.
Relationship to Comments that are applied to the Tag Definition.
Multiplicity is 0+, access is read/write.
Relationship to scoping Package.
Multiplicity is 0-1, access is read/write.
On Get Script
Relationship to a script object that the tag definition uses to specify the derivation script.
A tag definition's script object is not shown in Modeler, but you can set the script attribute of the owned script object through the Derivation Script tab of a Tag Definition's Property Pages.
|
|
Modeler creates an owned script object through the On Get Script association when the Derived check box is selected on the Type tab of the Tag Definition's Property Pages.
|
Multiplicity is 0-1, access is read/write.
Meta Model Type
Relationship to valid item types for a reference Tag Definition. An item to which the Tag Definition has been applied can link to items of a valid type through the Tag Definition.
Multiplicity is 0+, access is read/write.
See also Referenced Stereotype.
Relationship to Comments that are owned by the Tag Definition.
Multiplicity is 0+, access is read/write.
Relationship to valid Stereotypes for a reference Tag Definition. An item to which the Tag Definition has been applied can link to items that are stereotyped by valid Stereotypes through the Tag Definition.
Multiplicity is 0+, access is read/write.
See also Meta Model Type.
Stereotype
Relationship to the stereotypes that apply the Tag Definition.
Multiplicity is 0+, access is read/write.