C. Parameters

## C. Parameters

<booleanParameter>
Request a boolean value from the user.
property | default value | allowed values | description
`displayStyle` | `radiobuttons` | radiobuttons, checkbox-left, checkbox-right | Display style in GUI mode
`Common properties:` `name, title, description, explanation, value, default, ask, cliOptionName, cliOptionShow, cliOptionText, insertAfter, insertBefore, leftImage, ruleEvaluationLogic, postShowPageActionList, preShowPageActionList, ruleList, validationActionList`

<booleanParameterGroup>
Allows you to create custom pages
property | default value | allowed values | description
`orientation` | `vertical` | vertical, horizontal | Set orientation for objects in the group. It can only be horizontal or vertical. If not specified, defaults to vertical.
`validationType` | `always` | always, ifSelected | Validation type
`parameterList` | `` | `<parameter>` | List of parameters to group
`Common properties:` `name, title, description, explanation, value, default, ask, cliOptionName, cliOptionShow, cliOptionText, insertAfter, insertBefore, leftImage, ruleEvaluationLogic, postShowPageActionList, preShowPageActionList, ruleList, validationActionList`

<choiceParameter>
Ask the user to select a value among a predefined list.
property | default value | allowed values | description
`allowEmptyValue` | `1` | 0, 1 | Whether or not to allow an empty value. This property does not allow variables.
`displayType` | `` | combobox, radiobuttons | Choose an entry in a listbox or among a number of radiobuttons.
`ordering` | `` | default, alphabetical, alphabeticalreverse | Order in which the text of choices will be displayed at runtime
`width` | `` | string | Width in characters of the corresponding field in the GUI page. If not specified, it defaults to 40.
`optionList` | `` | `<option>` | Predefined list of options that allows the user to select a value
`Common properties:` `name, title, description, explanation, value, default, ask, cliOptionName, cliOptionShow, cliOptionText, insertAfter, insertBefore, leftImage, ruleEvaluationLogic, postShowPageActionList, preShowPageActionList, ruleList, validationActionList`

<choiceParameterGroup>
Allows you to create custom pages
property | default value | allowed values | description
`orientation` | `vertical` | vertical, horizontal | Set orientation for objects in the group. It can only be horizontal or vertical. If not specified, defaults to vertical.
`unselectedOptionsBehavior` | `disable` | disable, none | How unselected options will behave. This property does not allow variables.
`parameterList` | `` | `<parameter>` | List of parameters to group
`Common properties:` `name, title, description, explanation, value, default, ask, cliOptionName, cliOptionShow, cliOptionText, insertAfter, insertBefore, leftImage, ruleEvaluationLogic, postShowPageActionList, preShowPageActionList, ruleList, validationActionList`

<directoryParameter>
Ask the user to enter a directory
property | default value | allowed values | description
`allowEmptyValue` | `0` | 0, 1 | Whether or not to allow an empty value. This property does not allow variables.
`mustBeWritable` | `0` | 0, 1 | Whether or not to require that the directory must be writable.
`mustExist` | `0` | 0, 1 | Whether or not to require that the directory must already exist.
`osxBundlesAreFiles` | `0` | 0, 1 | Whether or not OS X bundles (*.app and *.bundle) will be considered files. The setting will just have effect on OS X, in other platforms they will be always considered directories
`width` | `` | string | Width in characters of the corresponding field in the GUI page. If not specified, it defaults to 40.
`Common properties:` `name, title, description, explanation, value, default, ask, cliOptionName, cliOptionShow, cliOptionText, insertAfter, insertBefore, leftImage, ruleEvaluationLogic, postShowPageActionList, preShowPageActionList, ruleList, validationActionList`

<fileParameter>
Ask the user to enter a file
property | default value | allowed values | description
`allowEmptyValue` | `0` | 0, 1 | Whether or not to allow an empty value. This property does not allow variables.
`mustBeWritable` | `0` | 0, 1 | Whether or not to require that the file must be writable.
`mustExist` | `0` | 0, 1 | Whether or not to require that the file must already exist.
`osxBundlesAreFiles` | `0` | 0, 1 | Whether or not OS X bundles (*.app and *.bundle) will be considered files. The setting will just have effect on OS X, in other platforms they will be always considered directories
`width` | `` | string | Width in characters of the corresponding field in the GUI page. If not specified, it defaults to 40.
`Common properties:` `name, title, description, explanation, value, default, ask, cliOptionName, cliOptionShow, cliOptionText, insertAfter, insertBefore, leftImage, ruleEvaluationLogic, postShowPageActionList, preShowPageActionList, ruleList, validationActionList`

<infoParameter>
Display a read-only text information page.
property | default value | allowed values | description
`htmlValue` | `` | text | HTML text that will be shown in Qt mode. Note that regular text still needs to be provided in case the installer is run in another mode
`trimMarginNumChars` | `` | string | Removes the specified number of characters from the left margin
`Common properties:` `name, title, description, explanation, value, default, ask, cliOptionName, cliOptionShow, cliOptionText, insertAfter, insertBefore, leftImage, ruleEvaluationLogic, postShowPageActionList, preShowPageActionList, ruleList, validationActionList`

