Enumeration Class — NXOpen Python API Reference 12.0.0 documentation

# Enumeration Class

class `NXOpen.BlockStyler.``Enumeration`

  Bases: `NXOpen.BlockStyler.UIBlock`

  Represents an Enumeration block

  New in version NX8.5.0.

# Properties

Property | Description
--- | ---
AllowShortcuts | Returns or sets the AllowShortcuts.
BalloonTooltipLayoutAsString | Returns or sets the BalloonTooltipLayout as string
BorderVisibility | Returns or sets the BorderVisibility
Enable | Returns or sets the Enable.
Expanded | Returns or sets the Expanded
Group | Returns or sets the Group
HighQualityBitmap | Returns or sets the HighQualityBitmap
IconsOnly | Returns or sets the IconsOnly.
Label | Returns or sets the Label
LabelVisibility | Returns or sets the LabelVisibility
LayoutAsString | Returns or sets the Layout as string
Localize | Returns or sets the Localize.
Name | Returns the name of the block or BlockID
NumberOfColumns | Returns or sets the NumberOfColumns
PackedColumns | Returns or sets the PackedColumns.
PresentationStyleAsString | Returns or sets the PresentationStyle as string
RetainValue | Returns or sets the RetainValue
Show | Returns or sets the Visibility of block.
Tag | Returns the Tag for this object.
Type | Returns the type of block
ValueAsString | Returns or sets the Value as string.

# Methods

Method | Description
--- | ---
Focus | Focuses on the block.
GetBalloonTooltipImages | Gets the BalloonTooltipImages
GetBalloonTooltipLayoutMembers | Gets the BalloonTooltipLayout members
GetBalloonTooltipTexts | Gets the BalloonTooltipTexts
GetBitmaps | Gets the Bitmaps
GetEnumMembers | Gets the Enum members.
GetEnumSensitivity | Gets EnumSensitivity
GetEnumVisibility | Gets EnumVisibility
GetInitialShortcuts | Gets InitialShortcuts.
GetLayoutMembers | Gets the Layout members
GetPresentationStyleMembers | Gets the PresentationStyle members
GetProperties | Returns the properties of the block
SetBalloonTooltipImages | Sets the BalloonTooltipImages
SetBalloonTooltipTexts | Sets the BalloonTooltipTexts
SetBitmaps | Sets the Bitmaps
SetEnumMembers | Sets the Enum members.
SetEnumSensitivity | Sets EnumSensitivity
SetEnumVisibility | Sets EnumVisibility
SetInitialShortcuts | Sets InitialShortcuts.

# Property Detail

## AllowShortcuts

`Enumeration.``AllowShortcuts`

  Returns or sets the AllowShortcuts.

  If true, the ‘Show Shortcuts’ option is available.

  `-------------------------------------`

  Getter Method

  Signature `AllowShortcuts`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `AllowShortcuts`

  Parameters: | allow (bool) –

  New in version NX8.5.0.

  License requirements: None.

## BalloonTooltipLayoutAsString

`Enumeration.``BalloonTooltipLayoutAsString`

  Returns or sets the BalloonTooltipLayout as string

  `-------------------------------------`

  Getter Method

  Signature `BalloonTooltipLayoutAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `BalloonTooltipLayoutAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

## BorderVisibility

`Enumeration.``BorderVisibility`

  Returns or sets the BorderVisibility

  `-------------------------------------`

  Getter Method

  Signature `BorderVisibility`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `BorderVisibility`

  Parameters: | visibility (bool) –

  New in version NX8.5.0.

  License requirements: None.

## HighQualityBitmap

`Enumeration.``HighQualityBitmap`

  Returns or sets the HighQualityBitmap

  `-------------------------------------`

  Getter Method

  Signature `HighQualityBitmap`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `HighQualityBitmap`

  Parameters: | highQuality (bool) –

  New in version NX8.5.0.

  License requirements: None.

## IconsOnly

