This control allows you select or clear a configuration option and behaves as a traditional UI check box. This control has a corresponding label that you can use to describe the purpose of the check box. The state of this control is True when the check box is selected and False when the check box is cleared. The state of the check box is stored in the task sequence variable configured for this control.

Layout Properties

Layout properties are used to configure the UI characteristics of the control and are configured on the Layout tab in the UDI Wizard Designer. Table 46 lists the layout properties for the Checkbox control and provides a brief description of each property

Table 46. Checkbox Control Layout Properties

Property

Description

X

Use this property to configure the horizontal position of the control.

Y

Use this property to configure the vertical position of the control.

Label

Use this property to configure the descriptive text associated with the check box.

Width

Use this property to configure the width of the control.

Note   If the text entered in the Label property is longer than the width of the control, the text is clipped and not displayed.

Height

Use this property to configure the height of the control.

Note   If the text entered in the Label property is taller than the height of the control, the text is clipped.

 

Settings Properties

Settings properties are used to configure the data initially shown in a control (the default value) and where the information collected from the user is saved. Table 47 lists the settings properties for the Checkbox control and provides a brief description of each property.

Table 47. Checkbox Control Settings Properties

Property

Description

Default value

Use this property to configure the default value for the control. For a check box, the default value is False.

Task sequence variable name

Use this property to configure the task sequence variable where the information collected from the user is stored. If the task sequence variable:

·     Does not already exist, the task sequence variable is created and set to the value the user provides

·     Already exists, the existing value of the task sequence variable is overwritten with the value the user provides

Friendly display name visible in the summary page

Use this property to configure the descriptive name that appears on the Summary wizard page. This name is used to describe the value that was saved in the Task sequence variable name property for this control.

Unlocked

Use this property to configure whether the user is able to interact with the control. By default, the control is enabled. This button displays the following status:

·           Unlocked. The control is enabled, and users can enter information using it.

·     Locked. The control is disabled, and users are unable to enter information using it.

Note   If you disable (lock) a control, you must provide the information the control collected by configuring MDT properties in CustomSettings.ini or in the MDT DB. Otherwise, the UDI Wizard will not collect the necessary information, and the UDI deployment will fail.

 

Related Topics

UDI Build Your Own Page Toolbox Control Reference