Summary

Used to route the flow of the installation process as the result of events raised by the user interacting with controls on dialogs.

Parameters

Attribute	Type	Description	Required
dialog	string	Refrence to a dialog. Used to associate the control with the dialog.	True
control	string	Refrence to a control. Maps to a control for the specified dialog.	True
name	string	An identifier that specifies the type of event that should take place when the user interacts with the control specified by Dialog_ and Control_. For a list of possible values see ControlEvent Overview. To set a property with a control, put [Property_Name] in this field and the new value in the argument field. Put { } into the argument field to enter the null value.	True
argument	string	A value used as a modifier when triggering a particular event.	True
condition	string	A conditional statement that determines whether the installer activates the event in the Event column. The installer triggers the event if the conditional statement in the Condition field evaluates to True. Therefore put a 1 in this column to ensure that the installer triggers the event. The installer does not trigger the event if the Condition field contains a statement that evaluates to False. The installer does not trigger an event with a blank in the Condition field unless no other events of the control evaluate to True. If none of the Condition fields for the control named in the Control_ field evaluate to True, the installer triggers the one event having a blank Condition field, and if more than one Condition field is blank it triggers the one event of these with the largest value in the Ordering field.	False
order	int	An integer used to order several events tied to the same control. This must be a non-negative number.	False
remove	bool	If `true`, the control condition is removed. If `false`, the control condition is added.	False

Examples

Remove the control events for the Browse button from the customize dialog and add events conditions for a web dialog


     
     <controlevents>
         <!-- Remove the old control events -->
         <controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog" 
             argument="SetupTypeDlg" condition="ProductID" remove="true" />
         <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" 
             argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg <> 1" remove="true" />
         <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" 
             argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg = 1" remove="true" />
         <!-- Remove control events for Browse button on CustomizeDlg -->
         <controlevent dialog="CustomizeDlg" control="Browse" name="SelectionBrowse" 
             argument="BrowseDlg" condition="1" remove="true" />                
    
         <!-- Add new control events for the web dialog -->
         <controlevent dialog="UserRegistrationDlg" control="Next" name="NewDialog" 
             argument="WebFolderDlg" condition="ProductID" />                        
         <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" 
             argument="WebFolderDlg" condition="ShowWebFolderDlg <> 1" />
         <controlevent dialog="SetupTypeDlg" control="Back" name="NewDialog" 
             argument="WebFolderDlg" condition="ShowWebFolderDlg = 1" />
         <controlevent dialog="WebFolderDlg" control="Cancel" name="SpawnDialog" 
             argument="CancelDlg" order="0" />
         <controlevent dialog="WebFolderDlg" control="Back" name="NewDialog" 
             argument="LicenseAgreementDlg" condition="ShowUserRegistrationDlg<>1" 
             order="0" />
         <controlevent dialog="WebFolderDlg" control="Back" name="NewDialog" 
             argument="UserRegistrationDlg" condition="ShowUserRegistrationDlg=1" 
             order="0" />
         <!-- Virtual Directory Control Events -->
         <controlevent dialog="WebFolderDlg" control="Next" name="DoAction" 
             argument="WEBCA_CreateURLs" condition="1" order="0" />
         <controlevent dialog="WebFolderDlg" control="Next" name="DoAction" 
             argument="WEBCA_EvaluateURLsMB" condition="1" order="1" />
         <controlevent dialog="WebFolderDlg" control="Next" name="SetTargetPath" 
             argument="TARGETDIR" condition="1" order="2" />
         <controlevent dialog="WebFolderDlg" control="Next" name="NewDialog" 
             argument="SetupTypeDlg" condition="1" order="3" />
     </controlevents>

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

Syntax

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

Attributes

Type	Description
BuildElement

Value

Type	Description
SchemaElement[]