WiXHelper

Use this to attach service installs to your components.

Creates WiX component with directories and files from the given DirectoryInfo The function will create one component for each file best practice and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. You can use the getComponentIdsFromWiXString function for getting all created component refs and adding them to features.

Creates WiX component with directories and files from the given DirectoryInfo The function will create one component for each file best practice and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. The components are embedded into the passed in root directory.

Creates a WiX directory and component hierarchy from the given DirectoryInfo The function will create one component for each file best practice and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. You can use the getComponentRefs function for getting all created component refs and adding them to features. You can use attachServiceControlToComponents or attachServiceInstallToComponents to attach ServiceControl or ServiceInstall to the directory component hierarchy

Runs the Candle tool on the given WiX script with the given parameters

Default values for creating WiX Feature

Takes path where script files reside and sets all parameters as defined

Parameters

• wiXPath - Pass path where your script is located at. Function will search for all Scripts in that location and fill in parameters
• setParams - Function used to manipulate the WiX default parameters.

Sample

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 
13: 
14: 
15: 
16: 
17: 

FillInWixScript "" (fun f ->
                       {f with
                           ProductCode = WiXProductCode
                           ProductName = WiXProductName
                           Description = projectDescription
                           ProductLanguage = WiXProductLanguage
                           ProductVersion = WiXProductVersion
                           ProductPublisher = WixProductPublisher
                           UpgradeGuid = WixProductUpgradeGuid
                           UIRefs = uiRef1.ToString() + uiRef2.ToString()
                           WiXVariables = wiXLicense.ToString()
                           Directories = directories
                           BuildNumber = "1.0.0"
                           Features = rootFeature.ToString()
                           CustomActions = action1.ToString() + action2.ToString()
                           ActionSequences = actionExecution1.ToString() + actionExecution2.ToString()
                       })

Takes path where script files reside and sets all parameters as defined

Parameters

• wiXPath - Pass path where your script is located at. Function will search for all Scripts in that location and fill in parameters
• setParams - Function used to manipulate the WiX default parameters.

Sample

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 
13: 
14: 
15: 
16: 
17: 
18: 

FillInWixScript "" (fun f ->
                       {f with
                           ProductCode = WiXProductCode
                           ProductName = WiXProductName
                           Description = projectDescription
                           ProductLanguage = WiXProductLanguage
                           ProductVersion = WiXProductVersion
                           ProductPublisher = WixProductPublisher
                           UpgradeGuid = WixProductUpgradeGuid
                           UIRefs = uiRef1.ToString() + uiRef2.ToString()
                           WiXVariables = wiXLicense.ToString()
                           Directories = directories
                           DirectoryRefs = directoryrefs
                           BuildNumber = "1.0.0"
                           Features = rootFeature.ToString()
                           CustomActions = action1.ToString() + action2.ToString()
                           ActionSequences = actionExecution1.ToString() + actionExecution2.ToString()
                       })

Use this for generating single components

Use this for generating component refs

Generates a customAction based on the given parameters, use toString on it when embedding it Be careful to make Id unique. FileKey is a reference to a file Id which you added by using wixDir or wixFile Set impersonate to no if your action needs elevated privileges, you should then also set execute as "deferred" ExeCommand are the parameters passed to your executable

Parameters

• setParams - Function used to manipulate the WiX default parameters.

Sample

1: 
2: 
3: 
4: 
5: 
6: 
7: 
8: 
9: 

let action = generateCustomAction (fun f ->
                                       {f with
                                           Id = "UniqueActionId"
                                           FileKey = "fi_5"
                                           Execute = "deferred"
                                           Impersonate = "no"
                                           ExeCommand = "install"
                                           Return = "check"
                                       })

Generates a custom action execution based on the given parameters, use toString on it when embedding it Condition in sample makes execute only on install

Parameters

• setParams - Function used to manipulate the WiX default parameters.

Sample

1: 
2: 
3: 
4: 
5: 
6: 
7: 

