Predefined Structured Types

Tagged Values define a wide range of properties and characteristics of a model element, and some of these properties have complex values. For example, you might want your user to select a value between upper and lower limits (using 'Spin' arrows), set a date and time, select a color from a palette, or work through a checklist.

You create these complex Tagged Values from any of a number of predefined Tagged Value types and filters, some of which you might have created yourself (Settings | UML Types > Tagged Value Types).

Tagged Value Type Formats

For each Tagged Value Type, the description includes the syntax for creating the initial values for use of the Tagged Value. The name and format are  case-sensitive.

Tagged Value Type

Format

Used to

See also

AddinBroadcast

Type=AddinBroadcast;
Values=YourAddinName;

Allow an Add-In to respond to an attempt to edit this Tagged Value by showing a dialog in which the value and notes can be edited.

 

 

Boolean

Type=Boolean;
Default=Val;

Provide for the input of True or False, either of which can be the default value.

 

 

CheckList

Type=CheckList;
Values=Val1,Val2,Val3;

Create a checklist of things to be completed or satisfied before an action is approved or performed.

Val1, Val2, Val3 and so on specify the checklist items, each of which is rendered via the Tagged Values window with a checkbox; the tag has the value Incomplete until each checkbox is selected, at which point the value is Complete.

For example:

Type=CheckList;
Values=Does the change solve the task\issue given,Does the code have sufficient error handling,Does the code make sense,Does the code comply with the coding conventions;
 

Whilst the element Tagged Value compartment and the Tagged Value window fields display the values Complete or Incomplete, reports compiled in RTF and HTML will show the list of checklist items and the status of each (True for selected, False for unselected).

 

 

Classifier

Type=Classifier;
Values=Type1,Type2;
Stereotypes=Stereotype1;

 

Deprecated - use RefGUID and RefGUIDList

 

Color

Type=Color;
Default=Val;

Input a color value from a color chooser menu, where the value is the decimal integer translation of the color's Hex RGB value.

For example, the Hex RGB for Blue is 0000FF and the decimal value is 255, whilst the Hex RGB for Green is 00FF00 and the decimal value is 65280.

 

 

Const

Type=Const;
Default=Val;

 

Create a read-only constant value.

 

Custom

Type= Custom;

Create your own template for predefined types, using a masked value.

Create Custom Masked Tagged Value Type

 

DateTime

Type=DateTime;

Input the date and time for the Tagged Value from a calendar menu.

 

 

Directory

Type=Directory;
Default=Val;

Enter a directory path from a browser.

You can set a default directory path as a string value.

 

 

Enum

Type=Enum;
Values=Val1,Val2,Val3;
Default=Val2;

Define a comma-separated list, where Val1, Val2 and Val3 represent values in the list and Default represents the default value of the list.

 

Add an Enumeration to a Stereotype

File

Type=File;
Default=Val;

Input a filename from a file browser dialog. The named file can be launched in its default application.

You can set a default file as a string containing the file path and file name.

 

 

Float, Decimal, Double

Type=Float;
Type=Decimal;
Type=Double;
Default=Val;

 

Enter a Float, Decimal or Double value. These types all map to the same type of data.

You can set a default for any or all of these.

 

Integer

Type=Integer;
Default=Val;

 

Enter an Integer value, and a default.

 

Memo

Type=Memo;

 

Input large and complex values for a tag.

 

RefGUID

Type=RefGUID;
Values=Type1,Type2;
Stereotypes=Stereotype1;

Reference an element from the model by specifying the element's GUID, where:

Type1 and Type2 specify one or more allowed diagram objects (such as Class, Component, Attribute or Operation)
Stereotype1 represents an allowed stereotype

 

You set the classifier, attribute or operation for a Tagged Value of this type by clicking on the (  ...  ) button against the Tagged Value in the Tagged Value window.

 

Classifier, Attribute or Operation

RefGUIDList

Type=RefGUIDList;
Values=Type1,Type2;
Stereotypes=Stereotype1;

Reference a list of elements from the model by specifying each element's GUID, where:

Type1 and Type2 specify one or more allowed diagram objects (such as Class or Component)
Stereotype1 represents an allowed stereotype

 

You set the classifier, attribute or operation for a Tagged Value of this type by clicking on the (  ...  ) button against the Tagged Value in the Tagged Value window.

 

Classifier, Attribute or Operation

Spin

Type=Spin;
LowerBound=x;
UpperBound=x;
Default=Val;

Create a spin control with the value of LowerBound being the lowest value and UpperBound being the highest value.

You can also set a default within that range.

 

 

String

Type=String;
Default=Val;

Enter a string value, up to 255 characters in length, and a default text string.

For longer texts, use Type=Memo.

 

Memo

URL

Type=URL;
Default=Val;

Enter a web URL. The URL should start with:

'http://'
'https://' or
'www.'

 

You can set a default URL as a string value.

 

 

Tag Filters

You can use filters to restrict where a Tagged Value can be applied.

Filter

Format

Description

See also

AppliesTo

AppliesTo=Type1,Type2;

Restricts the element types this tag can be applied to, where Type1 and Type2 are the valid types.

Possible values are:

All element types
All connector types
Attribute
Operation, and
OperationParameter
 

 

BaseStereotype

BaseStereotype=S1,S2;

Restricts the stereotypes that this tag belongs to, where S1 and S2 are the allowed stereotypes.

 

 

Learn more