Control Element

WiX Toolset

previous page next page

Control Element

Description
Contains the controls that appear on each dialog.
Windows Installer references
Control Table, ComboBox Table, Dialog Table, ListBox Table, ListView Table, RadioButton Table
Parents
Billboard, Dialog
Inner Text
None
Children
Sequence (min: 1, max: 1)
  1. Text (min: 0, max: 1): alternative to Text attribute when CDATA is needed to escape XML delimiters
  2. ComboBox (min: 0, max: 1): ComboBox table with ListItem children
  3. ListBox (min: 0, max: 1): ListBox table with ListItem children
  4. ListView (min: 0, max: 1): ListView table with ListItem children
  5. RadioButtonGroup (min: 0, max: 1): RadioButton table with RadioButton children
  6. Property (min: 0, max: 1): Property table entry for the Property table column associated with this control
  7. Binary (min: 0, max: 1): Icon referenced in icon column of row
  8. Choice of elements (min: 0, max: unbounded)
    • Condition (min: 0, max: unbounded): Condition to specify actions for this control based on the outcome of the condition.
    • Publish (min: 0, max: unbounded)
    • Subscribe (min: 0, max: unbounded)
Attributes
Name Type Description Required
Id String Combined with the Dialog Id to make up the primary key of the Control table. Yes
Bitmap YesNoType This attribute is only valid for RadioButton and PushButton Controls.  
Cancel YesNoType Set this attribute to "yes" to cause this Control to be invoked by the escape key.  
CDROM YesNoType This attribute is only valid for Volume and Directory Controls.  
CheckBoxPropertyRef String This attribute is only valid for CheckBox controls. The value is the name of a Property that was already used as the Property for another CheckBox control. The Property attribute cannot be specified. The attribute exists to support multiple checkboxes on different dialogs being tied to the same property.  
CheckBoxValue String This attribute is only valid for CheckBox Controls. When set, the linked Property will be set to this value when the check box is checked.  
ComboList YesNoType This attribute is only valid for ComboBox Controls.  
Default YesNoType Set this attribute to "yes" to cause this Control to be invoked by the return key.  
Disabled YesNoType Set this attribute to "yes" to cause the Control to be disabled.  
ElevationShield YesNoType This attribute is only valid for PushButton controls. Set this attribute to "yes" to add the User Account Control (UAC) elevation icon (shield icon) to the PushButton control. If this attribute's value is "yes" and the installation is not yet running with elevated privileges, the pushbutton control is created using the User Account Control (UAC) elevation icon (shield icon). If this attribute's value is "yes" and the installation is already running with elevated privileges, the pushbutton control is created using the other icon attributes. Otherwise, the pushbutton control is created using the other icon attributes.  
Fixed YesNoType This attribute is only valid for Volume and Directory Controls.  
FixedSize YesNoType This attribute is only valid for RadioButton, PushButton, and Icon Controls.  
Floppy YesNoType This attribute is only valid for Volume and Directory Controls.  
FormatSize YesNoType This attribute is only valid for Text Controls.  
HasBorder YesNoType This attribute is only valid for RadioButton Controls.  
Height LocalizableInteger Height of the rectangular boundary of the control. This must be a non-negative number. Yes
Help String This attribute is reserved for future use. There is no need to use this until Windows Installer uses it for something.  
Hidden YesNoType Set this attribute to "yes" to cause the Control to be hidden.  
Icon YesNoType This attribute is only valid for RadioButton and PushButton Controls.  
IconSize Enumeration This attribute is only valid for RadioButton, PushButton, and Icon Controls. This attribute's value must be one of the following:
16
32
48
  
Image YesNoType This attribute is only valid for RadioButton, PushButton, and Icon Controls.  
Indirect YesNoType Specifies whether the value displayed or changed by this control is referenced indirectly. If this bit is set, the control displays or changes the value of the property that has the identifier listed in the Property column of the Control table.  
Integer YesNoType Set this attribute to "yes" to cause the linked Property value for the Control to be treated as an integer. Otherwise, the Property will be treated as a string.  
LeftScroll YesNoType Set this attribute to "yes" to cause the scroll bar to display on the left side of the Control.  
Multiline YesNoType This attribute is only valid for Edit Controls.  
NoPrefix YesNoType This attribute is only valid for Text Controls.  
NoWrap YesNoType This attribute is only valid for Text Controls.  
Password YesNoType This attribute is only valid for Edit Controls.  
ProgressBlocks YesNoType This attribute is only valid for ProgressBar Controls.  
Property String The name of a defined property to be linked to this control. This column is required for active controls.  
PushLike YesNoType This attribute is only valid for RadioButton and Checkbox Controls.  
RAMDisk YesNoType This attribute is only valid for Volume and Directory Controls.  
Remote YesNoType This attribute is only valid for Volume and Directory Controls.  
Removable YesNoType This attribute is only valid for Volume and Directory Controls.  
RightAligned YesNoType Set this attribute to "yes" to cause the Control to be right aligned.  
RightToLeft YesNoType Set this attribute to "yes" to cause the Control to display from right to left.  
ShowRollbackCost YesNoType This attribute is only valid for VolumeCostList Controls.  
Sorted YesNoType This attribute is only valid for ListBox, ListView, and ComboBox Controls. Set the value of this attribute to "yes" to have entries appear in the order specified under the Control. If the attribute value is "no" or absent the entries in the control will appear in alphabetical order.  
Sunken YesNoType Set this attribute to "yes" to cause the Control to be sunken.  
TabSkip YesNoType Set this attribute to "yes" to cause this Control to be skipped in the tab sequence.  
Text String A localizable string used to set the initial text contained in a control. This attribute can contain a formatted string that is processed at install time to insert the values of properties using [PropertyName] syntax. Also supported are environment variables, file installation paths, and component installation directories; see Formatted for details.  
ToolTip String The string used for the Tooltip.  
Transparent YesNoType This attribute is only valid for Text Controls.  
Type String The type of the control. Could be one of the following: Billboard, Bitmap, CheckBox, ComboBox, DirectoryCombo, DirectoryList, Edit, GroupBox, Hyperlink, Icon, Line, ListBox, ListView, MaskedEdit, PathEdit, ProgressBar, PushButton, RadioButtonGroup, ScrollableText, SelectionTree, Text, VolumeCostList, VolumeSelectCombo Yes
UserLanguage YesNoType This attribute is only valid for Text Controls.  
Width LocalizableInteger Width of the rectangular boundary of the control. This must be a non-negative number. Yes
X LocalizableInteger Horizontal coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number. Yes
Y LocalizableInteger Vertical coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number. Yes
See Also
Wix Schema
previous page start next page