let actionExecution = generateCustomActionExecution (fun f ->
                                                           {f with 
                                                               ActionId = action.Id
                                                               Verb = "After"
                                                               Target = "InstallFiles"                                                                        
                                                               Condition = "<![CDATA[(&" + feature.Id + " = 3) AND NOT (!" + feature.Id + " = 3)]]>"
                                                           })

Use this for generating directories

Use this for generating component refs

Generates a feature based on the given parameters, use toString on it when embedding it You can pass other features into InnerContent for making a hierarchy

Parameters

• setParams - Function used to manipulate the WiX default parameters.

Sample

1: 
2: 
3: 
4: 
5: 
6: 
7: 
8: 
9: 

let feature = generateFeature (fun f -> 
                                   {f with  
                                       Id = "UniqueName"
                                       Title = "Title which is shown"
                                       Level = 1 
                                       Description = "Somewhat longer description" 
                                       Display = "expand" 
                                       InnerContent = otherFeature.ToString()
                                   })

Generates a feature based on the given parameters, use toString on it when embedding it You can pass other features into InnerContent for making a hierarchy

Parameters

• setParams - Function used to manipulate the WiX default parameters.

Sample

1: 
2: 
3: 
4: 
5: 
6: 
7: 
8: 
9: 

let feature = generateFeature (fun f -> 
                                   {f with  
                                       Id = "UniqueName"
                                       Title = "Title which is shown"
                                       Level = 1 
                                       Description = "Somewhat longer description" 
                                       Display = "expand" 
                                       InnerContent = [otherFeature1; otherFeature2]
                                   })

Generates a major upgrade based on the given parameters, use toString on it when embedding it

Parameters

• setParams - Function used to manipulate the WiX default parameters.

Sample

1: 
2: 
3: 
4: 

let majorUpgradeVersion = generateMajorUpgradeVersion(fun f ->
                                                {f with 
                                                    DowngradeErrorMessage = "A later version is already installed, exiting."
                                                })

Generates a registry key based on the given parameters, use toString on it when embedding it You can pass other registry keys and values into RegistryKeys or RegistryValues for making a hierarchy

Parameters

• setParams - Function used to manipulate the WiX default parameters.

Sample

let key = generateRegistryKey(fun k -> {k with Id = "KeyId" Key = "SomeKey" Root = Some WiXRegistryRootType.HKCR ForceCreateOnInstall = YesOrNo.Yes ForceDeleteOnUninstall = YesOrNo.No Keys = someChildKeys Values = someChildValues })

Generates a registry value based on the given parameters, use toString on it when embedding it

Parameters

• setParams - Function used to manipulate the WiX default parameters.

Sample

let registryValue = generateRegistryValue(fun v -> {v with Id = "asdasd" Name = "Something" Key = "Somewhere" Root = Some WiXRegistryRootType.HKU Type = WiXRegistryValueType.Integer KeyPath = YesOrNo.No Value = "2" })

Use this for generating service configs

Use this for generating service controls

Use this for generating service dependencies

Use this for generating service installs

Generates a ui ref based on the given parameters, use toString on it when embedding it

Parameters

• setParams - Function used to manipulate the WiX default parameters.

Sample

1: 
2: 
3: 
4: 

let UIRef = generateUIRef (fun f ->
                               {f with
                                   Id = "WixUI_Mondo"
                               })

Generates an upgrade based on the given parameters, use toString on it when embedding it

Parameters

• setParams - Function used to manipulate the WiX default parameters.

Sample

1: 
2: 
3: 
4: 

let upgrade = generateUpgrade (fun f ->
                                  {f with
                                     Id = productUpgradeCode
                                  })

Generates an upgrade version based on the given parameters, use toString on it when embedding it

Parameters

• setParams - Function used to manipulate the WiX default parameters.

Sample

1: 
2: 
3: 
4: 
5: 

let upgradeVersion = generateUpgradeVersion (fun f ->
                                                {f with
                                                   Minimum = productVersion
                                                   OnlyDetect = "yes"
                                                })

