Export (0) Print
Expand All

CodeParameterDeclarationExpression Class

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

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

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

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

The CodeParameterDeclarationExpression type exposes the following members.

  NameDescription
Public methodCodeParameterDeclarationExpression()Initializes a new instance of the CodeParameterDeclarationExpression class.
Public methodCodeParameterDeclarationExpression(CodeTypeReference, String)Initializes a new instance of the CodeParameterDeclarationExpression class using the specified parameter type and name.
Public methodCodeParameterDeclarationExpression(String, String)Initializes a new instance of the CodeParameterDeclarationExpression class using the specified parameter type and name.
Public methodCodeParameterDeclarationExpression(Type, String)Initializes a new instance of the CodeParameterDeclarationExpression class using the specified parameter type and name.
Top

  NameDescription
Public propertyCustomAttributesGets or sets the custom attributes for the parameter declaration.
Public propertyDirectionGets or sets the direction of the field.
Public propertyNameGets or sets the name of the parameter.
Public propertyTypeGets or sets the type of the parameter.
Public propertyUserDataGets the user-definable data for the current object. (Inherited from CodeObject.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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 = new CodeMemberMethod();
method1.Name = "TestMethod";

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

// Declares a Int32 parameter passed by incoming field.
CodeParameterDeclarationExpression param2 = new 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

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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.

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

Community Additions

ADD
Show:
© 2014 Microsoft