Enumeration

The Enumeration block provides a control to present an enumerated list of options to the command. It can be displayed either as a drop-down Option Menu or as a Radio Box.

Inherited general properties

• BlockID
• Enable
• Group
• Label
• Show
• Expanded

Block-specific properties

Property Name	Description	Access	Property Type	List of Values
AllowShortcuts	Specifies whether to provide the option to show the enumeration options as shortcuts. Useful only when PresentationStyle is Option Menu, IconsOnly is false, and the number of Bitmaps equals the number of enumeration options. Shortcuts are not permitted when there are blank or duplicate icons.	CIG	Logical	TRUE — the Show Shortcuts option is available. FALSE — options cannot be displayed as shortcuts.
BalloonTooltipTexts	Specifies balloon tooltip text for each item in the list. Each item must have a corresponding text value.	CIGS	(String list)	Per-item strings.
BalloonTooltipImages	(implied companion property for images per item) — specifies bitmap image names. See Customizing Toolbar Bitmaps section.	CIG	Strings	Any valid bitmap image name (full path can also be specified).
BorderVisibility	Specifies whether the border is visible. Useful only when PresentationStyle is Radio Box.	CIG	Logical	TRUE — border visible. FALSE — border not visible.
HighQualityBitmap	Specifies whether to show the current bitmap with true color (24-bit).	CIG	Logical	TRUE — show with true color. FALSE — do not.
IconsOnly	Specifies whether to show the enumeration options as bitmaps only.	CIG	Logical	TRUE — show as bitmaps only. FALSE — do not.
InitialShortcuts	If enumeration options are shown as shortcuts and the number of options exceeds the maximum number of shortcuts, specifies the set of shortcuts displayed when the dialog is initially shown.	CIG	IntegerVector	Any value between 0 and N-1, where N is the number of enumeration options.
LabelVisibility	Specifies whether the Label string should be shown. The control becomes wide when this property is false.	CIG	Logical	TRUE — Label visible. FALSE — Label not visible.
Layout	Specifies horizontal or vertical layout of options. Active only if PresentationStyle is Radio Box.	CIG	Enum	Vertical — options presented vertically. Horizontal — options presented horizontally.
Localize	Allows localization of the block Label if it matches an English string in the NX string localization database.	CIG	Logical	TRUE — translate Label to current locale. FALSE — do not translate.
NumberOfColumns	Specifies the number of columns in which the Enum options are arranged. Useful only when PresentationStyle is Radio Box.	CIG	Integer	Any value greater than 0.
PresentationStyle	Specifies whether values are presented as a drop-down option menu or as radio buttons.	CIG	Enum	Option Menu — drop-down; standard NX enum width. Radio Box — radio-button style; width determined by PackedColumns.
RetainValue	Determines if the block's value will be saved in dialog memory (upon OK, Apply, or Close).	CGS	Logical	TRUE — retains the previous value. FALSE — does not retain.
Value	Specifies the enumerated list of options and the currently selected option. In Block UI Styler, the list is specified by double-clicking the Value property; the default option is chosen by right-clicking it. In automation programming, the option list is obtained via PropertyList.GetEnumMembers, and the currently selected option via GetEnum or GetEnumAsString. To set the option list use PropertyList.SetEnumMembers; to set the selected option use SetEnum or SetEnumAsString.	CSG	Enum	List of any strings. Note: the option list can only be changed after initialization if PresentationStyle is Option Menu.
PackedColumns	When displayed as a horizontal radio box, makes each column take up only as much space as required for labels in that column. Turned off, the longest label among all options dictates the width of all columns.	CIG	Logical	True / False (doc text reuses "Displays both bitmap and label" / "Displays either bitmap or label" wording, likely a documentation copy artifact from a neighboring property).
EnumSensitivity	Specifies the sensitivity (enabled/disabled state) of the enum members.	CSG	IntegerVector	Array of integers, 0 or 1. 1 = corresponding enum member is sensitive (enabled); otherwise insensitive.
EnumVisibility	Specifies the visibility of the enum members.	CSG	IntegerVector	Array of integers, 0 or 1 (presumed: 1 = visible).
ShowMostRecentlyUsed (name inferred from context)	Controls whether recently used options are displayed at the top of the drop-down list.	—	Logical	True — displays the recently used options at the top of the drop-down list. False — does not (this is the default value).

Access column legend

Character	Stands for	Meaning
C	Creation	Modifiable interactively in Block UI Styler at design time.
I	Initialize	Modifiable at run time via NXOpen API, but only during the Initialize callback.
G	Get	Readable via NXOpen API in any callback.
S	Set	Modifiable at run time via NXOpen API in any callback.

Related Basic blocks

Action Button, Drawing Area, Label/Bitmap, Multi-Line String, Object Color Picker, RGB Color Picker, Separator, String, Toggle, List Box.