Enumeration Editor

An enum or enumeration is a data type consisting of a set of named values, which are called elements.

../../_images/enumeration_editor_enumerations_editor.png

You can set these properties for an enumeration:

  • Name: The name of the enumeration. This cannot be left blank.

  • Type: Enumerations are always an Integer type and default to “Integer”. You can change the type to other Integer types (such as UInt64) should you need to use larger values for the enumeration elements.

  • Scope: Scope indicates what parts of your code can access the enumeration. Choices are Public, Protected and Private.

    • Public enums can be called from anywhere in your code with no restrictions.

    • Protected when used in classes can be used only within the class itself or within a subclass. When used with modules, the enumeration can be used only in conjunction with the module name.

    • Private enums can only be called by the module or class that contains the enum.

Use the “+” icon to add a new enumeration element to the set. Use the “-” button to remove an element from the set. When you add an element, you also give it a name. The name is used to refer to the value. You can edit the name by clicking on it once to select it and a second time to edit it.

Note

Scope is indicated in the Navigator via the background color of the item. An item that is public will have no background color. An item that is Protected has a yellow background. An item that is Private will has a red background.

See also

Enumeration data type; Enumerations topic