ColorTool Class — NXOpen Python API Reference 12.0.0 documentation

# ColorTool Class

class `NXOpen.UIStyler.``ColorTool`

  Bases: `NXOpen.UIStyler.StylerItem`

  Represents a ColorTool for UI Styler.

  New in version NX5.0.0.

# Properties

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

# Methods

Method | Description
--- | ---
AddValueChangedHandler | Registers value change 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

# Property Detail

## ItemValue

`ColorTool.``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: | itemVal (int) – Integer value to display in the text field

  New in version NX5.0.0.

  License requirements: None.

## Sensitivity

`ColorTool.``Sensitivity`

  Returns or sets the sensitivity

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

  Getter Method

  Signature `Sensitivity`

  Returns: |
  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

`ColorTool.``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

## AddValueChangedHandler

`ColorTool.``AddValueChangedHandler`

  Registers value change callback.

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

  Signature `AddValueChangedHandler(valuechangedevent, isDialogLaunchingEvent)`

  Parameters:

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

  New in version NX5.0.0.

  License requirements: None.