Windows
Installer documentation| Reference information | |
|---|---|
| Project page | Dialogs and Billboards |
| Related topics | Working with attribute panes |
| External links | Windows
Installer documentation |
A CheckBox control represents a yes/no option. It displays the actual check box plus a text label, bitmap, or icon image. To display a bitmap or icon image in a CheckBox control, you must add the desired bitmap or icon on the Bitmaps or Icons project page, then select the control's Type and set the control's Text/Image attribute to the name of the desired bitmap or icon image.
Each CheckBox control is linked to an installer property. When the check box is checked, the property's value is set; when the check box is cleared, the property's value is cleared. The property itself can be used in conditions elsewhere; this allows you to use check boxes to control the installer's actions or component selection.
Windows Installer can display bitmaps in Bitmap (.bmp), JPEG (.jpg) and Portable
Network Graphics (.png) formats. The current version of Tarma ExpertInstall
can only handle .bmp bitmap images. You can use the other types as well, but
they won't be displayed in Tarma ExpertInstall. We intend to add support for
JPEG and PNG images in a future release of Tarma Installer.
The Tarma Installer equivalent is the CheckBox
control.
This pane contains the following attributes and options.
| Attribute | Description |
|---|---|
| Control name | Enter the name of the control. This name has no special significance, but it must be unique among all controls of its parent dialog or billboard. |
| Type |
Select the desired CheckBox type from the drop-down list:
|
| Text/Image |
Depending on the Type selection, enter one of the following:
|
| Size |
Select the desired icon size from the drop-down list. This option only applies if Type is set to Icon. Note: If the selected image size is not present in the icon file, then the system scales one of the other icon images to the desired size. The resulting image may be less than satisfactory; in that case, you should edit the original icon file and add an image of the required size. |
| Help text | Enter text for display by screen readers. This text is not normally visible, but it can be read by screen reader software such as used by visually impaired users. |
| Font | Select the font style for the text in the control by clicking ... (browse) to open the Select Font Style dialog. |
| Property |
Enter the name of the property to which the control must be linked, or click ... (browse) to open the Select Product Variable dialog box that allows you to select a property from the project. The named property is updated when the state of the check box changes: if the box is checked, the property is assigned the value specified in the Value attribute (below) or to the value it has in the MSI Property table (in Tarma ExpertInstall, this is the value you assign on the Project Variables page); if unchecked, the property's value is set to null. |
| Indirect | Check this box to make the property link indirect; clear it for a direct link. If the link is indirect, the property specified in the Property field is used to obtain the name of a second property, and it is this second property whose value is changed by the control. With a direct link, the property specified by the Property attribute itself is changed. |
| Integer | Check this box if the linked property contains an integer number; clear it if the property contains a text string. |
| Value |
Enter the value to assign to the linked property when the CheckBox control is checked. If you leave this field empty, Windows Installer will use the property's original value from the MSI Property table (in Tarma ExpertInstall, this is the value you assign on the Project Variables page). Note: If the CheckBox control is cleared, the property's value is set to null; you cannot specify an alternate value for the unchecked state of the CheckBox control.
|
| Visible | Check this box to make the control initially visible; clear it to hide the control. You can change the visibility status of the control at installation time by using Control conditions. |
| Enabled | Check this box to enable the control initially; clear it to disable the control. An enabled control accepts user input; a disabled control does not and appears grayed out. You can change the enabled status of the control at installation time by using Control conditions. |
| Sunken | Check this box to make the control appear sunken; clear it to display it flush with its parent dialog or billboard. A sunken control has a simulated 3D border. |
| Right align | Check this box to align the control's text to the right instead of the left; clear it to keep the text left-aligned. |
| Fixed size | Check this box to display the bitmap image at its actual size; this may result in clipping or filling of it borders. Clear this box to stretch the bitmap image to fit the size of the control; this may result in a distorted image. This option only applies if Type is set to Bitmap. |
| Push like | Check this box to make the CheckBox control appear similar to a PushButton control; clear it to to display it as a check box. When the CheckBox control appears as a push button, its "checked" state is shown as a pushed-in button and its "unchecked" state as a popped-up button. |
| Don't mirror | Check this box to keep the control's orientation as it is and not mirror it for languages that use a right-to-left (RTL) order; clear it to mirror the control if the parent dialog is mirrored for RTL languages. This option only has effect for languages that use an RTL reading order, such as Arabic and Hebrew; for other languages it is ignored. |