This documentation is archived and is not being maintained.

CodeSnippetStatement Class

Updated: March 2009

Represents a statement using a literal code fragment.

Namespace:  System.CodeDom
Assembly:  System (in System.dll)

public class CodeSnippetStatement : CodeStatement

CodeSnippetStatement can represent a statement using a literal code fragment that will be included directly in the source without modification.

A CodeSnippetStatement stores a section of code exactly in its original format as a string. The CodeDOM does not translate literal code fragments. Literal code fragments are stored and output in their original format. CodeDOM objects that contain literal code are provided so developers can encapsulate code that is already in the target language.

The Value property contains the literal code for the snippet statement.

The following example creates an instance of the CodeSnippetStatement class using a literal code fragment. This code example is part of a larger example provided for the CodeRegionDirective class.

CodeSnippetStatement snippet1 = new CodeSnippetStatement();
snippet1.Value = "            Console.WriteLine(field1);";

CodeRegionDirective regionStart = new CodeRegionDirective(CodeRegionMode.End, "");
regionStart.RegionText = "Snippet Region";
regionStart.RegionMode = CodeRegionMode.Start;
snippet1.EndDirectives.Add(new CodeRegionDirective(CodeRegionMode.End, string.Empty));


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0




March 2009

Replaced code example.

Customer feedback.