CodeParameterDeclarationExpression Class

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

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

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

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

NameDescription
System_CAPS_pubmethodCodeParameterDeclarationExpression()

Initializes a new instance of the CodeParameterDeclarationExpression class.

System_CAPS_pubmethodCodeParameterDeclarationExpression(CodeTypeReference^, String^)

Initializes a new instance of the CodeParameterDeclarationExpression class using the specified parameter type and name.

System_CAPS_pubmethodCodeParameterDeclarationExpression(String^, String^)

Initializes a new instance of the CodeParameterDeclarationExpression class using the specified parameter type and name.

System_CAPS_pubmethodCodeParameterDeclarationExpression(Type^, String^)

Initializes a new instance of the CodeParameterDeclarationExpression class using the specified parameter type and name.

NameDescription
System_CAPS_pubpropertyCustomAttributes

Gets or sets the custom attributes for the parameter declaration.

System_CAPS_pubpropertyDirection

Gets or sets the direction of the field.

System_CAPS_pubpropertyName

Gets or sets the name of the parameter.

System_CAPS_pubpropertyType

Gets or sets the type of the parameter.

System_CAPS_pubpropertyUserData

Gets the user-definable data for the current object.(Inherited from CodeObject.)

NameDescription
System_CAPS_pubmethodEquals(Object^)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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.

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

// 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) {
//        }

.NET Framework
Available since 1.1

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

Return to top
Show: