This method is used to initialize the plug-in at the start of the
build process.
Namespace: SandcastleBuilder.PlugInsAssembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 1.9.7.0
Syntax
| C# |
|---|
public void Initialize( BuildProcess buildProcess, XPathNavigator configuration ) |
| Visual Basic |
|---|
Public Sub Initialize ( buildProcess As BuildProcess, configuration As XPathNavigator ) |
Parameters
- buildProcess
- Type: SandcastleBuilder.Utils.BuildEngine..::..BuildProcess
A reference to the current build process.
- configuration
- Type: System.Xml.XPath..::..XPathNavigator
The configuration data that the plug-in should use to initialize itself.
Implements
IPlugIn..::..Initialize(BuildProcess, XPathNavigator)
Exceptions
| Exception | Condition |
|---|---|
| SandcastleBuilder.Utils..::..BuilderException | This is thrown if the plug-in configuration is not valid. |