C# Class WixSharp.Compiler

ファイルを表示 Open project: Eun/WixSharp Class Usage Examples

Public Properties

Property	Type	Description
AllowNonRtfLicense	bool
AssemblyResolve	ResolveEventHandler
AutoGeneration	AutoGenerationOptions
CandleOptions	string
EmitRelativePaths	bool
IgnoreClientAssemblyPDB	bool
LightOptions	string
PreserveTempFiles	bool
TempFiles	List

Public Methods

Method	Description
Build ( Bundle project ) : string	Builds WiX Bootstrapper application from the specified Bundle project instance.
Build ( Bundle project, string path ) : string	Builds WiX Bootstrapper application from the specified Bundle project instance.
BuildCmd ( Bundle project, string path = null ) : string	Builds the WiX source file and generates batch file capable of building WiX/MSI bootstrapper with WiX toolset.
BuildMsi ( Project project ) : string	Builds the MSI file from the specified Project instance.
BuildMsi ( Project project, string path ) : string	Builds the MSI file from the specified Project instance.
BuildMsiCmd ( Project project ) : string	Builds the WiX source file and generates batch file capable of building MSI with WiX toolset.
BuildMsiCmd ( Project project, string path ) : string	Builds the WiX source file and generates batch file capable of building MSI with WiX toolset.
BuildMsm ( Project project ) : string	Builds the MSM file from the specified Project instance.
BuildMsm ( Project project, string path ) : string	Builds the MSM file from the specified Project instance.
BuildMsmCmd ( Project project ) : string	Builds the WiX source file and generates batch file capable of building MSM with WiX toolset.
BuildMsmCmd ( Project project, string path ) : string	Builds the WiX source file and generates batch file capable of building MSM with WiX toolset.
BuildPackageAsm ( string asm, string nativeDll = null, string refAssemblies = null, string outDir = null, string configFilePath = null, System.Platform platform = null, bool embeddedUI = false ) : string	Packages the assembly containing managed CA or UI.
BuildPackageAsmCmd ( string asm, string nativeDll, string refAssemblies, string outDir, string configFilePath, System.Platform platform = null, bool embeddedUI = false ) : string	Builds the batch file for packaging the assembly containing managed CA or UI.
BuildWxs ( Bundle project ) : string	Builds the WiX source file (*.wxs) from the specified Bundle instance.
BuildWxs ( Project project ) : string	Builds the WiX source file (*.wxs) from the specified Project instance for further compiling into MSI file.
BuildWxs ( Project project, OutputType type ) : string	Builds the WiX source file (*.wxs) from the specified Project instance.
BuildWxs ( Project project, string path, OutputType type ) : string	Builds the WiX source file (*.wxs) from the specified Project instance.
DefaultWixSourceFormatedHandler ( string &xml ) : void	The default Compiler.WixSourceFormated event handler.
DefaultWixSourceGeneratedHandler ( System.Xml.Linq.XDocument doc ) : void	The default Compiler.WixSourceGenerated event handler.
GenerateWixProj ( Project project ) : System.Xml.Linq.XDocument	Generates WiX XML source file the specified Project instance.

Private Methods

