Table of Contents

SaveComponent Class

Definition

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

This build component is used to save the generated document or parts of it to a file

public class SaveComponent : BuildComponentCore, IDisposable
Inheritance
SaveComponent
Implements

Constructors

SaveComponent(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)
Dispose(bool)

Wait for the document writer task to complete when disposed

Initialize(XPathNavigator)

This abstract method must be overridden to initialize the component