Wizard / Wizard Step

The Wizard layout block provides a control to organize other blocks as steps on wizard pages. You add steps to the wizard using the Wizard Step item from the Block Catalog (available after you select Wizard).

When to use a Wizard

Use the Wizard block for a command if one or more of the following apply:

• The command has a large number of inputs.
• The command follows different workflows depending on user selections and settings.
• The command creates one or more types of objects in a workflow.

A Wizard block also provides a Task Navigator for navigating the pages.

Note: The Wizard block should not be used inside other Layout blocks.

Wizard dialog anatomy

The documented parts of a Wizard dialog include:

• Wizard title
• Step text area
• Step bitmap
• Banner area
• Block area
• Navigation buttons
• Task Navigator

You must place a Wizard Step block inside the Wizard block. Within each Wizard Step, you can place any other block available in the Block Catalog.

Wizard — block-specific properties

Property Name	Description	Access	Property Type	List of Values
Localize	Allows localization of the block label if it matches an English string in the NX localization database.	CIG	Logical	TRUE/FALSE.
(Task Navigator visibility property)	Specifies whether the Task Navigator is displayed by default.	CIG	Logical	TRUE — show the Task Navigator. FALSE — hide the Task Navigator.
StepBannerBitmaps	List of bitmaps for the step bitmaps shown in the banner area.	CIG	Strings	Any valid bitmap image name as a string. Bitmaps of any pixel size can be used; the standard NX wizard size is 48x48 pixels.
StepBitmaps	List of bitmaps for the node bitmaps in the Task Navigator.	CIG	Strings	Any valid bitmap image name as a string. Must be 16x16 pixels.
StepCues	List of Cue lines for the wizard steps. If any selection block is shown on a step, it overrides the Cue line from this list.	CIG	Utfstrings	Text strings.
StepText	List of step descriptions shown in the banner area.	CIG	Utfstrings	Text strings.

Wizard Step — block-specific properties

Property Name	Description	Access	Property Type	List of Values
Localize	Allows localization of the block label if it matches an English string in the NX localization database.	CIG	Logical	TRUE — translate to current locale. FALSE — do not translate.
Members	Lists the blocks created under this Wizard Step.	G	Array	Object of type NXOpen.BlockStyler.PropertyList, an indexed list. Each block is obtained via GetUIBlock(Index).
Column	Specifies the number of columns in which the contained blocks can be arranged.	CIG	Integer	Any integer value greater than 0.

Access column legend

Character	Stands for	Meaning
C	Creation	Modifiable interactively in Block UI Styler at design time.
I	Initialize	Modifiable at run time via NXOpen API, but only during the Initialize callback.
G	Get	Readable via NXOpen API in any callback.
S	Set	Modifiable at run time via NXOpen API in any callback.

See also

Wizard properties and callbacks (source wiz_block_ref) — additional reference for Wizard-specific callback wiring.

Related Layout blocks

Group, Scrolled Window, Tab Control, Table Layout, Explorer block.