BlockDialog Class¶

class NXOpen.BlockStyler.BlockDialog¶

Bases: NXOpen.TransientObject

Represents a Dialog

New in version NX6.0.0.

Properties¶

Property	Description
TopBlock	Returns a composite block that contains all the blocks in the dialog

Methods¶

Method	Description
AddApplyHandler	Adds Apply callback handler to the dialog.
AddCancelHandler	Adds Cancel callback handler to the dialog.
AddCloseHandler	Adds Close callback handler to the dialog.
AddDialogShownHandler	Adds Dialog Shown callback handler to the dialog.
AddEnableOKButtonHandler	Adds enable-ok-button callback handler to the dialog.
AddFilterHandler	Adds Filter callback handler to the dialog.
AddFocusNotifyHandler	Adds focus notify callback handler to the dialog.
AddInitializeHandler	Adds Initialize callback handler to the dialog.
AddKeyboardFocusNotifyHandler	Adds keyboard focus notify callback handler to the dialog.
AddOkHandler	Adds Ok callback handler to the dialog.
AddUpdateHandler	Adds Update callback handler to the dialog.
Dispose	Frees the object from memory.
GetBlockProperties	Gets the properties of a block @return
PerformApply	Performs an Apply and restarts the dialog.
RegisterUserDefinedUIBlock	Registers the reusable block with the dialog
Show	Shows the dialog in `BlockStyler.BlockDialogDialogMode.Create` mode.

Enumerations¶

BlockDialogDialogMode Enumeration

Datatype containing options for showing the dialog

Property Detail¶

TopBlock¶

BlockDialog.TopBlock¶

Returns a composite block that contains all the blocks in the dialog

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

Getter Method

Signature TopBlock()

Returns:
Return type:	`NXOpen.BlockStyler.CompositeBlock`

New in version NX6.0.0.

License requirements: None.

Method Detail¶

AddApplyHandler¶

BlockDialog.AddApplyHandler¶

Adds Apply callback handler to the dialog.

Signature AddApplyHandler(applyCb)

Parameters:	applyCb (CallableObject) –

New in version NX6.0.0.

License requirements: None.

AddCancelHandler¶

BlockDialog.AddCancelHandler¶

Adds Cancel callback handler to the dialog.

Signature AddCancelHandler(cancelCb)

Parameters:	cancelCb (CallableObject) –

New in version NX6.0.0.

License requirements: None.

AddCloseHandler¶

BlockDialog.AddCloseHandler¶

Adds Close callback handler to the dialog.

Signature AddCloseHandler(closeCb)

Parameters:	closeCb (CallableObject) –

New in version NX8.5.0.

License requirements: None.

AddDialogShownHandler¶

BlockDialog.AddDialogShownHandler¶

Adds Dialog Shown callback handler to the dialog.

The callback function is called before the dialog is shown. The callback can be used to overwrite changes that are made during dialog initialization when user inputs saved in dialog memory are applied to the dialog.

Signature AddDialogShownHandler(cb)

Parameters:	cb (CallableObject) –

New in version NX6.0.0.

License requirements: None.

AddEnableOKButtonHandler¶

BlockDialog.AddEnableOKButtonHandler¶

Adds enable-ok-button callback handler to the dialog.

Signature AddEnableOKButtonHandler(cb)

Parameters:	cb (CallableObject) –

New in version NX7.5.3.

License requirements: None.

AddFilterHandler¶

BlockDialog.AddFilterHandler¶

Adds Filter callback handler to the dialog.

Signature AddFilterHandler(cb)

Parameters:	cb (CallableObject) –

New in version NX6.0.0.

License requirements: None.

AddFocusNotifyHandler¶

BlockDialog.AddFocusNotifyHandler¶

Adds focus notify callback handler to the dialog.

Signature AddFocusNotifyHandler(cb)

Parameters:	cb (CallableObject) –

New in version NX6.0.2.

License requirements: None.

AddInitializeHandler¶

BlockDialog.AddInitializeHandler¶

Adds Initialize callback handler to the dialog.

The callback function is called while the dialog is being initialized. The callback is called before applying any user inputs saved in dialog memory.

Signature AddInitializeHandler(cb)

Parameters:	cb (CallableObject) –

New in version NX6.0.0.

License requirements: None.

AddKeyboardFocusNotifyHandler¶

BlockDialog.AddKeyboardFocusNotifyHandler¶

Adds keyboard focus notify callback handler to the dialog.

Signature AddKeyboardFocusNotifyHandler(cb)

Parameters:	cb (CallableObject) –

New in version NX7.5.0.

License requirements: None.

AddOkHandler¶

BlockDialog.AddOkHandler¶

Adds Ok callback handler to the dialog.

Signature AddOkHandler(okCb)

Parameters:	okCb (CallableObject) –

New in version NX6.0.0.

License requirements: None.

AddUpdateHandler¶

BlockDialog.AddUpdateHandler¶

Adds Update callback handler to the dialog.

Signature AddUpdateHandler(cb)

Parameters:	cb (CallableObject) –

New in version NX6.0.0.

License requirements: None.

Dispose¶

BlockDialog.Dispose¶

Frees the object from memory.

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

Signature Dispose()

New in version NX6.0.0.

License requirements: None.

GetBlockProperties¶

BlockDialog.GetBlockProperties¶

Gets the properties of a block

Signature GetBlockProperties(blockName)

Parameters:	blockName (str) – BlockID of the block
Returns:
Return type:	`NXOpen.BlockStyler.PropertyList`

New in version NX8.5.0.

License requirements: None.

PerformApply¶

BlockDialog.PerformApply¶

Performs an Apply and restarts the dialog.

This invokes the apply callback on the dialog. This method is meant to be called when the dialog is shown and while inside the update callback.

Signature PerformApply()

New in version NX6.0.0.

License requirements: None.

RegisterUserDefinedUIBlock¶

BlockDialog.RegisterUserDefinedUIBlock¶

Registers the reusable block with the dialog

Signature RegisterUserDefinedUIBlock(blockDialog, blockId)

Parameters:	blockDialog (`NXOpen.BlockStyler.BlockDialog`) – Dialog which contains the reusable block blockId (str) – “Block ID” of reusable block

New in version NX8.0.0.

License requirements: None.

Show¶

BlockDialog.Show¶

Overloaded method Show

Show()
Show(dialogMode)

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

Shows the dialog in BlockStyler.BlockDialogDialogMode.Create mode. This method will not return until the dialog is closed, which typically is when the dialog’s OK or Cancel button is pressed.

Signature Show()

Returns:
Return type:	`NXOpen.SelectionResponse`

New in version NX6.0.0.

License requirements: None.

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

Shows the dialog based upon the mode specified in BlockStyler.BlockDialogDialogMode. This method will not return until the dialog is closed, which typically is when the dialog’s OK or Cancel button is pressed.

Signature Show(dialogMode)

Parameters:	dialogMode (`NXOpen.BlockStyler.BlockDialogDialogMode`) – Dialog mode as Create or Edit. `BlockStyler.BlockDialogDialogMode`
Returns:
Return type:	`NXOpen.SelectionResponse`

New in version NX6.0.0.

License requirements: None.

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