LightweightWebsiteStylePlugIn.ConfigurePlugIn Method

LightweightWebsiteStylePlugInConfigurePlugIn Method

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

Namespace: SandcastleBuilder.PlugIns
Assembly: SandcastleBuilder.PlugIns (in SandcastleBuilder.PlugIns.dll) Version: 2014.11.22.0

Syntax

C++

Copy

public string ConfigurePlugIn(
	SandcastleProject project,
	string currentConfig
)

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

public:
virtual String^ ConfigurePlugIn(
	SandcastleProject^ project, 
	String^ currentConfig
) sealed

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

Parameters

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

Return Value

Type: String
A string containing the new configuration XML fragment

Implements

IPlugInConfigurePlugIn(SandcastleProject, String)

Remarks

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

Reference

LightweightWebsiteStylePlugIn Class

SandcastleBuilder.PlugIns Namespace