List Box Control

InstallShield 2012 Spring

Project: This information applies to the following project types:

Basic MSI
InstallScript
InstallScript MSI
InstallScript Object
Merge Module

The list box control is a standard list box that lets end users select a single option from a list of predetermined options.

When you select a list box control in a dialog of the Dialogs view, InstallShield displays the following settings in the right pane.

Project: (For Basic MSI and Merge Module projects) When you first draw this type of control on a dialog, InstallShield prompts you for the name of a Windows Installer property that identifies all of the items that are displayed in this list box. InstallShield uses the name that you enter as the value for this control's Property setting. At run time, the installation sets the value of this property based on the end user's selection. For more details, see Working with Windows Installer and Advanced UI or Suite/Advanced UI Properties.

Settings for a List Box Control

Setting

Project Type

Description

Name

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

Enter a name for this list box. The name must be unique among all of the controls in your project.

Base Text Style

Basic MSI, Merge Module

This font style is used for the control's label if you specify nothing for the Text Style setting.

Cancel

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

If this is the only control on the dialog that will dismiss the dialog, select True. Clicking the cancel control has the same effect as pressing the ESC key or clicking the Close button on the title bar. The Cancel or Finish button is usually the cancel control.

This value is ignored if True is selected for the ErrorDialog setting of the dialog that contains this control.

Code Page

Basic MSI, Merge Module

If you want the control to use fonts from the code page that is defined in the installation's package, select Database. If you want the control to use fonts from the target system's default code page, select User's System.

Context Help

Basic MSI, Merge Module

This setting is reserved for future use. Windows Installer does not currently support launching context-sensitive help topics from the installation.

Control Identifier

InstallScript, InstallScript MSI, InstallScript Object

This setting contains a numeric identifier for the control that is unique within the dialog. This identifier is the same as a resource identifier in Visual C++. You should not change the control identifiers for any of the controls that are included with a dialog by default.

Default

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

If this is the only control on the dialog that you want to be the default control, which means that it is activated when the end user presses the ENTER key, select True. The Next or OK button is usually the default control.

Enabled

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

Indicate whether the control is enabled. True means that this control is available (the end user can interact with it). False means that it is not available (grayed out).

Height

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

For Basic MSI and Merge Module projects: Specify the height of the control in Windows Installer user interface units (1/12 of the height of the system font).

For InstallScript, InstallScript MSI, and InstallScript Object projects: Specify the height of the control in dialog units.

Indirect Property

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

If the property that is associated with this control is referenced indirectly, select True; otherwise, select False.

When True is selected for an indirect property is set to True, Windows Installer resolves the referenced property at run time. For example, this check box might use the property _BROWSE, whose value is INSTALLDIR. If you select True for the Indirect Property setting, the value of _BROWSE will be the current value of the INSTALLDIR property. If you select False for the Indirect Property setting, the value of _BROWSE will contain the string INSTALLDIR.

Items

Basic MSI, Merge Module

To specify the options that you want to be listed in this control, click the ellipsis button (...) in this setting; this opens the List Items dialog box.

To add a new item to the list, click the Add button on the List Items dialog box. For each item, you must enter the text that is displayed in the list box, and a value, which is the value that is assigned to the property if this item is selected.

Left

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

Specify the distance from the left edge of the dialog to the start of the control in installer units (1/12 of the height of the system font).

Left Scrollbar

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

If you want the arrow and vertical scrollbar to be displayed on the left side of the control, select True. This option should be selected only when True is selected for the Right-to-Left setting.

Other Window Styles

InstallScript, InstallScript MSI, InstallScript Object

Click the ellipsis button (...) to display the Other Window Styles dialog box.

Property

Basic MSI, Merge Module

Enter the name of a property that is set when an end user selects an option from this control. This property can be unique to this control; it does not need to be present in the Property Manager view.

To set a default value for this control, make sure the property is a public property by giving it a name that contains only uppercase letters, use the Property Manager view to add the public property, and then assign to it the text of the default selection.

Property Is Integer

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

If the property for this control (specified in the Property setting) has an integer value, select True. If the property's value is a string, select False.

Right-Aligned

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

The default value of False aligns the text to the left of the control. Set it to True to align the text to the right.

Right-to-Left

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

For English and other languages that are written from left to right, select False. For Hebrew and those languages that are read from right to left, select True.

Sorted

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

Selecting True causes the items in the list box to be sorted alphabetically. A value of False makes them retain the order that you set for each item in the List Items dialog box.

Sunken

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

To give the control's edges a recessed, three-dimensional appearance, select True. To use the default visual style for the control, select False.

Tab Index

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

Assign an integer that—along with the other controls on this dialog but excluding controls such as static text—specifies the order in which each control on the dialog receives focus when the end user presses the TAB key. The lowest tab index that you can use is the number 0.

Tab Stop

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

Indicate whether this control receives focus within the tab order. True indicates that the control receives focus; False indicates that the control does not receive focus.

Text

Basic MSI, Merge Module

This setting contains the text that is used for screen readers.

When you type a value for this setting, you are creating a string entry and setting its initial value for all of the languages that are currently in the project. As an alternative to typing a new value, you can click the ellipsis button (...) in this setting to select an existing string. For more information, see Using String Entries in InstallShield.

Text Style

Basic MSI, Merge Module

Select the font style, size, and color (if available) in which you want the control's label to be displayed. Leaving the value as <Default> displays the font that is contained in the DefaultUIFont property.

Tooltip

Basic MSI, Merge Module

Enter the text that you want to be displayed when the end user places the mouse pointer over the control.

When you type a value for this setting, you are creating a string entry and setting its initial value for all of the languages that are currently in the project. As an alternative to typing a new value, you can click the ellipsis button (...) in this setting to select an existing string. For more information, see Using String Entries in InstallShield.

Top

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

Specify the distance from the top of the dialog to the top of the control in installer units (1/12 of the height of the system font).

Visible

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

True means that the control is visible, and False means that it is hidden. You can also make the control visible by editing its condition in the Behavior area for the dialog.

Width

Basic MSI, InstallScript, InstallScript MSI, InstallScript Object, Merge Module

For Basic MSI and Merge Module projects: Specify the width of the control in Windows Installer user interface units (1/12 of the height of the system font).

For InstallScript, InstallScript MSI, and InstallScript Object projects: Specify the width of the control in dialog units.

See Also