C# Class WixSharp.ManagedUI

Inheritance: IManagedUI, IEmbeddedUI

Public Properties

Property	Type	Description
Default	ManagedUI
DialogBanner	string
DialogBitmap	string
Empty	ManagedUI

Public Methods

Method	Description
BeforeBuild ( ManagedProject project ) : void	This method is called (indirectly) by Wix# compiler just before building the MSI. It allows embedding UI specific resources (e.g. license file, properties) into the MSI.
Initialize ( Microsoft.Deployment.WindowsInstaller.Session session, string resourcePath, InstallUIOptions &uiLevel ) : bool	Initializes the specified session.
ManagedUI ( ) : System	Initializes a new instance of the ManagedUI class.
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. Win32 MSI API: EmbeddedUIHandler
Shutdown ( ) : void	Shuts down the embedded UI at the end of the installation. If the installation was canceled during initialization, this method will not be called. If the installation was canceled or failed at any later point, this method will be called at the end. Win32 MSI API: ShutdownEmbeddedUI

Private Methods

Method	Description
DialogBannerFileFor ( Project project ) : string
DialogBitmapFileFor ( Project project ) : string
LicenceFileFor ( Project project ) : string
LocalizationFileFor ( Project project ) : string
ReadDialogs ( Microsoft.Deployment.WindowsInstaller.Session session ) : void

Method Details

BeforeBuild() public method

This method is called (indirectly) by Wix# compiler just before building the MSI. It allows embedding UI specific resources (e.g. license file, properties) into the MSI.

public BeforeBuild ( ManagedProject project ) : void
project	ManagedProject	The project.
return	void

Initialize() public method

Initializes the specified session.

public Initialize ( Microsoft.Deployment.WindowsInstaller.Session session, string resourcePath, InstallUIOptions &uiLevel ) : bool
session	Microsoft.Deployment.WindowsInstaller.Session	The session.
resourcePath	string	The resource path.
uiLevel	InstallUIOptions	The UI level.
return	bool

ManagedUI() public method

Initializes a new instance of the ManagedUI class.

public ManagedUI ( ) : System
return	System

ProcessMessage() public method

Processes information and progress messages sent to the user interface.

Win32 MSI API: EmbeddedUIHandler

public ProcessMessage ( InstallMessage messageType, Microsoft.Deployment.WindowsInstaller.Record messageRecord, MessageButtons buttons, MessageIcon icon, MessageDefaultButton defaultButton ) : MessageResult
messageType	InstallMessage	Message type.
messageRecord	Microsoft.Deployment.WindowsInstaller.Record	Record that contains message data.
buttons	MessageButtons	Message buttons.
icon	MessageIcon	Message box icon.
defaultButton	MessageDefaultButton	Message box default button.
return	MessageResult

Shutdown() public method

Shuts down the embedded UI at the end of the installation.

If the installation was canceled during initialization, this method will not be called. If the installation was canceled or failed at any later point, this method will be called at the end.

Win32 MSI API: ShutdownEmbeddedUI

public Shutdown ( ) : void
return	void

Property Details

Default public_oe static_oe property

The default implementation of ManagedUI. It implements all major dialogs of a typical MSI UI.

public static ManagedUI,WixSharp Default
return	ManagedUI

DialogBanner public_oe property

The location of the ManagedUI dialog banner bitmap. If not defined the Wix# compiler will use standard WiX dialog banner bitmap.

public string DialogBanner
return	string

DialogBitmap public_oe property

The location of the ManagedUI dialog bitmap. If not defined the Wix# compiler will use standard WiX dialog bitmap.

public string DialogBitmap
return	string

Empty public_oe static_oe property

The default implementation of ManagedUI with no UI dialogs.

public static ManagedUI,WixSharp Empty
return	ManagedUI