`Enumeration.``IconsOnly`

  Returns or sets the IconsOnly.

  If true, the enumeration options are shown as bitmaps only

  `-------------------------------------`

  Getter Method

  Signature `IconsOnly`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `IconsOnly`

  Parameters: | iconsOnly (bool) –

  New in version NX8.5.0.

  License requirements: None.

## LabelVisibility

`Enumeration.``LabelVisibility`

  Returns or sets the LabelVisibility

  `-------------------------------------`

  Getter Method

  Signature `LabelVisibility`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `LabelVisibility`

  Parameters: | visibility (bool) –

  New in version NX8.5.0.

  License requirements: None.

## LayoutAsString

`Enumeration.``LayoutAsString`

  Returns or sets the Layout as string

  `-------------------------------------`

  Getter Method

  Signature `LayoutAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `LayoutAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

## Localize

`Enumeration.``Localize`

  Returns or sets the Localize.

  If true, the Label is translated to current locale language.

  `-------------------------------------`

  Getter Method

  Signature `Localize`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `Localize`

  Parameters: | localize (bool) –

  New in version NX8.5.0.

  License requirements: None.

## NumberOfColumns

`Enumeration.``NumberOfColumns`

  Returns or sets the NumberOfColumns

  `-------------------------------------`

  Getter Method

  Signature `NumberOfColumns`

  Returns: |
  Return type: | int

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `NumberOfColumns`

  Parameters: | numColumn (int) –

  New in version NX8.5.0.

  License requirements: None.

## PackedColumns

