Set Component State action
The Set Component State action changes the state of its target component. It can select, unselect, enable or disable the target component; any changes made through this action are reflected in the active OptionTree control, if any. See Component states below for the complete list of settable states.
Note: The new component state is maintained until changed by the user through a OptionTree control or by the installer through another Set Component State action. In addition, if the InitComponents standard action is executed, all components are reset to their initial or conditional state.
Component states
The following new component states can be set by this action. With the exception of Default and Toggle, they are the same as the states available in the Component attributes.
Component is visible in UI option | ||
---|---|---|
New state | Checked | Unchecked |
Default | Resets the component to its default state, which is either the Initial state or the New state as determined by the Component attributes and the current evaluation of the component's Condition. Tip: This state action is useful to re-initialize a single component if you know that its Condition might have changed. To re-initialize all components, use the InitComponents standard action instead. |
same |
Unavailable | The component is unavailable and will not be displayed in the installer's user interface. Note: This only applies if the component state is set before a OptionTree control is shown. If the component state changes to Unavailable while the control is present, the component will be shown as Disabled. |
The component is not selected. |
Disabled | The component is displayed in the installer's user interface, but in a disabled state and cannot be selected by the user. | The component is not selected. |
Not selected | The component is displayed in the installer's user interface, but not selected. | The component is not selected. |
Selected | The component is displayed and selected in the installer's user interface. | The component is selected. |
Always selected | The component is displayed and selected in the installer's user interface, and cannot be unselected. The component state can still be changed through another Set Component State action. | The component is selected. |
Toggle | The component's state toggles between Selected and Not selected if it currently is in one of those states; otherwise the state doesn't change. This is equivalent to the user selecting a component in the active OptionTree control, if any. | same |
Attributes
The following attributes and options are available.
Attribute | Description |
---|---|
Action name | Enter the name of the action. This name is only used in InstallMate and is not visible to the user. |
Component | Select the desired target component by clicking the ... (browse) button to the right of this field to open the Select Component dialog box that allows you to select the desired option. |
New state | Select the desired new component state. The available states are explained under Component states. |
Condition | Enter the conditional expression that determines if the action will be executed, or leave empty for unconditional execution. |
Disabled | Check this box to disable the action. A disabled action is not included in the installer and not checked during the build. You can use this option to remove actions temporarily from your installer without permanently deleting them. Disabled actions are shown with a grayed-out icon. |
Platforms... | Click this button to open the Select Installation Platforms dialog box that allows you to select the Windows versions on which the action must be executed. This platform selection acts as an additional condition for the action. |