Sandcastle Help File Builder Documentation
Syntax
This build component is used to generate syntax sections for API member topics
Definition
Namespace: Sandcastle.Tools.BuildComponents
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2024.2.18.0
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2024.2.18.0
C#
public class SyntaxComponent : BuildComponentCoreVB
Public Class SyntaxComponent
Inherits BuildComponentCoreC++
public ref class SyntaxComponent : public BuildComponentCoreF#
type SyntaxComponent =
class
inherit BuildComponentCore
end- Inheritance
- Object BuildComponentCore SyntaxComponent
Constructors
| SyntaxComponent | 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 |
This abstract method must be overridden to apply the build component's changes to the specified
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) |
| 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.
(Inherited from BuildComponentCore) |
| 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
(Overrides BuildComponentCoreInitialize(XPathNavigator)) |
| 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.
(Inherited from BuildComponentCore) |
| ToString | Returns 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) |