IntegerItem Class — NXOpen Python API Reference 12.0.0 documentation

# IntegerItem Class

class `NXOpen.UIStyler.``IntegerItem`

  Bases: `NXOpen.UIStyler.StylerItem`

  Represents a Integer for UI Styler.

  New in version NX5.0.0.

# Properties

Property | Description
--- | ---
ItemValue | Returns or sets the value obtained from the text field.
Sensitivity | Returns or sets the sensitivity of Integer item
Visibility | Returns or sets the visibility of the dialog item.

# Methods

Method | Description
--- | ---
AddActivateHandler | Registers activate callback.
Dispose | Free resources associated with the instance.
GetItemType | Gets the dialog item type.
InitializeAttachment | Returns initialized dialog item attachment information
IsEqualTo | Equates two styler items
SetAttachment | Specifies the updated dialog item attachment information
SetBitmap | Specifies a filename that contains a bitmap definition.
SetFocus | Sets focus
SetLabel | Specifies descriptive text to display for the dialog item.

# Property Detail

## ItemValue

`IntegerItem.``ItemValue`

  Returns or sets the value obtained from the text field.

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

  Getter Method

  Signature `ItemValue`

  Returns: |
  Return type: | int

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `ItemValue`

  Parameters: | itemVal (int) –

  New in version NX5.0.0.

  License requirements: None.

## Sensitivity

`IntegerItem.``Sensitivity`

  Returns or sets the sensitivity of Integer item

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

  Getter Method

  Signature `Sensitivity`

  Returns: | TRUE if sensitive, FALSE if insensitive
  Return type: | bool

  New in version NX5.0.0.

  License requirements: None.

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

  Setter Method

  Signature `Sensitivity`

  Parameters: | type (bool) – TRUE if sensitive, FALSE if insensitive

  New in version NX5.0.0.

  License requirements: None.

## Visibility

`IntegerItem.``Visibility`

  Returns or sets the visibility of the dialog item.

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

  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 the dialog item is sensitive; FALSE if insensitive

  New in version NX5.0.0.

  License requirements: None.

# Method Detail

## AddActivateHandler

`IntegerItem.``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) –
  - isDialogLaunchingEvent (bool) –

  New in version NX5.0.0.

  License requirements: None.

## SetBitmap

`IntegerItem.``SetBitmap`

  Specifies a filename that contains a bitmap definition.

  The filename must contain a UBM, XPM, or BMP extension. When you use this field, the system displays a bitmap for this dialog item instead of a text label. When a bitmap is present, the system uses the text label as tooltip text when a user places the mouse cursor over the bitmap. We recommend that you use a 16x16 bitmap for this dialog item.

  Signature `SetBitmap(bitmap)`

  Parameters: | bitmap (str) – Filename with .ubm, .xpm, or .bmp extension that contains bitmap definition

  New in version NX5.0.0.

  License requirements: None.

## SetFocus

`IntegerItem.``SetFocus`

  Sets focus

  Signature `SetFocus()`

  New in version NX5.0.0.

  License requirements: None.

## SetLabel

`IntegerItem.``SetLabel`

  Specifies descriptive text to display for the dialog item.

  It should describe the dialog item’s intended use. If you specify a bitmap for this dialog item, it uses this text as tooltip text.

  Signature `SetLabel(strLabel)`

  Parameters: | strLabel (str) – String to display on the left side of the text field.

  New in version NX5.0.0.

  License requirements: None.