CodeBlockComponent.Factory.ConfigureComponent Method

CodeBlockComponentFactoryConfigureComponent Method

This method can be overridden to let configuration tools allow the user to edit the component configuration.

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

Syntax

C++

Copy

public override string ConfigureComponent(
	string currentConfiguration,
	CompositionContainer container
)

Public Overrides Function ConfigureComponent ( 
	currentConfiguration As String,
	container As CompositionContainer
) As String

public:
virtual String^ ConfigureComponent(
	String^ currentConfiguration, 
	CompositionContainer^ container
) override

abstract ConfigureComponent : 
        currentConfiguration : string * 
        container : CompositionContainer -> string 
override ConfigureComponent : 
        currentConfiguration : string * 
        container : CompositionContainer -> string

Parameters

currentConfiguration: Type: SystemString
A string containing the current configuration XML fragment
container: Type: System.ComponentModel.Composition.HostingCompositionContainer
A composition container that holds all of the exported components found by the build tool. This can be used to locate and work with other components if necessary.

Return Value

Type: String
A string containing the new configuration XML fragment

Remarks

The base implementation uses a generic editor dialog that edits the XML as text

Reference

CodeBlockComponentFactory Class

SandcastleBuilder.Components Namespace