DialogItem Class

class NXOpen.UIStyler.DialogItem

Bases: NXOpen.UIStyler.StylerItem

Represents a DialogItem for UI Styler.

New in version NX5.0.0.

Properties

Property Description
FileOperationData Returns the file operation data

Methods

Method Description
AddApplyHandler Registers apply callback.
AddBackHandler Registers back callback.
AddCancelHandler Registers cancel callback.
AddConstructHandler Registers construct callback.
AddDestructHandler Registers destruct callback.
AddFileOperationHandler Registers file operation callback.
AddOkayHandler Registers ok callback.
AddPageSwitchHandler Registers switch callback.
Dispose Free resources associated with the instance.
GetItemType Gets the dialog item type.
GetSelectionHandle Gets the selection handle for a given dialog item
InitializeAttachment Returns initialized dialog item attachment information
IsEqualTo Equates two styler items
SetAttachment Specifies the updated dialog item attachment information
SetNavigationSensitivity Specifies the sensitivity of the navigation buttons at the bottom of the dialog.
SetResize Specifies wether dialog is allowed to resize
SetSensitivity Specifies the sensitivity of the dialog.
SetTitle Specifies a string to display on the top border of the dialog
SetWidth Specifies the pixel width for the dialog.

Enumerations

DialogItemDialogItemIndex Enumeration Describes dialog item index

Property Detail

FileOperationData

DialogItem.FileOperationData

Returns the file operation data

-------------------------------------

Getter Method

Signature FileOperationData

Returns:file operation object
Return type:NXOpen.UIStyler.FileOperationData

New in version NX5.0.0.

License requirements: None.

Method Detail

AddApplyHandler

DialogItem.AddApplyHandler

Registers apply callback.

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

Signature AddApplyHandler(applyevent, isDialogLaunchingEvent)

Parameters:
  • applyevent (CallableObject) –
  • isDialogLaunchingEvent (bool) –

New in version NX5.0.0.

License requirements: None.

AddBackHandler

DialogItem.AddBackHandler

Registers back callback.

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

Signature AddBackHandler(backevent, isDialogLaunchingEvent)

Parameters:
  • backevent (CallableObject) –
  • isDialogLaunchingEvent (bool) –

New in version NX5.0.0.

License requirements: None.

AddCancelHandler

DialogItem.AddCancelHandler

Registers cancel callback.

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

Signature AddCancelHandler(cancelevent, isDialogLaunchingEvent)

Parameters:
  • cancelevent (CallableObject) –
  • isDialogLaunchingEvent (bool) –

New in version NX5.0.0.

License requirements: None.

AddConstructHandler

DialogItem.AddConstructHandler

Registers construct callback.

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

Signature AddConstructHandler(constructevent, isDialogLaunchingEvent)

Parameters:
  • constructevent (CallableObject) –
  • isDialogLaunchingEvent (bool) –

New in version NX5.0.0.

License requirements: None.

AddDestructHandler

DialogItem.AddDestructHandler

Registers destruct callback.

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

Signature AddDestructHandler(destructevent, isDialogLaunchingEvent)

Parameters:
  • destructevent (CallableObject) –
  • isDialogLaunchingEvent (bool) –

New in version NX5.0.0.

License requirements: None.

AddFileOperationHandler

DialogItem.AddFileOperationHandler

Registers file operation callback.

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

Signature AddFileOperationHandler(fileoperationevent, isDialogLaunchingEvent)

Parameters:
  • fileoperationevent (CallableObject) –
  • isDialogLaunchingEvent (bool) –

New in version NX5.0.0.

License requirements: None.

AddOkayHandler

DialogItem.AddOkayHandler

Registers ok callback.

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

Signature AddOkayHandler(okayevent, isDialogLaunchingEvent)

Parameters:
  • okayevent (CallableObject) –
  • isDialogLaunchingEvent (bool) –

New in version NX5.0.0.

License requirements: None.

AddPageSwitchHandler

DialogItem.AddPageSwitchHandler

Registers switch callback.

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

Signature AddPageSwitchHandler(switchevent, isDialogLaunchingEvent)

Parameters:
  • switchevent (CallableObject) –
  • isDialogLaunchingEvent (bool) –

New in version NX8.5.3.

License requirements: None.

GetSelectionHandle

DialogItem.GetSelectionHandle

Gets the selection handle for a given dialog item

Signature GetSelectionHandle()

Returns:Selection handle
Return type:NXOpen.SelectionHandle

New in version NX5.0.0.

License requirements: None.

SetNavigationSensitivity

DialogItem.SetNavigationSensitivity

Specifies the sensitivity of the navigation buttons at the bottom of the dialog.

If you set the UF_STYLER_BACK_INDEX button to insensitive at creation time, the system does not show the BACK button; Changing the button’s sensitivity while the dialog displays does not show the Back button.

Signature SetNavigationSensitivity(subItemIndex, type)

Parameters:

New in version NX5.0.0.

License requirements: None.

SetResize

DialogItem.SetResize

Specifies wether dialog is allowed to resize

Signature SetResize(type)

Parameters:type (bool) – TRUE to allow dialog to resize; FALSE to freeze the dialog size

New in version NX5.0.0.

License requirements: None.

SetSensitivity

DialogItem.SetSensitivity

Specifies the sensitivity of the dialog.

Signature SetSensitivity(type)

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

New in version NX5.0.0.

License requirements: None.

SetTitle

DialogItem.SetTitle

Specifies a string to display on the top border of the dialog

Signature SetTitle(strLabel)

Parameters:strLabel (str) –

New in version NX5.0.0.

License requirements: None.

SetWidth

DialogItem.SetWidth

Specifies the pixel width for the dialog.

You can only set this attribute when the Dialog Resize attribute is set to TRUE. You cannot enter a negative number.

Signature SetWidth(width)

Parameters:width (int) –

New in version NX5.0.0.

License requirements: None.