CopyFromIndexComponent Class

Definition

Namespace

Sandcastle.Tools.BuildComponents

Assembly

Sandcastle.Tools.BuildComponents.dll

This build component copies elements from an indexed set of XML files into the target document based on one or more copy commands that define the elements to copy and where to put them.

public class CopyFromIndexComponent : BuildComponentCore, IDisposable

Inheritance

object

BuildComponentCore

CopyFromIndexComponent

Implements

IDisposable

Constructors

CopyFromIndexComponent(IBuildAssembler)

Constructor

Properties

BuildAssembler	This read-only property returns a reference to the build assembler instance using the component (Inherited from BuildComponentCore)
Context	This read-only property returns the context to use for the index when evaluating XPath expressions
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.
CreateIndex(XPathNavigator)	This is used to create the index cache
Dispose()	This implements the Dispose() interface to properly dispose of the build component. (Inherited from BuildComponentCore)
Dispose(bool)	This can be overridden by derived classes to add their own disposal code if necessary.
Initialize(XPathNavigator)	This abstract method must be overridden to initialize the component