Wizard Class¶

class NXOpen.BlockStyler.Wizard¶

Bases: NXOpen.BlockStyler.UIBlock

Represents a Wizard block

New in version NX7.5.0.

Properties¶

Property	Description
CurrentStep	Returns or sets the CurrentStep.
Enable	Returns or sets the Enable.
Expanded	Returns or sets the Expanded
Group	Returns or sets the Group
HighQualityBitmap	Returns or sets the HighQualityBitmap.
Label	Returns or sets the Label
Localize	Returns or sets the Localize.
Members	Returns the Members
Name	Returns the name of the block or BlockID
Show	Returns or sets the Visibility of block.
ShowTaskNavigator	Returns or sets the ShowTaskNavigator.
Tag	Returns the Tag for this object.
Type	Returns the type of block

Methods¶

Method	Description
CreateMenu	Creates a popup menu.
CreateStepSubNode	Create a sub-node for a step in the Task Navigator.
Focus	Focuses on the block.
GetProperties	Returns the properties of the block @return
GetStepBannerBitmaps	Gets the StepBannerBitmaps.
GetStepBitmaps	Gets the StepBitmaps.
GetStepCues	Gets the StepCues.
GetStepText	Gets the StepText.
RemoveStepSubNode	Remove a sub-node in the Task Navigator.
SetIsStepOkayHandler	Sets the IsStepOkay handler.
SetMenu	Set the menu items for the popup menu for a step, sub-node or the background in the Task Navigator.
SetOnMenuHandler	Sets the OnMenu handler.
SetOnMenuSelectionHandler	Sets the OnMenuSelection handler.
SetOnSubNodeHandler	Sets the OnSubNode handler.
SetStepBannerBitmaps	Sets the StepBannerBitmaps.
SetStepBitmaps	Sets the StepBitmaps.
SetStepCues	Sets the StepCues.
SetStepNotifyPostHandler	Sets the StepNotifyPost handler.
SetStepNotifyPreHandler	Sets the StepNotifyPre handler.
SetStepText	Sets the StepText.

Enumerations¶

WizardSubNodeAction Enumeration	Specifies the type of action performed on a sub-node in the Wizard Task Navigator.
WizardTaskNavigatorItem Enumeration	Specifies an item in the Task Navigator.

Property Detail¶

CurrentStep¶

Wizard.CurrentStep¶

Returns or sets the CurrentStep.

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

Getter Method

Signature CurrentStep()

Returns:
Return type:	int

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature CurrentStep(currentStep)

Parameters:	currentStep (int) –

New in version NX8.5.0.

License requirements: None.

HighQualityBitmap¶

Wizard.HighQualityBitmap¶

Returns or sets the HighQualityBitmap.

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

Getter Method

Signature HighQualityBitmap()

Returns:
Return type:	bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature HighQualityBitmap(highQuality)

Parameters:	highQuality (bool) –

New in version NX8.5.0.

License requirements: None.

Localize¶

Wizard.Localize¶

Returns or sets the Localize.

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

Getter Method

Signature Localize()

Returns:
Return type:	bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature Localize(localize)

Parameters:	localize (bool) –

New in version NX8.5.0.

License requirements: None.

Members¶

Wizard.Members¶

Returns the Members

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

Getter Method

Signature Members()

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

New in version NX8.5.0.

License requirements: None.

ShowTaskNavigator¶

Wizard.ShowTaskNavigator¶

Returns or sets the ShowTaskNavigator.

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

Getter Method

Signature ShowTaskNavigator()

Returns:
Return type:	bool

New in version NX8.5.0.

License requirements: None.

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

Setter Method

Signature ShowTaskNavigator(show)

Parameters:	show (bool) –

New in version NX8.5.0.

License requirements: None.

Method Detail¶

CreateMenu¶

Wizard.CreateMenu¶

Creates a popup menu.

Use BlockStyler.Wizard.SetMenu() to set the created menu. See the BlockStyler.TreeListMenu for information on creating a menu.

Signature CreateMenu()

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

New in version NX7.5.0.

License requirements: None.

CreateStepSubNode¶

Wizard.CreateStepSubNode¶

Create a sub-node for a step in the Task Navigator.

Signature CreateStepSubNode(step, text, bitmap, showCheckBox, checkBoxChecked)

Parameters:	step (int) – The step to add a sub-node. text (str) – Text for the sub-node. bitmap (str) – Optional bitmap for the sub-node. showCheckBox (bool) – Associate an optional check box with the sub-node checkBoxChecked (bool) – The initial state of the check box.
Returns:	Unique id for the sub-node.
Return type:	int

