Xojo Documentation Xojo Documentation

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

Enumeration Editor

You can set these properties for an enumeration:

• Name
  The name of the enumeration.
• 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 call the method. Choices are Public, Protected and Private.
  • Public enums can be called from anywhere in your code with no restrictions.
  • Protected enums have some restrictions, which vary depending on where the enum is located (class or module).
  • 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: The enumeration name cannot be left blank.

See Also

Enumeration data type; UserGuide:Enumerations topic