CodeSnippetStatement Class

Reference

Definition

Namespace:: System.CodeDom

Assembly:: System.CodeDom.dll

Assembly:: System.dll

Package:: System.CodeDom v8.0.0

Package:: System.CodeDom v9.0.0-rc.2.24473.5

Source:: CodeSnippetStatement.cs

Source:: CodeSnippetStatement.cs

Source:: CodeSnippetStatement.cs

Source:: CodeSnippetStatement.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents a statement using a literal code fragment.

public ref class CodeSnippetStatement : System::CodeDom::CodeStatement

public class CodeSnippetStatement : System.CodeDom.CodeStatement

[System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)]
[System.Runtime.InteropServices.ComVisible(true)]
[System.Serializable]
public class CodeSnippetStatement : System.CodeDom.CodeStatement

type CodeSnippetStatement = class
    inherit CodeStatement

[<System.Runtime.InteropServices.ClassInterface(System.Runtime.InteropServices.ClassInterfaceType.AutoDispatch)>]
[<System.Runtime.InteropServices.ComVisible(true)>]
[<System.Serializable>]
type CodeSnippetStatement = class
    inherit CodeStatement

Public Class CodeSnippetStatement
Inherits CodeStatement

Inheritance: Object

CodeObject

CodeStatement
CodeSnippetStatement

Attributes: ClassInterfaceAttribute ComVisibleAttribute SerializableAttribute

Examples

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));

Dim snippet1 As New CodeSnippetStatement()
snippet1.Value = "            Console.WriteLine(field1)"

Dim regionStart As 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))

Remarks

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.

Constructors

CodeSnippetStatement()	Initializes a new instance of the CodeSnippetStatement class.
CodeSnippetStatement(String)	Initializes a new instance of the CodeSnippetStatement class using the specified code fragment.

Properties

EndDirectives	Gets a CodeDirectiveCollection object that contains end directives. (Inherited from CodeStatement)
LinePragma	Gets or sets the line on which the code statement occurs. (Inherited from CodeStatement)
StartDirectives	Gets a CodeDirectiveCollection object that contains start directives. (Inherited from CodeStatement)
UserData	Gets the user-definable data for the current object. (Inherited from CodeObject)
Value	Gets or sets the literal code fragment statement.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Share via