Method	Description
AddDir ( System.Xml.Linq.XElement parent, Dir wDir ) : System.Xml.Linq.XElement
Build ( Project project, OutputType type ) : string
Build ( Project project, string path, OutputType type ) : void
BuildCmd ( Project project, string path, OutputType type ) : void
BuildSuppressWarningsArgs ( int IDs ) : string
Compiler ( ) : System
ConvertMsiToMsm ( System.Xml.Linq.XDocument doc ) : void
CopyAsAutogen ( string source, string dest ) : void
EnsureVSIntegration ( ) : void
GenerateCandleCommand ( Project project, string wxsFile, string outDir, string &objFile, string &extensionDlls ) : string
GenerateLightCommand ( Project project, string msiFile, string outDir, string objFile, string extensionDlls ) : string
GetShortcutWorkingDirectopry ( string targetPath ) : string
GetTopLevelDir ( System.Xml.Linq.XElement product ) : System.Xml.Linq.XElement
IndjectCustomUI ( Controls customUI, System.Xml.Linq.XDocument doc ) : void
InsertIISElements ( System.Xml.Linq.XElement dirItem, System.Xml.Linq.XElement component, IISVirtualDir wVDirs, Project project ) : void
InsertWebSite ( WebSite webSite, string dirID, System.Xml.Linq.XElement element ) : void
PackageManagedAsm ( string asm, string nativeDll, string refAssemblies, string outDir, string configFilePath, System.Platform platform = null, bool embeddedUI = false, string batchFile = null ) : void
PostProcessMsm ( Project project, System.Xml.Linq.XElement product ) : void
ProcessBinaries ( Project wProject, System.Xml.Linq.XElement product ) : void
ProcessCertificates ( Project project, Dictionary featureComponents, List defaultFeatureComponents, System.Xml.Linq.XElement product ) : void
ProcessCustomActions ( Project wProject, System.Xml.Linq.XElement product ) : void	Processes the custom actions.
ProcessDirPermissions ( Dir wDir, Project wProject, Dictionary featureComponents, List defaultFeatureComponents, System.Xml.Linq.XElement dirItem ) : void
ProcessDirectories ( Project wProject, Dictionary featureComponents, List defaultFeatureComponents, List autoGeneratedComponents, System.Xml.Linq.XElement dirs ) : void
ProcessDirectory ( Dir wDir, Project wProject, Dictionary featureComponents, List defaultFeatureComponents, List autoGeneratedComponents, System.Xml.Linq.XElement parent ) : void
ProcessDirectoryFiles ( Dir wDir, Project wProject, Dictionary featureComponents, List defaultFeatureComponents, System.Xml.Linq.XElement dirItem ) : void
ProcessDirectoryShortcuts ( Dir wDir, Project wProject, Dictionary featureComponents, List defaultFeatureComponents, System.Xml.Linq.XElement dirItem ) : void
ProcessEnvVars ( Project wProject, Dictionary featureComponents, List defaultFeatureComponents, System.Xml.Linq.XElement product ) : void
ProcessFeatures ( Project project, System.Xml.Linq.XElement product, Dictionary featureComponents, List autoGeneratedComponents, List defaultFeatureComponents ) : void
ProcessFilePermissions ( Project wProject, File wFile, System.Xml.Linq.XElement file ) : void
ProcessLaunchConditions ( Project project, System.Xml.Linq.XElement product ) : void
ProcessMergeModules ( Dir wDir, System.Xml.Linq.XElement dirItem, Dictionary featureComponents, List defaultFeatureComponents ) : void
ProcessOdbcSources ( Dir wDir, Project wProject, Dictionary featureComponents, List defaultFeatureComponents, System.Xml.Linq.XElement dirItem ) : void
ProcessProperties ( Project wProject, System.Xml.Linq.XElement product ) : void
ProcessRegKeys ( Project wProject, Dictionary featureComponents, List defaultFeatureComponents, System.Xml.Linq.XElement product ) : void
ProcessSql ( Project project, Dictionary featureComponents, List defaultFeatureComponents, System.Xml.Linq.XElement product ) : void
ProcessSqlScripts ( Dictionary featureComponents, List defaultFeatureComponents, System.Xml.Linq.XElement product, SqlDatabase sqlDb ) : void
ProcessSqlStrings ( Dictionary featureComponents, List defaultFeatureComponents, System.Xml.Linq.XElement product, SqlDatabase sqlDb ) : void
ProcessUpgradeStrategy ( Project project, System.Xml.Linq.XElement product ) : void
ProcessUsers ( Project project, Dictionary featureComponents, List defaultFeatureComponents, System.Xml.Linq.XElement product ) : void
ResetCachedContent ( ) : void
ResolveClientAsm ( string asmName, string outDir ) : string
ResolveExtensionFile ( string file ) : string
Run ( string file, string args ) : void

Method Details

Build() public static method

Builds WiX Bootstrapper application from the specified Bundle project instance.

public static Build ( Bundle project ) : string
project	WixSharp.Bootstrapper.Bundle	The project.
return	string

Build() public static method

Builds WiX Bootstrapper application from the specified Bundle project instance.

Wix compiler/linker cannot be found

public static Build ( Bundle project, string path ) : string
project	WixSharp.Bootstrapper.Bundle	The project.
path	string	The path.
return	string

BuildCmd() public static method

Builds the WiX source file and generates batch file capable of building WiX/MSI bootstrapper with WiX toolset.

Wix compiler/linker cannot be found

public static BuildCmd ( Bundle project, string path = null ) : string
project	WixSharp.Bootstrapper.Bundle	The project.
path	string	The path to the batch file to be created.
return	string

BuildMsi() public static method

Builds the MSI file from the specified Project instance.

public static BuildMsi ( Project project ) : string
project	Project	The instance.
return	string

BuildMsi() public static method

Builds the MSI file from the specified Project instance.

public static BuildMsi ( Project project, string path ) : string
project	Project	The instance.
path	string	The path to the MSI file to be build.
return	string

BuildMsiCmd() public static method

Builds the WiX source file and generates batch file capable of building MSI with WiX toolset.

public static BuildMsiCmd ( Project project ) : string
project	Project	The instance.
return	string

BuildMsiCmd() public static method

Builds the WiX source file and generates batch file capable of building MSI with WiX toolset.

public static BuildMsiCmd ( Project project, string path ) : string
project	Project	The instance.
path	string	The path to the batch file to be build.
return	string

BuildMsm() public static method

Builds the MSM file from the specified Project instance.

public static BuildMsm ( Project project ) : string
project	Project	The instance.
return	string

BuildMsm() public static method

Builds the MSM file from the specified Project instance.

public static BuildMsm ( Project project, string path ) : string
project	Project	The instance.
path	string	The path to the MSM file to be build.
return	string

BuildMsmCmd() public static method

Builds the WiX source file and generates batch file capable of building MSM with WiX toolset.

public static BuildMsmCmd ( Project project ) : string
project	Project	The instance.
return	string

BuildMsmCmd() public static method

Builds the WiX source file and generates batch file capable of building MSM with WiX toolset.

