BuildComponentCore Class
Definition
- Assembly
- Sandcastle.Core.dll
This is the abstract base class for all build components
public abstract class BuildComponentCore : IDisposable- Inheritance
-
BuildComponentCore
- Implements
- Derived
Constructors
| BuildComponentCore(IBuildAssembler) |
Constructor |
Properties
| BuildAssembler |
This read-only property returns a reference to the build assembler instance using the component |
| 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. |
| 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 |
| OnComponentEvent(EventArgs) |
This can be used to raise the ComponentEvent event with the specified event arguments. |
| WriteMessage(MessageLevel, string, params object[]) |
This can be used to report a message |
| WriteMessage(string, MessageLevel, string, params object[]) |
This can be used to report a message for a specific topic ID |
| ~BuildComponentCore() |
This handles garbage collection to ensure proper disposal of the build component if not done explicitly with Dispose(). |