Dialog Class

class NXOpen.UIStyler.Dialog

Bases: NXOpen.TransientObject

Represents a DialogItem for UI Styler.

New in version NX5.0.0.

Methods

Method	Description
Dispose	Free resources associated with the instance.
GetBitmap	Gets the dialog item with specified item identifier @return
GetButtonLayout	Gets the dialog item with specified item identifier @return
GetCollapsibleGroup	Gets the dialog item with specified item identifier @return
GetColorTool	Gets the dialog item with specified item identifier @return
GetDialogIndex	Gets the dialog item with specified item identifier @return
GetDialogItemUsingSelectionHandle	Gets the dialog item for a selection handle @return
GetGroupBox	Gets the dialog item with specified item identifier @return
GetIntegerItem	Gets the dialog item with specified item identifier @return
GetIntegerScale	Gets the dialog item with specified item identifier @return
GetLabelItem	Gets the dialog item with specified item identifier @return
GetMultiSelectList	Gets the dialog item with specified item identifier @return
GetMultiTextBox	Gets the dialog item with specified item identifier @return
GetOptionMenu	Gets the dialog item with specified item identifier @return
GetOptionToggle	Gets the dialog item with specified item identifier @return
GetPropertyPage	Gets the dialog item with specified item identifier @return
GetPushButton	Gets the dialog item with specified item identifier @return
GetRadioBox	Gets the dialog item with specified item identifier @return
GetRealItem	Gets the dialog item with specified item identifier @return
GetRealScale	Gets the dialog item with specified item identifier @return
GetRowColumn	Gets the dialog item with specified item identifier @return
GetScrolledWindow	Gets the dialog item with specified item identifier @return
GetSelectionBox	Gets the dialog item with specified item identifier @return
GetSeparator	Gets the dialog item with specified item identifier @return
GetSingleSelectList	Gets the dialog item with specified item identifier @return
GetStringItem	Gets the dialog item with specified item identifier @return
GetStylerItem	Gets the dialog item with specified item identifier @return
GetTabControl	Gets the dialog item with specified item identifier @return
GetToggle	Gets the dialog item with specified item identifier @return
GetToolPalette	Gets the dialog item with specified item identifier @return
GetWideString	Gets the dialog item with specified item identifier @return
RegisterWithUiMenu	Registers the dialog with a menu item.
Show	Displays an NX (UIStyler generated) bottom dialog.

Enumerations

DialogItemType Enumeration

Represents dialog item type

Method Detail

Dispose

Dialog.Dispose

Free resources associated with the instance.

After this method is called, it is illegal to use the object. In .NET or Java, this method is automatically called when the object is deleted by the garbage collector.

Signature Dispose()

New in version NX5.0.0.

License requirements: None.

GetBitmap

Dialog.GetBitmap

Gets the dialog item with specified item identifier

