OptionMenu Class — NXOpen Python API Reference 12.0.0 documentation

# OptionMenu Class

class `NXOpen.UIStyler.``OptionMenu`

  Bases: `NXOpen.UIStyler.StylerItem`

  Represents a OptionMenu for UI Styler.

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
ItemValue | Returns or sets the item value
Visibility | Returns or sets the visibility

# Methods

Method | Description
--- | ---
AddActivateHandler | Registers activate callback.
Dispose | Free resources associated with the instance.
GetBitmap | Returns an array of bitmaps
GetItemType | Gets the dialog item type.
GetItems | Returns an array if items
GetSensitivity | Gets the sensitivity
InitializeAttachment | Returns initialized dialog item attachment information
IsEqualTo | Equates two styler items
SetAttachment | Specifies the updated dialog item attachment information
SetBitmap | Set an array of bitmap filenames
SetItems | Set an array of items
SetLabel | Sets label
SetSensitivity | Sets the sensitivity

# Property Detail

## ItemValue

`OptionMenu.``ItemValue`

  Returns or sets the item value

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

  Getter Method

  Signature `ItemValue`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ItemValue`

  Parameters: | subitemIndex (int) – Zero-based index indicating the choice to be selected. It must be in the range of existing choices.

  New in version NX5.0.0.

  License requirements: None.

## Visibility

`OptionMenu.``Visibility`

  Returns or sets the visibility

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

  Getter Method

  Signature `Visibility`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Visibility`

  Parameters: | type (bool) – TRUE if visible, FALSE if invisible

  New in version NX5.0.0.

  License requirements: None.

# Method Detail

## AddActivateHandler

`OptionMenu.``AddActivateHandler`

  Registers activate callback.

  This method should be called before calling `UIStyler.Dialog.Show()` or `UIStyler.Dialog.RegisterWithUiMenu()`

  Signature `AddActivateHandler(activateevent, isDialogLaunchingEvent)`

  Parameters:

  - activateevent (CallableObject) – Callback for activate event
  - isDialogLaunchingEvent (bool) – TRUE if dialog is going to launch, FALSE if not

  New in version NX5.0.0.

  License requirements: None.

## GetBitmap

`OptionMenu.``GetBitmap`

  Returns an array of bitmaps

  Signature `GetBitmap()`

  Returns: |
  Return type: | list of str

  New in version NX5.0.0.

  License requirements: None.

## GetItems

`OptionMenu.``GetItems`

  Returns an array if items

  Signature `GetItems()`

  Returns: |
  Return type: | list of str

  New in version NX5.0.0.

  License requirements: None.

## GetSensitivity

`OptionMenu.``GetSensitivity`

  Gets the sensitivity

  Signature `GetSensitivity()`

  Returns: |
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

## SetBitmap

`OptionMenu.``SetBitmap`

  Set an array of bitmap filenames

  Signature `SetBitmap(bitmaps)`

  Parameters: | bitmaps (list of str) – An array of one or more bitmap filenames. If all bitmaps for the option menu reside in the same file, specify an array of just one entry, which contains the bitmap filename for this attribute. All existing choices for the option menu remains intact when this attribute is set. Only the bitmaps are changed. Note that the number of bitmaps must match the number of existing choices.

  New in version NX5.0.0.

  License requirements: None.

## SetItems

`OptionMenu.``SetItems`

  Set an array of items

  Signature `SetItems(strListArray)`

  Parameters: | strListArray (list of str) – An array of new choices to be used for the dialog item. Note that this removes all existing choices (both text and bitmaps)

  New in version NX5.0.0.

  License requirements: None.

## SetLabel

`OptionMenu.``SetLabel`

  Sets label

  Signature `SetLabel(strLabel)`

  Parameters: | strLabel (str) – Text to be set for the descriptive label.

  New in version NX5.0.0.

  License requirements: None.

## SetSensitivity

`OptionMenu.``SetSensitivity`

  Sets the sensitivity

  Signature `SetSensitivity(subitemIndex, type)`

  Parameters:

  - subitemIndex (int) – If the entire dialog item should change to the new Sensitivity state, set this field to UF_STYLER_NO_SUB_INDEX. If only one subitem should change to the new sensitivity state, set this field to its zero-based index.
  - type (bool) – TRUE if sensitive, FALSE if insensitive

  New in version NX5.0.0.

  License requirements: None.