Sandcastle Help File Builder Documentation
Code
This is used to track a single code snippet in the SyntaxComponent
Definition
Namespace: Sandcastle.Tools.BuildComponents.Snippets
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2025.9.30.0
Assembly: Sandcastle.Tools.BuildComponents (in Sandcastle.Tools.BuildComponents.dll) Version: 2025.9.30.0
C#
public sealed class CodeSnippetVB
Public NotInheritable Class CodeSnippetC++
public ref class CodeSnippet sealedF#
[<SealedAttribute>]
type CodeSnippet = class end- Inheritance
- Object CodeSnippet
Constructors
| CodeSnippet | Constructor |
Properties
| CodeElement | This read-only property returns the code element |
| KeywordStyleParameter | This is used to get the keyword style parameter |
| Language | This read-only property returns the language for the snippet |
| LanguageElementName | This is used to get or set the language element name |
| SortOrder | This is used to get or set the sort order |
| Title | This read-only property returns the title for the snippet if one is defined |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |