Sandcastle Help File Builder Documentation
Syntax
This abstract class is used as the base class for syntax generators
Definition
Namespace: Sandcastle.Core.BuildAssembler.SyntaxGenerator
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2025.9.30.0
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2025.9.30.0
C#
public abstract class SyntaxGeneratorTemplate : SyntaxGeneratorCoreVB
Public MustInherit Class SyntaxGeneratorTemplate
Inherits SyntaxGeneratorCoreC++
public ref class SyntaxGeneratorTemplate abstract : public SyntaxGeneratorCoreF#
[<AbstractClassAttribute>]
type SyntaxGeneratorTemplate =
class
inherit SyntaxGeneratorCore
end- Inheritance
- Object SyntaxGeneratorCore SyntaxGeneratorTemplate
- Derived
Constructors
| SyntaxGeneratorTemplate | Constructor |
Properties
| Language | This is used to get or set the language name |
| StyleId | This is used to get or set the style ID |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Initialize |
Initialize the syntax generator
(Overrides SyntaxGeneratorCoreInitialize(XPathNavigator)) |
| IsUnsupportedExplicit | Write unsupported explicit implementation syntax |
| IsUnsupportedGeneric | Write unsupported generic types syntax |
| IsUnsupportedUnsafe | Write unsupported unsafe code syntax |
| IsUnsupportedVarargs | Write unsupported variable arguments syntax |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| WriteAttachedEventSyntax | Write attached event syntax |
| WriteAttachedPropertySyntax | Write attached property syntax |
| WriteCastSyntax | Write cast syntax |
| WriteClassSyntax | Write class syntax |
| WriteConstantValue | Write out a constant's value |
| WriteConstructorSyntax | Write constructor syntax |
| WriteDelegateSyntax | Write delegate syntax |
| WriteEnumerationSyntax | Write enumeration syntax |
| WriteEventSyntax | Write event syntax |
| WriteFieldSyntax | Write field syntax |
| WriteInterfaceSyntax | Write interface syntax |
| WriteMemberSyntax | Write member syntax |
| WriteMethodSyntax | Write method syntax |
| WriteNamespaceSyntax | Write namespace syntax |
| WriteNormalMethodSyntax | Write normal method syntax |
| WriteNormalTypeReference | Write out a normal type reference |
| WriteOperatorSyntax | Write operator syntax |
| WritePropertySyntax | Write property syntax |
| WriteStructureSyntax | Write structure syntax |
| WriteSyntax |
This is the main syntax writing method
(Overrides SyntaxGeneratorCoreWriteSyntax(XPathNavigator, SyntaxWriter)) |
| WriteTypeReference | Write out a type reference |
| WriteTypeSyntax | Write type syntax |
| WriteWithLineBreakIfNeeded | This is used to write a string followed by an optional line break if needed (the writer position is past the maximum position afterwards). |
Fields
| MaxPosition | The maximum line width for the generated syntax |