User Guide

Creating a wizard definition page 215

Creating a wizard definition page

The first step in building a custom wizard is to write a VTML file to define the user

interface and output parameters. This section describes the VTML tags used in this

part of the process, and presents an example definition file.

For a complete description of the WIZML tag set, see ../VTML_Reference/

wizml.htmlThe WIZML Language/a in the VTML Reference.

For syntax and usage information of VTML tags used to provide the user interface in

wizard development, see ../VTML_Reference/wizards.htmlWizards/a in the VTML

Reference.

Dynamic expressions in tags

Any tag attribute can combine static, constant text with embedded dynamic

expressions that reference parameters or input controls. To embed an expression

within a text string, the following syntax is utilized:

$${ expression }

So, for example, to set the REQUIRED attribute of a parameter based on whether

another value was set, you would use the following syntax:

<PARAM name="RowsPerPage" value="10"

REQUIRED="$${ ParameterExists('Customize') }">

Or, to customize the OUTPUTFILE attribute of the TEMPLATE tag using a name

attribute entered by the user, you would use the following syntax:

OUTPUTFILE="$${Name}Admin.cfm">

The expression syntax supported within the wizard configuration file is the same as

the one supported in wizard output templates (see the reference section for more

details).

Bound controls

One of the most powerful capabilities of wizard pages is bound controls. Bound

controls allow you to place controls onto the wizard page and have their values

automatically bound to wizard parameters. To do this, simply add an INPUT sub-tag

to the PAGE tag for each control you wish to bind, making sure that the name

attribute of the INPUT tag matches the Name property of the control. All controls

specified in the layout can be bound.

Wizard definition page example

This sample wizard creates an HTML template.