This topic has not yet been rated - Rate this topic

CodeVariableDeclarationStatement Class

.NET Framework 4

Represents a variable declaration.

System.Object
  System.CodeDom.CodeObject
    System.CodeDom.CodeStatement
      System.CodeDom.CodeVariableDeclarationStatement

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

Syntax

C++

Copy

[SerializableAttribute]
[ClassInterfaceAttribute(ClassInterfaceType.AutoDispatch)]
[ComVisibleAttribute(true)]
public class CodeVariableDeclarationStatement : CodeStatement

The CodeVariableDeclarationStatement type exposes the following members.

Constructors

	Name	Description
	CodeVariableDeclarationStatement()	Initializes a new instance of the CodeVariableDeclarationStatement class.
	CodeVariableDeclarationStatement(CodeTypeReference, String)	Initializes a new instance of the CodeVariableDeclarationStatement class using the specified type and name.
	CodeVariableDeclarationStatement(String, String)	Initializes a new instance of the CodeVariableDeclarationStatement class using the specified data type name and variable name.
	CodeVariableDeclarationStatement(Type, String)	Initializes a new instance of the CodeVariableDeclarationStatement class using the specified data type and variable name.
	CodeVariableDeclarationStatement(CodeTypeReference, String, CodeExpression)	Initializes a new instance of the CodeVariableDeclarationStatement class using the specified data type, variable name, and initialization expression.
	CodeVariableDeclarationStatement(String, String, CodeExpression)	Initializes a new instance of the CodeVariableDeclarationStatement class using the specified data type, variable name, and initialization expression.
	CodeVariableDeclarationStatement(Type, String, CodeExpression)	Initializes a new instance of the CodeVariableDeclarationStatement class using the specified data type, variable name, and initialization expression.

Top

Properties

	Name	Description
	EndDirectives	Gets a CodeDirectiveCollection object that contains end directives. (Inherited from CodeStatement.)
	InitExpression	Gets or sets the initialization expression for the variable.
	LinePragma	Gets or sets the line on which the code statement occurs. (Inherited from CodeStatement.)
	Name	Gets or sets the name of the variable.
	StartDirectives	Gets a CodeDirectiveCollection object that contains start directives. (Inherited from CodeStatement.)
	Type	Gets or sets the data type of the variable.
	UserData	Gets the user-definable data for the current object. (Inherited from CodeObject.)

Top

Methods

	Name	Description
	Equals(Object)	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as a hash function for a particular type. (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.)

Top

Remarks

CodeVariableDeclarationStatement can be used to represent code that declares a variable.

The Type property specifies the type of the variable to declare. The Name property specifies the name of the variable to declare. The InitExpression property is optional, and specifies an initialization expression to assign to the variable after it is created.

Note
Some languages can implement the optional variable initialization expression by making a separate assignment statement after the variable declaration.

Examples

This example demonstrates using a CodeVariableDeclarationStatement to declare a variable.

C++

Copy


CodeVariableDeclarationStatement variableDeclaration = new CodeVariableDeclarationStatement(
    // Type of the variable to declare.
    typeof(string),
    // Name of the variable to declare.
    "TestString",
    // Optional initExpression parameter initializes the variable.
    new CodePrimitiveExpression("Testing") );

// A C# code generator produces the following source code for the preceeding example code:

// string TestString = "Testing";

Version Information

.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

Platforms

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.

Thread Safety

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

Reference

System.CodeDom Namespace

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)

Community Content Add

FAQ