IPlugIn.ConfigurePlugIn Method

IPlugInConfigurePlugIn Method

This method is used by the Sandcastle Help File Builder to let the plug-in perform its own configuration.

Namespace: SandcastleBuilder.Utils.BuildComponent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

string ConfigurePlugIn(
	SandcastleProject project,
	string currentConfig
)

Function ConfigurePlugIn ( 
	project As SandcastleProject,
	currentConfig As String
) As String

String^ ConfigurePlugIn(
	SandcastleProject^ project, 
	String^ currentConfig
)

abstract ConfigurePlugIn : 
        project : SandcastleProject * 
        currentConfig : string -> string

project: Type: SandcastleBuilder.UtilsSandcastleProject
A reference to the active project
currentConfig: Type: SystemString
The current configuration XML fragment

Type: String
A string containing the new configuration XML fragment

Remarks

This method is only called if the IsConfigurable property returns true. The configuration data will be stored in the help file builder project.