Summary

Creates user interface controls displayed on custom dialogs.

Parameters

Attribute Type Description Required

name string Name of the control. This name must be unique within a dialog box but can be repeated on different dialog boxes. True

dialog string Refrence to a dialog. Used to associate the control with the dialog. True

type

string

The type of the control. DescriptionDisplays billboards based on progress messages.Displays a static picture of a bitmap.A two-state check box.A drop-down list with an edit field.Select all except the last segment of the path.Displays folders below the main part of path.A regular edit field for any string or integer.Displays a rectangle that groups other controls together.Displays a static picture of an icon.Displays a horizontal line.A drop-down list without an edit field.Displays a column of values with icons for selection.An edit field with a mask in the text field.Displays folder name or entire path in an edit field.Bar graph that changes length as it receives progress messages.Displays a basic push button.A group of radio buttons.Displays a long string of text.Displays information from the Feature table and enables the user to change their selection state.Displays static text.Displays costing information on different volumes.Selects volume from an alphabetical list.

Control name
Billboard
Bitmap
CheckBox
ComboBox
DirectoryCombo
DirectoryList
Edit
GroupBox
Icon
Line
ListBox
ListView
MaskedEdit
PathEdit
ProgressBar
PushButton
RadioButtonGroup
ScrollableText
SelectionTree
Text
VolumeCostList
VolumeSelectCombo

More information found here: http://msdn.microsoft.com/library/en-us/msi/setup/controls.asp

True

x int Horizontal coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number. True

y int Vertical coordinate of the upper-left corner of the rectangular boundary of the control. This must be a non-negative number. True

width int Width of the rectangular boundary of the control. This must be a non-negative number. True

height int Height of the rectangular boundary of the control. This must be a non-negative number. True

attr int A 32-bit word that specifies the bit flags to be applied to this control. This must be a non-negative number, and the allowed values depend upon the type of control.For a list of all control attributes, and the value to enter in this field, see Control Attributes. True

property string The name of a defined property to be linked to this control. Radio button, list box, and combo box values are tied into a group by being linked to the same property. This column is required for active controls and is ignored by static controls. False

text string A localizable string used to set the initial text contained in a control. The string can also contain embedded properties. False

nextcontrol string The name of another control on the same dialog box. If the focus in the dialog box is on the control in the Control column, hitting the tab key moves the focus to the control listed here. Therefore this is used to specify the tab order of the controls on the dialog box. The links between the controls must form a closed cycle. Some controls, such as static text controls, can be left out of the cycle. In that case, this field may be left blank. False

help string Optional, localizable text strings that are used with the Help button. The string is divided into two parts by a separator character (|). The first part of the string is used as ToolTip text. This text is used by screen readers for controls that contain a picture. The second part of the string is reserved for future use. The separator character is required even if only one of the two kinds of text is present. False

remove bool If true, the control is removed. If false, the control is added. False

Examples

Remove the Browse button from the customize dialog and add controls for a web dialog


     <controls>
         <!-- Remove the Browse button from customize dialog -->
         <control dialog="CustomizeDlg" name="Browse" type="PushButton"
             x="304" y="200" width="56" height="17" attr="3" remove="true" />
         <control dialog="CustomizeDlg" name="Tree" type="SelectionTree"
             x="25" y="85" width="175" height="95" attr="7" remove="true" />
    
         <!-- Re add the tree control with the proper next control -->
         <control dialog="CustomizeDlg" name="Tree" type="SelectionTree"
             x="25" y="85" width="175" height="95" attr="7" 
             property="_BrowseProperty" text="Tree of selections" nextcontrol="Reset" />
    
         <!-- Adds the controls associated with the webfolder dialog -->
         <control dialog="WebFolderDlg" name="BannerBitmap" type="Bitmap" 
             x="0" y="0" width="374" height="44" attr="1" 
             text="[BannerBitmap]" nextcontrol="VDirLabel" />
         <control dialog="WebFolderDlg" name="Title" type="Text" 
             x="15" y="6" width="200" height="15" attr="196611" 
             text="[DlgTitleFont]Virtual Directory Information" />
         <control dialog="WebFolderDlg" name="Description" type="Text" 
             x="25" y="23" width="280" height="15" attr="196611" 
             text="Please enter your virtual directory and port information." />
         <control dialog="WebFolderDlg" name="BannerLine" type="Line" 
             x="0" y="44" width="374" height="0" attr="1" />
         <control dialog="WebFolderDlg" name="VDirLabel" type="Text" 
             x="18" y="73" width="348" height="15" attr="3" 
             text="&Virtual directory:" 
             nextcontrol="Edit_VDir" />            
         <control dialog="WebFolderDlg" name="Edit_VDir" type="Edit" 
             x="18" y="85" width="252" height="18" attr="7" 
             property="TARGETVDIR" 
             text="[TARGETVDIR]" 
             nextcontrol="PortLabel" />
         <control dialog="WebFolderDlg" name="PortLabel" type="Text" 
             x="18" y="110" width="348" height="15" attr="3" 
             text="&Port:" 
             nextcontrol="Edit_Port" />            
         <control dialog="WebFolderDlg" name="Edit_Port" type="Edit" 
             x="18" y="122" width="48" height="18" attr="7" 
             property="TARGETPORT" 
             text="[TARGETPORT]" 
             nextcontrol="Back" />
         <control dialog="WebFolderDlg" name="BottomLine" type="Line" 
             x="0" y="234" width="374" height="0" attr="1" />                
         <control dialog="WebFolderDlg" name="Back" type="PushButton" 
             x="180" y="243" width="56" height="17" attr="3" 
             text="[ButtonText_Back]" nextcontrol="Next" />
         <control dialog="WebFolderDlg" name="Next" type="PushButton" 
             x="236" y="243" width="56" height="17" attr="3" 
             text="[ButtonText_Next]" nextcontrol="Cancel" />
         <control dialog="WebFolderDlg" name="Cancel" type="PushButton" 
             x="304" y="243" width="56" height="17" attr="3" 
             text="[ButtonText_Cancel]" nextcontrol="BannerBitmap" />
     </controls>

Assembly: NAnt.Contrib.dll
Namespace: NAnt.Contrib.Tasks.Msi
Containing Type: InstallerTaskBase

Syntax

[BuildElement("controls", ProcessXml = false)]
public SchemaElement[] InstallerControlsElement { get; set; }

Attributes

Type	Description
BuildElement

Value

Type	Description
SchemaElement[]