System.CodeDom.CodeSnippetStatement Class

Assembly: System.dll
Namespace: System.CodeDom
Summary
Represents a statement using a literal code fragment.
C# Syntax:
[Serializable]
public class CodeSnippetStatement : CodeStatement
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.

See also:
System.CodeDom Namespace

System.CodeDom.CodeSnippetStatement Member List:

Public Constructors
ctor #1 Overloaded:
.ctor()

Default constructor. This constructor is called by derived class constructors to initialize state in this type.
Initializes a new instance of the CodeSnippetStatement class.
ctor #2 Overloaded:
.ctor(string value)

Initializes a new instance of the CodeSnippetStatement class using the specified code fragment.
Public Properties
LinePragma
(inherited from System.CodeDom.CodeStatement)
Read-write

See base class member description: System.CodeDom.CodeStatement.LinePragma


Gets or sets the line the statement occurs on.
UserData
(inherited from System.CodeDom.CodeObject)
Read-only

See base class member description: System.CodeDom.CodeObject.UserData


Gets or sets the user-definable data for the current object.
Value Read-write

Gets or sets the literal code fragment statement.
Public Methods
Equals
(inherited from System.Object)
See base class member description: System.Object.Equals

Derived from System.Object, the primary base class for all objects.
GetHashCode
(inherited from System.Object)
See base class member description: System.Object.GetHashCode

Derived from System.Object, the primary base class for all objects.
GetType
(inherited from System.Object)
See base class member description: System.Object.GetType

Derived from System.Object, the primary base class for all objects.
ToString
(inherited from System.Object)
See base class member description: System.Object.ToString

Derived from System.Object, the primary base class for all objects.
Protected Methods
Finalize
(inherited from System.Object)
See base class member description: System.Object.Finalize

Derived from System.Object, the primary base class for all objects.
MemberwiseClone
(inherited from System.Object)
See base class member description: System.Object.MemberwiseClone

Derived from System.Object, the primary base class for all objects.

Hierarchy:


System.CodeDom.CodeSnippetStatement Member Details

Overloaded ctor #1
Summary
Initializes a new instance of the CodeSnippetStatement class.

Default constructor. This constructor is called by derived class constructors to initialize state in this type.
C# Syntax:
public CodeSnippetStatement();

Return to top


Overloaded ctor #2
Summary
Initializes a new instance of the CodeSnippetStatement class using the specified code fragment.
C# Syntax:
public CodeSnippetStatement(
   string value
);
Parameters:

value

The literal code fragment of the statement to represent.

Return to top


Property: LinePragma (read-write)
Inherited
See base class member description: System.CodeDom.CodeStatement.LinePragma

Summary
Gets or sets the line the statement occurs on.
C# Syntax:
public CodeLinePragma LinePragma {get; set;}
Remarks
This property indicates the location of the statement.
See also:
CodeLinePragma

Return to top


Property: UserData (read-only)
Inherited
See base class member description: System.CodeDom.CodeObject.UserData

Summary
Gets or sets the user-definable data for the current object.
C# Syntax:
public IDictionary UserData {get;}
Remarks


Notes to inheritors: An inheritor can design the way this user data is stored, retrieved, and used.

Return to top


Property: Value (read-write)
Summary
Gets or sets the literal code fragment statement.
C# Syntax:
public string Value {get; set;}

Return to top


Method: Equals(
   object obj
)
Inherited
See base class member description: System.Object.Equals
C# Syntax:
public virtual bool Equals(
   object obj
);

For more information on members inherited from System.Object click on the link above.

Return to top


Method: Finalize()
Inherited
See base class member description: System.Object.Finalize
C# Syntax:
~CodeSnippetStatement();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: GetHashCode()
Inherited
See base class member description: System.Object.GetHashCode
C# Syntax:
public virtual int GetHashCode();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: GetType()
Inherited
See base class member description: System.Object.GetType
C# Syntax:
public Type GetType();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: MemberwiseClone()
Inherited
See base class member description: System.Object.MemberwiseClone
C# Syntax:
protected object MemberwiseClone();

For more information on members inherited from System.Object click on the link above.

Return to top


Method: ToString()
Inherited
See base class member description: System.Object.ToString
C# Syntax:
public virtual string ToString();

For more information on members inherited from System.Object click on the link above.

Return to top


Top of page

Copyright (c) 2002 Microsoft Corporation. All rights reserved.