`Enumeration.``PackedColumns`

  Returns or sets the PackedColumns.

  If true, each column takes up as much space as required for labels in that column. If false, the longest label amongst all options dictates the width of all columns.

  `-------------------------------------`

  Getter Method

  Signature `PackedColumns`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PackedColumns`

  Parameters: | packedColumns (bool) –

  New in version NX8.5.0.

  License requirements: None.

## PresentationStyleAsString

`Enumeration.``PresentationStyleAsString`

  Returns or sets the PresentationStyle as string

  `-------------------------------------`

  Getter Method

  Signature `PresentationStyleAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `PresentationStyleAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

## RetainValue

`Enumeration.``RetainValue`

  Returns or sets the RetainValue

  `-------------------------------------`

  Getter Method

  Signature `RetainValue`

  Returns: |
  Return type: | bool

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `RetainValue`

  Parameters: | retain (bool) –

  New in version NX8.5.0.

  License requirements: None.

## ValueAsString

`Enumeration.``ValueAsString`

  Returns or sets the Value as string.

  Represents the currently selected option of enum.

  `-------------------------------------`

  Getter Method

  Signature `ValueAsString`

  Returns: |
  Return type: | str

  New in version NX8.5.0.

  License requirements: None.

  `-------------------------------------`

  Setter Method

  Signature `ValueAsString`

  Parameters: | enumString (str) –

  New in version NX8.5.0.

  License requirements: None.

# Method Detail

## GetBalloonTooltipImages

`Enumeration.``GetBalloonTooltipImages`

  Gets the BalloonTooltipImages

  Signature `GetBalloonTooltipImages()`

  Returns: |
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## GetBalloonTooltipLayoutMembers

`Enumeration.``GetBalloonTooltipLayoutMembers`

  Gets the BalloonTooltipLayout members

  Signature `GetBalloonTooltipLayoutMembers()`

  Returns: | Value to get from the property
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## GetBalloonTooltipTexts

`Enumeration.``GetBalloonTooltipTexts`

  Gets the BalloonTooltipTexts

  Signature `GetBalloonTooltipTexts()`

  Returns: | Value to get from the property
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## GetBitmaps

`Enumeration.``GetBitmaps`

  Gets the Bitmaps

  Signature `GetBitmaps()`

  Returns: | Value to get for the property.
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## GetEnumMembers

`Enumeration.``GetEnumMembers`

  Gets the Enum members.

  Signature `GetEnumMembers()`

  Returns: | Array of member names
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## GetEnumSensitivity

`Enumeration.``GetEnumSensitivity`

  Gets EnumSensitivity

  Signature `GetEnumSensitivity()`

  Returns: | Array of integers with the value 0 or 1. If 1 then the corresponding enum member is sensitive otherwise it is insensitive.
  Return type: | list of int

  New in version NX8.5.0.

  License requirements: None.

## GetEnumVisibility

`Enumeration.``GetEnumVisibility`

  Gets EnumVisibility

  Signature `GetEnumVisibility()`

  Returns: | Array of integers with the value 0 or 1. If 1 then the corresponding enum member is visible otherwise it is hidden.
  Return type: | list of int

  New in version NX8.5.0.

  License requirements: None.

## GetInitialShortcuts

`Enumeration.``GetInitialShortcuts`

  Gets InitialShortcuts.

  Specifies the set of shortcuts that are displayed when the dialog is initially shown. Valid only if AllowShortcuts property is true.

  Signature `GetInitialShortcuts()`

  Returns: | Array of integers with length between 0 and N-1, where N is the number of enumeration options
  Return type: | list of int

  New in version NX8.5.0.

  License requirements: None.

## GetLayoutMembers

`Enumeration.``GetLayoutMembers`

  Gets the Layout members

  Signature `GetLayoutMembers()`

  Returns: | Value to get from the property
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## GetPresentationStyleMembers

`Enumeration.``GetPresentationStyleMembers`

  Gets the PresentationStyle members

  Signature `GetPresentationStyleMembers()`

  Returns: | Value to get from the property
  Return type: | list of str

  New in version NX8.5.0.

  License requirements: None.

## SetBalloonTooltipImages

`Enumeration.``SetBalloonTooltipImages`

  Sets the BalloonTooltipImages

  Signature `SetBalloonTooltipImages(imageStrings)`

  Parameters: | imageStrings (list of str) –

  New in version NX8.5.0.

  License requirements: None.

## SetBalloonTooltipTexts

`Enumeration.``SetBalloonTooltipTexts`

  Sets the BalloonTooltipTexts

  Signature `SetBalloonTooltipTexts(tooltipTextArray)`

  Parameters: | tooltipTextArray (list of str) – Value to set for the property.

  New in version NX8.5.0.

  License requirements: None.

## SetBitmaps

`Enumeration.``SetBitmaps`

  Sets the Bitmaps

  Signature `SetBitmaps(bitmapsStrings)`

  Parameters: | bitmapsStrings (list of str) – Value to set for the property.

  New in version NX8.5.0.

  License requirements: None.

## SetEnumMembers

`Enumeration.``SetEnumMembers`

  Sets the Enum members.

  Signature `SetEnumMembers(memberStrings)`

  Parameters: | memberStrings (list of str) – Array of member names

  New in version NX8.5.0.

  License requirements: None.

## SetEnumSensitivity

`Enumeration.``SetEnumSensitivity`

  Sets EnumSensitivity

  Signature `SetEnumSensitivity(valueVector)`

  Parameters: | valueVector (list of int) – Array of integers with the value 0 or 1. If 1 then the corresponding enum member is sensitive otherwise it is insensitive.

  New in version NX8.5.0.

  License requirements: None.

## SetEnumVisibility

`Enumeration.``SetEnumVisibility`

  Sets EnumVisibility

  Signature `SetEnumVisibility(valueVector)`

  Parameters: | valueVector (list of int) – Array of integers with the value 0 or 1. If 1 then the corresponding enum member is visible otherwise it is hidden.

  New in version NX8.5.0.

  License requirements: None.

## SetInitialShortcuts

`Enumeration.``SetInitialShortcuts`

  Sets InitialShortcuts.

  Specifies the set of shortcuts that are displayed when the dialog is initially shown. Valid only if AllowShortcuts property is true.

  Signature `SetInitialShortcuts(valueVector)`

  Parameters: | valueVector (list of int) – Array of integers with length between 0 and N-1, where N is the number of enumeration options

  New in version NX8.5.0.

  License requirements: None.