In This Article

ICodeSnippet Interface

Provides the base requirements for a code snippet.

public interface ICodeSnippet : ICodeSnippetMetadata

Properties

Author

Gets the name of the code snippet author.

string Author { get; }

Property Value

string:

The name of the code snippet author.

CodeDelimiter

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

string CodeDelimiter { get; }

Property Value

string:

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

CodeText

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

string CodeText { get; }

Property Value

string:

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

Declarations

Gets the collection of declarations.

IList<ICodeSnippetDeclaration> Declarations { get; }

Property Value

IList<ICodeSnippetDeclaration>:

The collection of declarations.

HelpUrl

Gets a URL that provides more information about the code snippet.

string HelpUrl { get; }

Property Value

string:

A URL that provides more information about the code snippet.

ImportedNamespaces

Gets the collection of imported namespaces.

IList<string> ImportedNamespaces { get; }

Property Value

IList<string>:

The collection of imported namespaces.

Keywords

Gets the collection of keywords that describe the code snippet.

IList<string> Keywords { get; }

Property Value

IList<string>:

The collection of keywords that describe the code snippet.

References

Gets the collection of assembly references.

IList<ICodeSnippetAssemblyReference> References { get; }

Property Value

IList<ICodeSnippetAssemblyReference>:

The collection of assembly references.

Tag

Gets or sets the object that contains user-defined data about the object.

object Tag { get; set; }

Property Value

object:

An object that contains user-defined data about the object. The default is null.

Remarks

Any type derived from the object class can be assigned to this property.

Inherited Members