New in version NX7.5.0.

License requirements: None.

GetStepBannerBitmaps¶

Wizard.GetStepBannerBitmaps¶

Gets the StepBannerBitmaps.

Gets the list of bitmaps for the step bitmaps in the banner area.

Signature GetStepBannerBitmaps()

Returns:
Return type:	list of str

New in version NX8.5.0.

License requirements: None.

GetStepBitmaps¶

Wizard.GetStepBitmaps¶

Gets the StepBitmaps.

Gets the list of bitmaps for the node bitmaps in the Task Navigator.

Signature GetStepBitmaps()

Returns:
Return type:	list of str

New in version NX8.5.0.

License requirements: None.

GetStepCues¶

Wizard.GetStepCues¶

Gets the StepCues.

Gets the list of cue lines for the wizard steps.

Signature GetStepCues()

Returns:
Return type:	list of str

New in version NX8.5.0.

License requirements: None.

GetStepText¶

Wizard.GetStepText¶

Gets the StepText.

Gets the list of step descriptions for the banner area.

Signature GetStepText()

Returns:
Return type:	list of str

New in version NX8.5.0.

License requirements: None.

RemoveStepSubNode¶

Wizard.RemoveStepSubNode¶

Remove a sub-node in the Task Navigator.

Signature RemoveStepSubNode(subNodeId)

Parameters:	subNodeId (int) – The sub-node id.

New in version NX7.5.0.

License requirements: None.

SetIsStepOkayHandler¶

Wizard.SetIsStepOkayHandler¶

Sets the IsStepOkay handler.

Signature SetIsStepOkayHandler(cb)

Parameters:	cb (CallableObject) –

New in version NX7.5.0.

License requirements: None.

SetMenu¶

Wizard.SetMenu¶

Set the menu items for the popup menu for a step, sub-node or the background in the Task Navigator.

See the BlockStyler.TreeListMenu for information on creating a menu.

Signature SetMenu(menu)

Parameters:	menu (`NXOpen.BlockStyler.TreeListMenu`) –

New in version NX7.5.0.

License requirements: None.

SetOnMenuHandler¶

Wizard.SetOnMenuHandler¶

Sets the OnMenu handler.

Signature SetOnMenuHandler(cb)

Parameters:	cb (CallableObject) –

New in version NX7.5.0.

License requirements: None.

SetOnMenuSelectionHandler¶

Wizard.SetOnMenuSelectionHandler¶

Sets the OnMenuSelection handler.

Signature SetOnMenuSelectionHandler(cb)

Parameters:	cb (CallableObject) –

New in version NX7.5.0.

License requirements: None.

SetOnSubNodeHandler¶

Wizard.SetOnSubNodeHandler¶

Sets the OnSubNode handler.

Signature SetOnSubNodeHandler(cb)

Parameters:	cb (CallableObject) –

New in version NX7.5.0.

License requirements: None.

SetStepBannerBitmaps¶

Wizard.SetStepBannerBitmaps¶

Sets the StepBannerBitmaps.

Sets the list of bitmaps for the step bitmaps in the banner area.

Signature SetStepBannerBitmaps(bitmaps)

Parameters:	bitmaps (list of str) –

New in version NX8.5.0.

License requirements: None.

SetStepBitmaps¶

Wizard.SetStepBitmaps¶

Sets the StepBitmaps.

Sets the list of bitmaps for the node bitmaps in the Task Navigator.

Signature SetStepBitmaps(bitmaps)

Parameters:	bitmaps (list of str) –

New in version NX8.5.0.

License requirements: None.

SetStepCues¶

Wizard.SetStepCues¶

Sets the StepCues.

Sets the list of cue lines for the wizard steps.

Signature SetStepCues(cues)

Parameters:	cues (list of str) –

New in version NX8.5.0.

License requirements: None.

SetStepNotifyPostHandler¶

Wizard.SetStepNotifyPostHandler¶

Sets the StepNotifyPost handler.

Signature SetStepNotifyPostHandler(cb)

Parameters:	cb (CallableObject) –

New in version NX7.5.0.

License requirements: None.

SetStepNotifyPreHandler¶

Wizard.SetStepNotifyPreHandler¶

Sets the StepNotifyPre handler.

Signature SetStepNotifyPreHandler(cb)

Parameters:	cb (CallableObject) –

New in version NX7.5.0.

License requirements: None.

SetStepText¶

Wizard.SetStepText¶

Sets the StepText.

Sets the list of step descriptions for the banner area.

Signature SetStepText(text)

Parameters:	text (list of str) –

New in version NX8.5.0.

License requirements: None.