Sandcastle Help File Builder Documentation
Build
This is the abstract base class for all build components
Definition
Namespace: Sandcastle.Core.BuildAssembler.BuildComponent
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.2.18.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.2.18.0
C#
public abstract class BuildComponentCore : IDisposableVB
Public MustInherit Class BuildComponentCore
Implements IDisposableC++
public ref class BuildComponentCore abstract : IDisposableF#
[<AbstractClassAttribute>]
type BuildComponentCore =
class
interface IDisposable
end- Inheritance
- Object BuildComponentCore
- Derived
- Implements
- IDisposable
Constructors
| BuildComponentCore | 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 | 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(Boolean) | This can be overridden by derived classes to add their own disposal code if necessary. |
| Equals | Determines 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.
(Overrides ObjectFinalize) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize | This abstract method must be overridden to initialize the component |
| MemberwiseClone | Creates 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. |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| WriteMessage(MessageLevel, String, Object) | This can be used to report a message |
| WriteMessage(String, MessageLevel, String, Object) | This can be used to report a message for a specific topic ID |