This topic has not yet been rated - Rate this topic

CodeSnippetStatement Class

Represents a statement using a literal code fragment.

System.Object
  System.CodeDom.CodeObject
    System.CodeDom.CodeStatement
      System.CodeDom.CodeSnippetStatement

Namespace:  System.CodeDom
Assembly:  System (in System.dll)
[SerializableAttribute]
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
[ComVisibleAttribute(true)]
public class CodeSnippetStatement : CodeStatement

The CodeSnippetStatement type exposes the following members.

  Name Description
Public method CodeSnippetStatement() Initializes a new instance of the CodeSnippetStatement class.
Public method CodeSnippetStatement(String) Initializes a new instance of the CodeSnippetStatement class using the specified code fragment.
Top
  Name Description
Public property EndDirectives Gets a CodeDirectiveCollection object that contains end directives. (Inherited from CodeStatement.)
Public property LinePragma Gets or sets the line on which the code statement occurs. (Inherited from CodeStatement.)
Public property StartDirectives Gets a CodeDirectiveCollection object that contains start directives. (Inherited from CodeStatement.)
Public property UserData Gets the user-definable data for the current object. (Inherited from CodeObject.)
Public property Value Gets or sets the literal code fragment statement.
Top
  Name Description
Public method Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

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.StartDirectives.Add(regionStart);
snippet1.EndDirectives.Add(new CodeRegionDirective(CodeRegionMode.End, string.Empty));


.NET Framework

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