CodeParameterDeclarationExpression Class

.NET Framework (current version)

Represents a parameter declaration for a method, property, or constructor.

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

Inheritance Hierarchy

System::Object
System.CodeDom::CodeObject
System.CodeDom::CodeExpression
System.CodeDom::CodeParameterDeclarationExpression

Syntax

C++

[SerializableAttribute]
[ClassInterfaceAttribute(ClassInterfaceType::AutoDispatch)]
[ComVisibleAttribute(true)]
public ref class CodeParameterDeclarationExpression : CodeExpression

Constructors

	Name	Description
	CodeParameterDeclarationExpression()	Initializes a new instance of the CodeParameterDeclarationExpression class.
	CodeParameterDeclarationExpression(CodeTypeReference^, String^)	Initializes a new instance of the CodeParameterDeclarationExpression class using the specified parameter type and name.
	CodeParameterDeclarationExpression(String^, String^)	Initializes a new instance of the CodeParameterDeclarationExpression class using the specified parameter type and name.
	CodeParameterDeclarationExpression(Type^, String^)	Initializes a new instance of the CodeParameterDeclarationExpression class using the specified parameter type and name.

Properties

	Name	Description
	CustomAttributes	Gets or sets the custom attributes for the parameter declaration.
	Direction	Gets or sets the direction of the field.
	Name	Gets or sets the name of the parameter.
	Type	Gets or sets the type of the parameter.
	UserData	Gets the user-definable data for the current object.(Inherited from CodeObject.)

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

Remarks

CodeParameterDeclarationExpression can be used to represent code that declares a parameter for a method, property, or constructor.

The Name property specifies the name of the parameter. The Type property specifies the data type of the parameter. The Direction property specifies the direction modifier of the parameter. The CustomAttributes property specifies the attributes associated with the parameter.

Examples

The following example demonstrates use of CodeParameterDeclarationExpression to declare parameters of a method using different FieldDirection field reference type specifiers.

C++

// Declares a method.
CodeMemberMethod^ method1 = gcnew CodeMemberMethod;
method1->Name = "TestMethod";

// Declares a string parameter passed by reference.
CodeParameterDeclarationExpression^ param1 = gcnew CodeParameterDeclarationExpression( "System.String","stringParam" );
param1->Direction = FieldDirection::Ref;
method1->Parameters->Add( param1 );

// Declares a Int32 parameter passed by incoming field.
CodeParameterDeclarationExpression^ param2 = gcnew CodeParameterDeclarationExpression( "System.Int32","intParam" );
param2->Direction = FieldDirection::Out;
method1->Parameters->Add( param2 );

// A C# code generator produces the following source code for the preceeding example code:
//        private void TestMethod(ref string stringParam, out int intParam) {
//        }

Version Information

.NET Framework
Available since 1.1

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.