Windows Installer XML (WiX) toolset
Search

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 only valid for RadioButton and PushButton Controls  
Cancel YesNoType Yes if this is the control invoked on cancel of dialog.  
CDROM YesNoType Only valid for Volume and Directory Controls  
CheckBoxValue String Only for CheckBox control to set Property to a value on check  
ComboList YesNoType Only valid for ComboBox Controls  
Default YesNoType Yes if this control invoked by the return key  
Disabled YesNoType Sets whether the control is disabled.  
ElevationShield YesNoType Only valid for PushButton controls. This attribute adds 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 Only valid for Volume and Directory Controls  
FixedSize YesNoType only valid for RadioButton, PushButton, and Icon Controls  
Floppy YesNoType Only valid for Volume and Directory Controls  
FormatSize YesNoType Only valid for Text Controls  
HasBorder YesNoType 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 part is reserved for future use. No need to use this until Windows Installer uses it for something.  
Hidden YesNoType Sets whether the control is hidden.  
Icon YesNoType only valid for RadioButton and PushButton Controls  
IconSize Enumeration only valid for RadioButton, PushButton, and Icon Controls This attribute's value must be one of the following:
16
32
48
 
Image YesNoType 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 Specifies if the property of the control is an integer. Otherwise it is tread as a string  
LeftScroll YesNoType Sets whether the controls scroll bar is on the left  
Multiline YesNoType Only valid for Edit Controls  
NoPrefix YesNoType Only valid for Text Controls  
NoWrap YesNoType Only valid for Text Controls  
Password YesNoType Only valid for Edit Controls  
ProgressBlocks YesNoType 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 only valid for RadioButton and Checkbox Controls  
RAMDisk YesNoType Only valid for Volume and Directory Controls  
Remote YesNoType Only valid for Volume and Directory Controls  
Removable YesNoType Only valid for Volume and Directory Controls  
RightAligned YesNoType Sets whether the control is right aligned.  
RightToLeft YesNoType Sets whether the control is read right to left.  
ShowRollbackCost YesNoType 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 Sets whether the control is sunken.  
TabSkip YesNoType Yes if this control is 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 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, Icon, Line, ListBox, ListView, MaskedEdit, PathEdit, ProgressBar, PushButton, RadioButtonGroup, ScrollableText, SelectionTree, Text, VolumeCostList, VolumeSelectCombo Yes
UserLanguage YesNoType 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