Generates WiX Template with specified file name (you can prepend location too) You need to run this once every build an then use FillInWiXScript to replace placeholders

Parameters

• fileName - Pass desired fileName for your wiXScript file

Sample

1: 

generateWiXScript "Setup.wxs"

Retrieves all component ids from given WiX directory string

Parameters

• wiXString - The directory string which was generated by wixDir

Sample

1: 
2: 

let directoryString = wixDir (fun file -> true) true (DirectoryInfo directoryWithFilesForSetup)
let componentIds = getComponentIdsFromWiXString directoryString

get component refs from a directory component hierarchy

Retrieves the file id of the first file in WiXString, which name matches fileRegex

Parameters

• wiXString - The directory string which was generated by wixDir
• fileRegex - Regex which matches the file name

Sample

1: 
2: 

let directoryString = wixDir (fun file -> true) true (DirectoryInfo directoryWithFilesForSetup)
let executableFileId = getFileIdFromWiXString directoryString "\S*.exe"

Creates WiX File tags from the given files

Harvests the contents of a Directory for use with Wix using the Heat tool.

Parameters

• setParams - Function used to manipulate the Heat default parameters.
• directory - The path to the directory that will be harvested by Heat.
• outputFile - The output file path given to Heat.

Default values for the Heat harvesting

Runs the Light tool on the given WiX script with the given parameters

Default values for WiX Script properties

Take a component string and set "neverOverwrite" Tag This is useful for config files, since they are not replaced on upgrade like that

Uses the WiX tools Candle and Light to create an msi.

Parameters

• setParams - Function used to manipulate the WiX default parameters.
• outputFile - The msi output file path (given to Light).
• wixScript - The path to a WiX script that will be used with Candle.

Sample

 1: 
 2: 
 3: 
 4: 
 5: 
 6: 
 7: 
 8: 
 9: 
10: 
11: 
12: 
13: 
14: 
15: 
16: 
17: 
18: 
19: 
20: 
21: 
22: 
23: 
24: 

Target "BuildSetup" (fun _ ->
    // Copy all important files to the deploy directory
    !! (buildDir + "/**/*.dll")
      ++ (buildDir + "/**/*.exe")
      ++ (buildDir + "/**/*.config")
      |> Copy deployPrepDir 

    // replace tags in a template file in order to generate a WiX script
    let ALLFILES = fun _ -> true

    let replacements = [
        "@build.number@",if not isLocalBuild then buildVersion else "0.1.0.0"
        "@product.productcode@",System.Guid.NewGuid().ToString()
        "@HelpFiles@",getFilesAsWiXString helpFiles
        "@ScriptFiles@",getFilesAsWiXString scriptFiles
        "@icons@",wixDir ALLFILES true (directoryInfo(bundledDir @@ "icons"))]

    processTemplates replacements setupFiles

    // run the WiX tools
    WiX (fun p -> {p with ToolDirectory = WiXPath}) 
        setupFileName
        (setupBuildDir + "Setup.wxs.template")
)

Defaults for component

Defaults for component ref

Creates WiX ComponentRef tags from the given DirectoryInfo

Default values for WiX custom actions

Default values for WiX custom action executions

Contains the WiX default parameters

Creates recursive WiX directory and file tags from the given DirectoryInfo The function will create one component for each file best practice and set the GUID to "*", which will make WiX produce consistent Component Guids if the Component's target path doesn't change. This is vital for major upgrades, since windows installer needs a consistent component guid for tracking each of them. You can use the getComponentIdsFromWiXString function for getting all created component refs and adding them to features.

Defaults for directories

Defaults for component ref

Default values for creating WiX Feature

Creates a WiX File tag from the given FileInfo

Defaults for WiX file

Default value for WiX Major Upgrade

Default values for WiX Script properties

Defaults for service control element

Defaults for service install element

Default value for WiX UI Reference (WixUI_Minimal)

Default value for WiX Upgrade

Default value for WiX Upgrade

Default value for WiX Variable