public static BuildMsmCmd ( Project project, string path ) : string
project	Project	The instance.
path	string	The path to the batch file to be build.
return	string

BuildPackageAsm() public static method

Packages the assembly containing managed CA or UI.

public static BuildPackageAsm ( string asm, string nativeDll = null, string refAssemblies = null, string outDir = null, string configFilePath = null, System.Platform platform = null, bool embeddedUI = false ) : string
asm	string	The assembly to be packaged.
nativeDll	string	The package file (native DLL) to be build.
refAssemblies	string	The referenced assemblies.
outDir	string	The out dir.
configFilePath	string	The app config file path.
platform	System.Platform	The platform.
embeddedUI	bool	if set to true the assembly as an 'EmbeddedUI' assembly.
return	string

BuildPackageAsmCmd() public static method

Builds the batch file for packaging the assembly containing managed CA or UI.

public static BuildPackageAsmCmd ( string asm, string nativeDll, string refAssemblies, string outDir, string configFilePath, System.Platform platform = null, bool embeddedUI = false ) : string
asm	string	The assembly to be packaged.
nativeDll	string	The package file (native DLL) to be build.
refAssemblies	string	The referenced assemblies.
outDir	string	The out dir.
configFilePath	string	The app config file path.
platform	System.Platform	The platform.
embeddedUI	bool	if set to true the assembly as an 'EmbeddedUI' assembly.
return	string

BuildWxs() public static method

Builds the WiX source file (*.wxs) from the specified Bundle instance.

public static BuildWxs ( Bundle project ) : string
project	WixSharp.Bootstrapper.Bundle	The project.
return	string

BuildWxs() public static method

Builds the WiX source file (*.wxs) from the specified Project instance for further compiling into MSI file.

public static BuildWxs ( Project project ) : string
project	Project	The instance.
return	string

BuildWxs() public static method

Builds the WiX source file (*.wxs) from the specified Project instance.

public static BuildWxs ( Project project, OutputType type ) : string
project	Project	The instance.
type	OutputType	The type () of the setup file to be defined in the source file (MSI vs. MSM).
return	string

BuildWxs() public static method

Builds the WiX source file (*.wxs) from the specified Project instance.

public static BuildWxs ( Project project, string path, OutputType type ) : string
project	Project	The instance.
path	string	The path to the WXS file to be build.
type	OutputType	The type () of the setup file to be defined in the source file (MSI vs. MSM).
return	string

DefaultWixSourceFormatedHandler() public static method

The default Compiler.WixSourceFormated event handler.

public static DefaultWixSourceFormatedHandler ( string &xml ) : void
xml	string	The XML text string representing WiX XML source code.
return	void

DefaultWixSourceGeneratedHandler() public static method

The default Compiler.WixSourceGenerated event handler.

public static DefaultWixSourceGeneratedHandler ( System.Xml.Linq.XDocument doc ) : void
doc	System.Xml.Linq.XDocument	The XDocument object representing WiX XML source code.
return	void

GenerateWixProj() public static method

Generates WiX XML source file the specified Project instance.

public static GenerateWixProj ( Project project ) : System.Xml.Linq.XDocument
project	Project	The instance.
return	System.Xml.Linq.XDocument

Property Details

AllowNonRtfLicense public_oe static_oe property

Defines if license file can be have non RTF extension.

public static bool AllowNonRtfLicense
return	bool

AssemblyResolve public_oe static_oe property

The assembly resolve handler. If it is set then it will be used for all assembly probing (AppDomain.AssemblyResolve event) performed in all AppDomains.

public static ResolveEventHandler AssemblyResolve
return	ResolveEventHandler

AutoGeneration public_oe static_oe property

Contains settings for XML auto-generation.

public static AutoGenerationOptions,WixSharp AutoGeneration
return	AutoGenerationOptions

CandleOptions public_oe static_oe property

WiX compiler Candle.exe options.

The default value is "-sw1076" (disable warning 1026).

public static string CandleOptions
return	string

EmitRelativePaths public_oe static_oe property

Indicates whether compiler should emit relative or absolute paths in the WiX XML source.

public static bool EmitRelativePaths
return	bool

IgnoreClientAssemblyPDB public_oe static_oe property

Flag indicating whether to include PDB file of the assembly implementing ManagedCustomAction into MSI. Default value is False.

If set to false PDB file will not be included and debugging of such CustomAction will not be possible.

public static bool IgnoreClientAssemblyPDB
return	bool

LightOptions public_oe static_oe property

WiX linker Light.exe options.

The default value is "-sw1076 -sw1079" (disable warning 1076 and 1079).

public static string LightOptions
return	string

PreserveTempFiles public_oe static_oe property

Forces Compiler to preserve all temporary build files (e.g. *.wxs).

The default value is false: all temporary files are deleted at the end of the build/compilation.

Note: if Compiler fails to build MSI the PreserveTempFiles value is ignored and all temporary files are preserved.

public static bool PreserveTempFiles
return	bool

TempFiles public_oe static_oe property

The collection of temporary files created by compiler routine(s). These files will always be deleted unless Project/Compiler PreserveTempFiles property is set to true;

public static List TempFiles
return	List