t_Enumeration_Values_Value

Value : Enumeration

One of the list of values for an Enumeration.

Description Enumerations are a special type of Class that provide a list of values along with localizable captions. Properties

behaveAsValue : string

Specifies a value with hasBehavior=true, to which this one is synonymous.

codeUpdateable : boolean

True if value attributes can be updated at run time.

deletable : boolean

True if the value can be deleted.

description

Enumeration value description.

Valid values based on“string”.
255 (maxLength)

displayUpdateable : boolean

True if the display data for the value can be modified at run time.

externalValue

Optional external integration value.

Valid values based on“string”.
50 (maxLength)

hasBehavior : boolean

True if business logic is associated with this value.

It also means that a public static read-only attribute will be added to the enumerated class by the name of the 'name' property and containing the 'value' property.

Example

(DayOfWeekEnum'MONDAY) will return "1".  Where: DaysOfWeekEnum is the enumeration, MONDAY is the name
of one of the values, and "1" is the code value.

hideable : boolean

True if the value can be hidden from the UI.

name : identifier

Unique value name. If the enumerated value's hasBehavior property is true, this is also the name of a public static read-only attribute on the enumeration class containing the constant code value.

Valid values based on“string”.
:?[\p{L}_][\p{L}\p{N}_]*(:[\p{L}_][\p{L}\p{N}_]*)*	Value must begin with a letter or an underscore. Case and length are not restricted. Letters, numbers and underscores are allowed. Colon is used as a scope separator. Spaces and other punctuation characters are not allowed.

parentValue

Parent value corresponding to this value.

Valid values based on“string”.
50 (maxLength)

upgradeUpdateable : boolean

True if the value can be automatically upgraded.

value

Enumeration code value.

Valid values based on“string”.
50 (maxLength)

Content

• Sequence of:

  • t_Enumeration_Values_Value_Locales [0..1]

Example

Our enumeration is called DayOfWeekEnum.  It has a list of values named MONDAY, TUESDAY, WEDNESDAY...
the code values are "1", "2", "3", ... Each of the values has French and English captions.
In usage, (DayOfWeekEnum'MONDAY) returns "1" which you might use in a comparison like (= currentDay (DayOfWeekEnum'MONDAY)) if currentDay was simply a String value.
To get an instance of the value use the 'get' syntax as in (DayOfWeekEnum'get'MONDAY).
To get the caption of the value, use the caption property, as in ((DayOfWeekEnum'get'MONDAY)'caption).  This
will return the caption in the current invocation context's locale.

Parents

• t_Enumeration_Values

• t_Enumeration_Values_Value_Locales
  

Parent topic: t_Enumeration_Values