Table of Contents

SwitchComponent Class

Definition

Namespace
Sandcastle.Tools.BuildComponents
Assembly
Sandcastle.Tools.BuildComponents.dll

This build component executes a set of build components on the topic based on the result of an XPath expression.

public class SwitchComponent : BuildComponentCore, IDisposable
Inheritance
SwitchComponent
Implements

Constructors

SwitchComponent(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

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)
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