TransformDocumentDumpComponent Class

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.

Definition

Namespace: Sandcastle.Tools.BuildComponents
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2024.9.12.0
public class TransformDocumentDumpComponent : BuildComponentCore
Inheritance
Object    BuildComponentCore    TransformDocumentDumpComponent

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

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 Apply this build component's changes to the document
(Overrides BuildComponentCoreApply(XmlDocument, String))
Dispose This implements the Dispose() interface to properly dispose of the build component.
(Inherited from BuildComponentCore)
Dispose(Boolean) This can be overridden by derived classes to add their own disposal code if necessary.
(Inherited from BuildComponentCore)
EqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Finalize This handles garbage collection to ensure proper disposal of the build component if not done explicitly with Dispose.
(Inherited from BuildComponentCore)
GetHashCodeServes as the default hash function.
(Inherited from Object)
GetTypeGets the Type of the current instance.
(Inherited from Object)
Initialize Initialize the build component
(Overrides BuildComponentCoreInitialize(XPathNavigator))
MemberwiseCloneCreates a shallow copy of the current Object.
(Inherited from Object)
OnComponentEvent This can be used to raise the ComponentEvent event with the specified event arguments.
(Inherited from BuildComponentCore)
ToStringReturns a string that represents the current object.
(Inherited from Object)
WriteMessage(MessageLevel, String, Object) This can be used to report a message
(Inherited from BuildComponentCore)
WriteMessage(String, MessageLevel, String, Object) This can be used to report a message for a specific topic ID
(Inherited from BuildComponentCore)

See Also