Enumeration (Named Data Type)

From wiki.fine.cz
Jump to navigation Jump to search

Used to store a single value from a list of enumeration elements.

Template XML definition

Common Properties

Property XML Description Presence Default
Settings [E] Settings required
    Preference of identifier     [A] BOOL PreferIdent If true, while composing the set description the Ident properties of enumeration elements are used, if defined, otherwise Name property is used

Template's PreferIdent has higher priority

optional false
    Common user color     [A] BOOL UserColor For enumerations with shapes defined - if true, the color of shape is entered with selecting the enumeration element and used instead of colors defined in shape definition optional false
Item [:E:] Item List of elements (only the enumeration element type can be used) required
    Indent     [A] INT Level Indentation of individual elements of the enumeration (zero or absence means unindented), it is written as an attribute to the elements, but it is stored with the enumeration optional 0
Range [E] Range optional
    Allow empty     [A] BOOL AllowEmpty User is not forced to select value optional true

Example of Template XML

<Item ID="{EFEC9E11-6FFD-44B9-9FC8-AC6F1E892461}" ItemType="Enum" UserColor="False">

  <Name .... />

  <Comment .... />

  <Settings />

  <Item ID="{E3237AF4-3F69-44F9-BD34-EA5BF71D5A3A}" ItemType="EnumItem">

    <Name ... />

    <Settings IsHeading="true" />

  </Item>

  <Item ID="{F14426ED-878B-4B30-ACF0-EC7062DDEA80}" ItemType="EnumItem">

    <Name .... />

  </Item>

<Item ID="{A99658F7-FD21-4F12-B1B8-7159E8C78F34}" ItemType="EnumItem" Level="1">

    <Name .... />

  </Item>

</Item>

Data XML definition

Common Properties

Property XML Description
Value [A] STRING EnumValue Contains GUID or unique text identifier.
Color [A] Color Color of the shape

Example of Data XML

<Item ID="{EFEC9E11-6FFD-44B9-9FC8-AC6F1E892461}" EnumValue="{A99658F7-FD21-4F12-B1B8-7159E8C78F34}" />

<Item ID="{EFEC9E11-6FFD-44B9-9FC8-AC6F1E892461}" EnumValue="{719588F7-FD21-4F32-B1B8-481E58D45345}" Color="$000000AA"/>