In This Article

ICodeSnippet Interface

Provides the base requirements for a code snippet.

public interface ICodeSnippet : ICodeSnippetMetadata

Properties

Author

The name of the code snippet author.

string? Author { get; }

Property Value

string

CodeDelimiter

The character used to describe literals and objects in the code.

string? CodeDelimiter { get; }

Property Value

string

CodeText

The code that is inserted when the code snippet is activated.

string? CodeText { get; }

Property Value

string

Declarations

The collection of declarations.

IList<ICodeSnippetDeclaration> Declarations { get; }

Property Value

IList<ICodeSnippetDeclaration>

HelpUrl

A URL that provides more information about the code snippet.

string? HelpUrl { get; }

Property Value

string

ImportedNamespaces

The collection of imported namespaces.

IList<string> ImportedNamespaces { get; }

Property Value

IList<string>

Keywords

The collection of keywords that describe the code snippet.

IList<string> Keywords { get; }

Property Value

IList<string>

References

The collection of assembly references.

IList<ICodeSnippetAssemblyReference> References { get; }

Property Value

IList<ICodeSnippetAssemblyReference>

Tag

The object that contains user-defined data about the object.

object? Tag { get; set; }

Property Value

object

Inherited Members

Extension Methods