wizard

wizard

Prefixwizard
Library path/tags/wizard
CFImport

<wizard:break ...>

XML StyleYes

Attributes

<wizard:object ...>

NameTypeRequiredDefaultOptionsDescription
None
XML StyleYes

Attributes

NameTypeRequiredDefaultOptionsDescription
ObjectIDstringNoObjectID of object to render
stObjectstringNo#structNew()#Object to render
typenamestringNoType of Object to render
ObjectLabelstringNoUsed to group and label rendered object if required
lFieldsstringNoList of fields to render
lExcludeFieldsstringNolabelList of fields to exclude from render
classstringNoclass with which to set all farcry form tags
stylestringNostyle with which to set all farcry form tags
formatstringNoeditedit or display
IncludeLabelstringNo1
labelClassstringNocontrol-labelThe class to be applied to all labels
IncludeFieldSetstringNo1
legendstringNofieldset legend
helpTitlestringNotitle for the help section
helpSectionstringNotext to provide help information for the fieldset
IncludeBRstringNo1
InTablestringNo0
insidePLPstringNo0how are we rendering the form
r_stFieldsstringNothe name of the structure that is to be returned with the form field information.
stPropMetadatastringNo#structNew()#This is used to override the default metadata as setup in the type.cfc
wizardIDstringNoIf this object call is part of a wizard, the object will be retrieved from the wizard storage
bValidationstringNotrueFlag to determine if client side validation classes are added to this section of the form.
lHiddenFieldsstringNoList of fields to render as hidden fields that can be use to inject a value into the form post.
stPropValuesstringNo#structNew()#
r_stwizardstringNostwizardThe name of the CALLER variable that contains the stwizard structure
bShowFieldHintsbooleanNotrueFlag to determine if the field hints are display.
prefixstringNoAllows the developer to pass in the prefix they wish to use. Default is the objectid stripped of the dashes.

<wizard:processwizard ...>

XML StyleYes

Attributes

NameTypeRequiredDefaultOptionsDescription
r_stwizardstringNostwizardName of structure to return the stwizard to the Caller.
excludeActionstringNoAny actions to exclude
stepstringNo*

<wizard:processwizardobjects ...>

XML StyleYes

Attributes

NameTypeRequiredDefaultOptionsDescription
stObjstringNo#structNew()#
ObjectIDstringNo
typenamestringNo
stPropMetadatastringNo#structNew()#
r_stPropertiesstringNostProperties
r_stwizardstringNostwizard
stPropMethodsstringNo#structNew()#
PackageTypestringNotypes
lArrayListGeneratestringNo

<wizard:step ...>

XML StyleYes

Attributes

NameTypeRequiredDefaultOptionsDescription
NamestringNo
lFieldsstringNo
legendstringNo
autoGetFieldsstringNo0
RequiredPermissionsstringNoIf the user sends through a list of permissions for this step, only users with correct permissions will be granted access.

<wizard:wizard ...>

XML StyleYes

Attributes

NameTypeRequiredDefaultOptionsDescription
ReferenceIDstringNoThis can be either a UUID of an object or a typename in which case it will create a default structure of the type
ReturnLocationstringNo
TimeoutstringNo15Default timeout of wizard of 15 minutes
r_stwizardstringNostwizardthis is the WDDX packet that will be returned
titlestringNo
iconstringNo
namestringNofarcryForm#randrange(1,999999999)#
TargetstringNo
ActionstringNo
methodstringNopost
onsubmitstringNo
ClassstringNo
StylestringNo
ValidationstringNo1
bAddFormCSSstringNotrueUses uniform (http://sprawsm.com/uni-form/)
bFieldHighlightstringNotrueHighlight fields when focused
bFocusFirstFieldstringNotrueFocus on first wizard element.