<labelParameter>
The label parameter displays a string of read-only text.
property | default value | allowed values | description
`image` | `` | string | Optional image to display
`Common properties:` `name, title, description, explanation, value, default, ask, cliOptionName, cliOptionShow, cliOptionText, insertAfter, insertBefore, leftImage, ruleEvaluationLogic, postShowPageActionList, preShowPageActionList, ruleList, validationActionList`

<licenseParameter>
Display a license
property | default value | allowed values | description
`file` | `` | string | File that will be displayed as license
`fileEncoding` | `iso8859-1` | iso8859-1, iso8859-2, utf-8, cp1251, cp1252, ascii, macRoman, unicode | File encoding type
`htmlFile` | `` | string | HTML file that will be displayed as license
`wrapText` | `0` | 0, 1 | Wrap text. This property does not allow variables.
`licenseFileList` | `` | `<licenseFile>` | List of licenses
`Common properties:` `name, title, description, explanation, value, default, ask, cliOptionName, cliOptionShow, cliOptionText, insertAfter, insertBefore, leftImage, ruleEvaluationLogic, postShowPageActionList, preShowPageActionList, ruleList, validationActionList`

<linkParameter>
The linkParameter displays an hyperlink-like label or a button, which executes an actionList when clicked.
property | default value | allowed values | description
`clickedActionList` | `` | `<action>` | List of actions to execute on click
`Common properties:` `name, title, description, explanation, value, default, ask, cliOptionName, cliOptionShow, cliOptionText, insertAfter, insertBefore, leftImage, ruleEvaluationLogic, postShowPageActionList, preShowPageActionList, ruleList, validationActionList`

<parameterGroup>
Allows you to create custom pages
property | default value | allowed values | description
`orientation` | `vertical` | vertical, horizontal | Set orientation for objects in the group. It can only be horizontal or vertical. If not specified, defaults to vertical.
`parameterList` | `` | `<parameter>` | List of parameters to group
`Common properties:` `name, title, description, explanation, value, default, ask, cliOptionName, cliOptionShow, cliOptionText, insertAfter, insertBefore, leftImage, ruleEvaluationLogic, postShowPageActionList, preShowPageActionList, ruleList, validationActionList`

<passwordParameter>
Allow the user to input a password.
property | default value | allowed values | description
`allowEmptyValue` | `1` | 0, 1 | Whether or not to allow an empty value. This property does not allow variables.
`askForConfirmation` | `1` | 0, 1 | If set to zero, the retype password field won’t be shown. This property does not allow variables.
`descriptionRetype` | `` | string | Description of retype field
`width` | `` | string | Width in characters of the corresponding field in the GUI page. If not specified, it defaults to 40.
`Common properties:` `name, title, description, explanation, value, default, ask, cliOptionName, cliOptionShow, cliOptionText, insertAfter, insertBefore, leftImage, ruleEvaluationLogic, postShowPageActionList, preShowPageActionList, ruleList, validationActionList`

<stringParameter>
The string parameter allows you to request a text string from the user. It accepts all of the common options.
property | default value | allowed values | description
`allowEmptyValue` | `1` | 0, 1 | Whether or not to allow an empty value. This property does not allow variables.
`width` | `` | string | Width in characters of the corresponding field in the GUI page. If not specified, it defaults to 40.
`Common properties:` `name, title, description, explanation, value, default, ask, cliOptionName, cliOptionShow, cliOptionText, insertAfter, insertBefore, leftImage, ruleEvaluationLogic, postShowPageActionList, preShowPageActionList, ruleList, validationActionList`

<parameter> - Common Properties
Allows you to create custom pages
property | default value | allowed values | description
`name` | `` | string | Name of the parameter. This will be used to create the corresponding installer environment variable and command line option and because of that, it may only contain alphanumerical characters. This property does not allow variables.
`title` | `` | string | Title that will be displayed for the corresponding installer page. If none is specified, the description field will be used instead.
`description` | `` | text | Short description for the parameter
`explanation` | `` | text | Long description for the parameter
`value` | `` | string | Value for the parameter.
`default` | `` | string | Default value, in case one is not specified by the user.
`ask` | `1` | 0, 1 | Whether or not to show or not the page to the end user (it can still be set through the command line interface). This property does not allow variables.
`cliOptionName` | `` | string | Text to use for setting the value of the parameter through the command line interface. If none is used, it will default to the value of the name field.
`cliOptionShow` | `1` | 0, 1 | Whether or not the command line option will be shown in the command line when the help text is displayed. This property does not allow variables.
`cliOptionText` | `` | string | Text to use when displaying help options. If none is used, it will default to the value of the description field.
`insertAfter` | `` | string | Name of the page after the one in which this custom page will be installed
`insertBefore` | `` | string | Name of the page previous to the one in which this custom page will be installed
`leftImage` | `` | string | Image to show when displaying GUI installers with custom style
`ruleEvaluationLogic` | `and` | and, or | Rule evaluation logic, by default rules are evaluated with and logic
`postShowPageActionList` | `` | `<action>` | List of actions to execute after clicking next
`preShowPageActionList` | `` | `<action>` | List of actions to execute before displaying the parameter
`ruleList` | `` | `<rule>` | Contains a set of rules or conditions
`validationActionList` | `` | `<action>` | List of validation actions to execute after clicking next

B. Rules |  | D. Project Properties and Lists