Table of Contents

TransformDocumentDumpComponent Class

Definition

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

This build component is a development aid. It is used to save the pre-transform and post-transform document data for use in testing presentation style transformations and comparing the output.

public class TransformDocumentDumpComponent : BuildComponentCore, IDisposable
Inheritance
TransformDocumentDumpComponent
Implements

Remarks

This is a presentation style development aid. It saves the pre-transformed and post-transformed content of each document to a file in a .\RawDocs and .TransformedDocs subfolders in the project's working folder. The files in the .\RawDocs folder can be used for testing presentation style transforms without having to do a full project build. The files in the .\TransformedDocs folder can be used to compare against new styles or to ensure the content is equivalent to prior output.

Constructors

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

Apply this build component's changes to the document

Dispose()

This implements the Dispose() interface to properly dispose of the build component.

(Inherited from BuildComponentCore)
Initialize(XPathNavigator)

Initialize the build component