Custom Document Wizard Arguments

To display the Custom Document Wizard Arguments dialog box, select Tools > Options from the Stylus Studio menu. Click Custom Document Wizards. In the Custom Document Wizards dialog box, click Arguments.

Use the Arguments dialog box to specify the properties for the arguments required to run a custom document wizard. Stylus Studio uses the properties to display a dialog box for your custom document wizard. The end-user enters values for the arguments and then Stylus Studio maps the values to the variables in the custom document wizard command line.

The order in which the arguments appear in the Custom Document Wizard Arguments dialog box is the order in which they appear in the dialog box that Stylus Studio generates for user input before running your wizard.

Fields

Name

Specify the name of the argument that would appear in the command line that executes your application. Required.

Description

Specify some text that indicates the purpose of this argument. When Stylus Studio generates the dialog box for your custom document wizard, it uses the text you specify here as the field name that prompts the user to enter a value. The user then enters a value for this argument. Required.

Flag

This property allows you to specify a string that Stylus Studio uses as a prefix to the argument value the user specifies. When Stylus Studio generates the command line for executing your application, it inserts the flag you specify followed by a space followed by the value that the user specifies for the argument. For example, you might specify leading punctuation such as a dash (-) or forward slash (/).

The Flag property is required for Boolean arguments. It is optional for arguments of other data types. When the value of a Boolean argument is true, Stylus Studio inserts the value of the Flag property in the command line for executing your application.

Type

Specify the data type of the argument. This can be boolean, string, InputFile, or OutputFile.

Default Value

Specify a default value for this argument if it is an optional argument. Stylus Studio uses this default value if the argument is optional and the end-user does not specify a value. If you specify a default value for an argument that is required, Stylus Studio ignores the default value. If an end-user does not specify a value for a required argument, Stylus Studio displays a message that reminds the end-user that the argument is required.

If the type of an argument is OutputFile, you cannot specify a default value.

Optional

Boolean value that indicates whether this argument is required for this custom document wizard. When the type of an argument is OutputFile, the value of the Optional property is always False and you cannot change it. That is, when the type of an argument is OutputFile, the end-user must specify an argument value.

Buttons

Define a new argument.

Delete the selected argument.

Move the selected argument one place up in the list of arguments. The order of the arguments here determines the correspondence to the %1, %2, %3, and so on, variables.

Move the selected custom document wizard one place down in the list of custom tools.

For More Information