Sandcastle Help File Builder Documentation
Snippet
This represents a snippet identifier
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 readonly struct SnippetIdentifierVB
Public Structure SnippetIdentifierC++
public value class SnippetIdentifierF#
[<SealedAttribute>]
type SnippetIdentifier =
struct
inherit ValueType
endConstructors
| SnippetIdentifier(String) | Constructor. This parses the example and snippet IDs from the given identifier |
| SnippetIdentifier(String, String) | Constructor. This version takes an example ID and a snippet ID |
Properties
| ExampleId | This read-only property returns the example ID |
| SnippetId | This read-only property returns the snippet ID |
Methods
| Equals | Indicates whether this instance and a specified object are equal. (Inherited from ValueType) |
| GetHashCode | Returns the hash code for this instance. (Inherited from ValueType) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ParseReference | This is used to parse a snippet identifier containing an example ID and one or more snippet IDs in a comma-separated list (i.e. ExampleID#SnippetID or ExampleID#SnippetID1,SnippetID2). |
| ToString |
This returns the snippet identifier
(Overrides ValueTypeToString) |