Predefined Structured Types

When you are working with Tagged Values, you might want to create your own structured Tagged Values. You can base these on the range of predefined structured Tagged Value types and filters described here. Each description includes the syntax for creating the initial values for their use.

Tagged Value Type and Format entries are case-sensitive.

 

Tagged Value Type

Format

Description

See also

AddinBroadcast

Type=AddinBroadcast;
Values=YourAddinName;

Allows an AddIn 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;

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

 

 

CheckList

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

Enables you to add 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 in the Tagged Values window with a checkbox; the tag has the value Incomplete until each checkbox is selected.

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;
 

 

Classifier

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

Deprecated - use RefGUID and RefGUIDList

Returns the name of a user-selected element from the model, where Type1 and Type2 specify one or more allowed element types and Stereotype1 represents an allowed stereotype.

 

 

Color

Type=Color;
Default=Val;

Enables input of 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 RGB for Red is FF, and the decimal value is 255.

 

 

Const

Type=Const;
Default=Val;

 

Enables creation of a read-only constant value.

 

Custom

Type= Custom;

Enables you to create your own template for predefined types.

 

Create Custom Tagged Value Type

DateTime

Type=DateTime;

Enables input of the date and time for the Tagged Value from a calendar menu.

 

 

Directory

Type=Directory;
Default=Val;

Enables entry of 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;

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

 

 

File

Type=File;
Default=Val;

Enables input of 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;

 

Enables entry of 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;

 

Enables entry of an Integer value, and a default.

 

Memo

Type=Memo;

Enables input of large and complex Tagged Values.

 

 

RefGUID

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

Enables the Tagged Value to 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;

Enables the Tagged Value to 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;

Enables creation of 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;

Enables entry of a string value, up to 255 characters in length, and a default text string.

For longer texts, use Type=Memo.

 

Type= Memo

URL

Type=URL;
Default=Val;

Enables entry of a web URL. The URL should start with:

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

 

You can set a default URL as a string value.

 

 

 

Tag Filters:

The following table details filters that can be used to restrict where a Tagged Value can be applied.

Filter

Format

Description

See also

AppliesTo

AppliesTo=Type1,Type2;

Restricts the element types this filter 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