ExampleComponent Class

Definition

Namespace

Sandcastle.Tools.BuildComponents

Assembly

Sandcastle.Tools.BuildComponents.dll

This build component is used to replace code references with snippets from a file

public class ExampleComponent : BuildComponentCore, IDisposable

Inheritance

object

BuildComponentCore

ExampleComponent

Implements

IDisposable

Constructors

ExampleComponent(IBuildAssembler)

Constructor

Properties

BuildAssembler	This read-only property returns a reference to the build assembler instance using the component (Inherited from BuildComponentCore)
GroupId	This is used to set an optional group ID for use with component events (Inherited from BuildComponentCore)

Methods

Apply(XmlDocument, string)	This abstract method must be overridden to apply the build component's changes to the specified document.
Dispose()	This implements the Dispose() interface to properly dispose of the build component. (Inherited from BuildComponentCore)
Initialize(XPathNavigator)	This abstract method must be overridden to initialize the component