Signature GetBitmap(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.BitMap

New in version NX5.0.0.

License requirements: None.

GetButtonLayout

Dialog.GetButtonLayout

Gets the dialog item with specified item identifier

Signature GetButtonLayout(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.ButtonLayout

New in version NX5.0.0.

License requirements: None.

GetCollapsibleGroup

Dialog.GetCollapsibleGroup

Gets the dialog item with specified item identifier

Signature GetCollapsibleGroup(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.CollapsibleGroup

New in version NX5.0.0.

License requirements: None.

GetColorTool

Dialog.GetColorTool

Gets the dialog item with specified item identifier

Signature GetColorTool(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.ColorTool

New in version NX5.0.0.

License requirements: None.

GetDialogIndex

Dialog.GetDialogIndex

Gets the dialog item with specified item identifier

Signature GetDialogIndex(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.DialogItem

New in version NX5.0.0.

License requirements: None.

GetDialogItemUsingSelectionHandle

Dialog.GetDialogItemUsingSelectionHandle

Gets the dialog item for a selection handle

Signature GetDialogItemUsingSelectionHandle(select)

Parameters:select (NXOpen.SelectionHandle) – Selection handle Returns: Return type:NXOpen.UIStyler.StylerItem

New in version NX5.0.0.

License requirements: None.

GetGroupBox

Dialog.GetGroupBox

Gets the dialog item with specified item identifier

Signature GetGroupBox(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.GroupBox

New in version NX5.0.0.

License requirements: None.

GetIntegerItem

Dialog.GetIntegerItem

Gets the dialog item with specified item identifier

Signature GetIntegerItem(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.IntegerItem

New in version NX5.0.0.

License requirements: None.

GetIntegerScale

Dialog.GetIntegerScale

Gets the dialog item with specified item identifier

Signature GetIntegerScale(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.IntegerScale

New in version NX5.0.0.

License requirements: None.

GetLabelItem

Dialog.GetLabelItem

Gets the dialog item with specified item identifier

Signature GetLabelItem(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.LabelItem

New in version NX5.0.0.

License requirements: None.

GetMultiSelectList

Dialog.GetMultiSelectList

Gets the dialog item with specified item identifier

Signature GetMultiSelectList(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.MultiSelectList

New in version NX5.0.0.

License requirements: None.

GetMultiTextBox

Dialog.GetMultiTextBox

Gets the dialog item with specified item identifier

Signature GetMultiTextBox(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.MultiTextBox

New in version NX5.0.0.

License requirements: None.

GetOptionMenu

Dialog.GetOptionMenu

Gets the dialog item with specified item identifier

Signature GetOptionMenu(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.OptionMenu

New in version NX5.0.0.

License requirements: None.

GetOptionToggle

Dialog.GetOptionToggle

Gets the dialog item with specified item identifier

Signature GetOptionToggle(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.OptionToggle

New in version NX5.0.0.

License requirements: None.

GetPropertyPage

Dialog.GetPropertyPage

Gets the dialog item with specified item identifier

Signature GetPropertyPage(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.PropertyPage

New in version NX5.0.0.

License requirements: None.

GetPushButton

Dialog.GetPushButton

Gets the dialog item with specified item identifier

Signature GetPushButton(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.PushButton

New in version NX5.0.0.

License requirements: None.

GetRadioBox

Dialog.GetRadioBox

Gets the dialog item with specified item identifier

Signature GetRadioBox(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.RadioBox

New in version NX5.0.0.

License requirements: None.

GetRealItem

Dialog.GetRealItem

Gets the dialog item with specified item identifier

Signature GetRealItem(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.RealItem

New in version NX5.0.0.

License requirements: None.

GetRealScale

Dialog.GetRealScale

Gets the dialog item with specified item identifier

Signature GetRealScale(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.RealScale

New in version NX5.0.0.

License requirements: None.

GetRowColumn

Dialog.GetRowColumn

Gets the dialog item with specified item identifier

Signature GetRowColumn(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.RowColumn

New in version NX5.0.0.

License requirements: None.

GetScrolledWindow

Dialog.GetScrolledWindow

Gets the dialog item with specified item identifier

Signature GetScrolledWindow(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.ScrolledWindow

New in version NX5.0.0.

License requirements: None.

GetSelectionBox

Dialog.GetSelectionBox

Gets the dialog item with specified item identifier

Signature GetSelectionBox(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.SelectionBox

New in version NX5.0.0.

License requirements: None.

GetSeparator

Dialog.GetSeparator

Gets the dialog item with specified item identifier

Signature GetSeparator(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.Separator

New in version NX5.0.0.

License requirements: None.

GetSingleSelectList

Dialog.GetSingleSelectList

Gets the dialog item with specified item identifier

Signature GetSingleSelectList(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.SingleSelectList

New in version NX5.0.0.

License requirements: None.

GetStringItem

Dialog.GetStringItem

Gets the dialog item with specified item identifier

Signature GetStringItem(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.StringItem

New in version NX5.0.0.

License requirements: None.

GetStylerItem

Dialog.GetStylerItem

Gets the dialog item with specified item identifier

Signature GetStylerItem(itemIdentifier, type)

Parameters:

• itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter.
• type (NXOpen.UIStyler.DialogItemType) –

Returns:

Return type:

NXOpen.UIStyler.StylerItem

New in version NX5.0.0.

License requirements: None.

GetTabControl

Dialog.GetTabControl

Gets the dialog item with specified item identifier

Signature GetTabControl(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.TabControl

New in version NX5.0.0.

License requirements: None.

GetToggle

Dialog.GetToggle

Gets the dialog item with specified item identifier

Signature GetToggle(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.Toggle

New in version NX5.0.0.

License requirements: None.

GetToolPalette

Dialog.GetToolPalette

Gets the dialog item with specified item identifier

Signature GetToolPalette(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.ToolPalette

New in version NX5.0.0.

License requirements: None.

GetWideString

Dialog.GetWideString

Gets the dialog item with specified item identifier

Signature GetWideString(itemIdentifier)

Parameters:itemIdentifier (str) – Dialog name NOTE: The full Unicode character set is not supported for this parameter. Returns: Return type:NXOpen.UIStyler.WideString

New in version NX5.0.0.

License requirements: None.

RegisterWithUiMenu

Dialog.RegisterWithUiMenu

Registers the dialog with a menu item.

Signature RegisterWithUiMenu(isTopDialog)

Parameters:isTopDialog (bool) –

New in version NX5.0.0.

License requirements: None.

Show

Dialog.Show

Displays an NX (UIStyler generated) “bottom” dialog.

This dialog is displayed to NX. Show Method can only be called once for the dialog object.Once show method is called UIStyler.Dialog.GetStylerItem will create any item

Signature Show()

Returns: Return type:NXOpen.UIStyler.DialogResponse

New in version NX5.0.0.

License requirements: None.