C# Class WixSharp.UI.Forms.ManagedForm

The base class for all WinForm based dialogs of ManagedUI.

Inheritance: System.Windows.Forms.Form, IManagedDialog

Public Methods

Method	Description
Localize ( ) : void	Localizes the form and its contained T:System.Windows.Forms.Control.Text from the specified localization delegate 'localize'. The method substitutes both localization file (*.wxl) entries and MSI properties contained by the input string with their translated/converted values. Note that both localization entries and MSI properties must be enclosed in the square brackets (e.g. "[ProductName] Setup", "[InstallDirDlg_Title]"). ///
OnExecuteComplete ( ) : void	Called when MSI execution is complete.
OnExecuteStarted ( ) : void	Called when MSI execute started.
OnProgress ( int progressPercentage ) : void	Called when MSI execution progress is changed.
ProcessMessage ( InstallMessage messageType, Microsoft.Deployment.WindowsInstaller.Record messageRecord, MessageButtons buttons, MessageIcon icon, MessageDefaultButton defaultButton ) : MessageResult	Processes information and progress messages sent to the user interface. This method directly mapped to the T:Microsoft.Deployment.WindowsInstaller.IEmbeddedUI.ProcessMessage.
SetShellSize ( int width, int height ) : void	Sets the size of the shell.

Protected Methods

Method	Description
OnShellChanged ( ) : void	Called when Shell is changed. It is a good place to initialize the dialog to reflect the MSI session (e.g. localize the view).

Method Details

Localize() public method

Localizes the form and its contained T:System.Windows.Forms.Control.Text from the specified localization delegate 'localize'.

The method substitutes both localization file (*.wxl) entries and MSI properties contained by the input string with their translated/converted values.

Note that both localization entries and MSI properties must be enclosed in the square brackets (e.g. "[ProductName] Setup", "[InstallDirDlg_Title]"). ///

public Localize ( ) : void
return	void

OnExecuteComplete() public method

Called when MSI execution is complete.

public OnExecuteComplete ( ) : void
return	void

OnExecuteStarted() public method

Called when MSI execute started.

public OnExecuteStarted ( ) : void
return	void

OnProgress() public method

Called when MSI execution progress is changed.

public OnProgress ( int progressPercentage ) : void
progressPercentage	int	The progress percentage.
return	void

OnShellChanged() protected method

Called when Shell is changed. It is a good place to initialize the dialog to reflect the MSI session (e.g. localize the view).

protected OnShellChanged ( ) : void
return	void

ProcessMessage() public method

Processes information and progress messages sent to the user interface.

This method directly mapped to the T:Microsoft.Deployment.WindowsInstaller.IEmbeddedUI.ProcessMessage.

public ProcessMessage ( InstallMessage messageType, Microsoft.Deployment.WindowsInstaller.Record messageRecord, MessageButtons buttons, MessageIcon icon, MessageDefaultButton defaultButton ) : MessageResult
messageType	InstallMessage	Type of the message.
messageRecord	Microsoft.Deployment.WindowsInstaller.Record	The message record.
buttons	MessageButtons	The buttons.
icon	MessageIcon	The icon.
defaultButton	MessageDefaultButton	The default button.
return	MessageResult

SetShellSize() public method

Sets the size of the shell.

public SetShellSize ( int width, int height ) : void
width	int	The width.
height	int	The height.
return	void