Product Option attributes
A Product Option defines a piece of functionality that the customer can select or not select for installation. A product option can contain suboptions in a hierarchical fashion; internally, an option also contains references to the components that must be installed to provide the functionality that the option offers. See Product Options for an overview.
Attributes
This pane contains the following attributes and options.
| Attribute | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Option name |
Enter the name of the product option. This name is used to refer to the option in conditional expressions elsewhere in the project, but is not visible to the user. Each option must have a name that is unique within the project. |
||||||||||||
| Display title | Enter the name of the option for display in the installer's user interface OptionTree control. | ||||||||||||
| Description | Enter the description of the option for display in the installer's user interface. | ||||||||||||
| Folder alias |
Enter the folder alias of the installation folder that is associated with the option, or click ... (browse) to open the Select Installation Folder dialog box that allows you to select one. The path to this folder can be configured in the installer's user interface if you select the Allow folder browsing option (below). |
||||||||||||
| Condition | Enter a conditional expression that determines the option state during installation, or leave empty if the option state is unconditional. Depending on the condition, the option's state is set to either Initial state or New state (see below). InstallMate evaluates option conditions during its InitFeatures standard action. | ||||||||||||
| Build condition |
Enter a conditional expression that determines if the option will be included in the build, or leave empty if the option must be included in all builds. The build condition is evaluated during the preflight test for each build configuration; you can use the Build variables attribute in the Build Configuration pane to control if the option will be included for a particular configuration. If the condition evaluates to false, the option and all its suboptions are excluded from the build process for the configuration. This in turn might cause one or more components and their objects to be excluded as well. |
||||||||||||
| Mutually exclusive suboptions | Check this box to configure the option's suboptions as mutually exclusive; clear it for regular suboptions. Mutually exclusive suboptions appear as radio buttons instead of check boxes; only one mutually exclusive suboption can be selected at a time. | ||||||||||||
| Allow folder browsing |
Check this box to allow the user to select the folder path for the option's folder as defined by its Folder alias attribute; clear it to prevent folder browsing. InstallMate implements folder browsing by linking an EditText control to the appropriate folder alias, optionally combined with a Browse for Folder Standard Dialog action. The control or dialog should be linked indirectly to the TsuFeatureFolderAlias variable to follow the currently selected feature in the OptionTree control, or linked directly to any other folder alias variable. The default OptionsDlg dialog box demonstrates this. |
||||||||||||
| Initial state |
Select the initial option state from the drop-down list. The following choices are available:
The initial option state is used if the option's Condition attribute is empty, or if the condition evaluates to false. |
||||||||||||
| New state |
Select the option state for the feature if the Condition attribute evaluates to true. The choices are the same as for Initial state. |
||||||||||||
| Extra size |
Enter the additional installation size (in bytes) for the option, or leave empty if the option only installs what its components and subfeatures contain. This option is useful if you use the product option as a user-selectable option that is used in custom actions to download, copy, or otherwise install additional files. Setting this option to the (approximate) additional installation size then helps the user and the installer to estimate the required total installation size. |