Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

Type.GetProperty Method (String, Type, Type[], ParameterModifier[])

.NET Framework 1.1

Searches for the specified public property whose parameters match the specified argument types and modifiers.

[Visual Basic]
Overloads Public Function GetProperty( _
   ByVal name As String, _
   ByVal returnType As Type, _
   ByVal types() As Type, _
   ByVal modifiers() As ParameterModifier _
) As PropertyInfo
[C#]
public PropertyInfo GetProperty(
 string name,
 Type returnType,
 Type[] types,
 ParameterModifier[] modifiers
);
[C++]
public: PropertyInfo* GetProperty(
 String* name,
 Type* returnType,
 Type* types[],
 ParameterModifier modifiers[]
);
[JScript]
public function GetProperty(
   name : String,
 returnType : Type,
 types : Type[],
 modifiers : ParameterModifier[]
) : PropertyInfo;

Parameters

name
The String containing the name of the public property to get.
returnType
The return type of the property.
types
An array of Type objects representing the number, order, and type of the parameters for the indexed property to get.

-or-

An empty array of the type Type (that is, Type[] types = new Type[0]) to get a property that is not indexed.

modifiers
An array of ParameterModifier objects representing the attributes associated with the corresponding element in the types array. The default binder does not process this parameter.

Return Value

A PropertyInfo object representing the public property that matches the specified requirements, if found; otherwise, a null reference (Nothing in Visual Basic).

Exceptions

Exception Type Condition
AmbiguousMatchException More than one property is found with the specified name and matching the specified argument types and modifiers.
ArgumentNullException name is a null reference (Nothing in Visual Basic).

-or-

types is a null reference (Nothing).

-or-

One of the elements in types is a null reference (Nothing).

ArgumentException types is multidimensional.

-or-

modifiers is multidimensional.

-or-

types and modifiers do not have the same length.

Remarks

Although the default binder does not process ParameterModifier (the modifiers parameter), you can use the abstract System.Reflection.Binder class to write a custom binder that does process modifiers. ParameterModifier is only used when calling through COM interop, and only parameters that are passed by reference are handled.

The types array and the modifiers array have the same length. A parameter specified in the types array can have the following attributes, which are specified in the modifiers array: pdIn, pdOut, pdLcid, pdRetval, pdOptional, and pdHasDefault, which represent [In], [Out], [lcid], [retval], [optional], and a value specifying whether the parameter has a default value. A parameter's associated attributes are stored in the metadata and enhance interoperability.

The search for name is case-sensitive.

If the requested type is non-public and the caller does not have ReflectionPermission to reflect non-public objects outside the current assembly, this method returns a null reference (Nothing in Visual Basic).

Example

[Visual Basic, C#, C++] The following example obtains a Type object corresponding to MyPropertyClass, and the indexed property of this class is retrieved using the arguments passed to the GetProperty method.

[Visual Basic] 
Imports System
Imports System.Reflection

Public Class MyPropertyClass
    Private myPropertyArray(9, 9) As Integer
    ' Declare an indexer.
    Default Public Property Item(ByVal i As Integer, ByVal j As Integer) As Integer
        Get
            Return myPropertyArray(i, j)
        End Get
        Set(ByVal Value As Integer)
            myPropertyArray(i, j) = Value
        End Set
    End Property
End Class 'MyPropertyClass

Public Class MyTypeClass
    Public Shared Sub Main()
        Try
            Dim myType As Type = GetType(MyPropertyClass)
            Dim myTypeArray(1) As Type
            ' Create an instance of a Type array representing the number, order 
            ' and type of the parameters for the property.
            myTypeArray.SetValue(GetType(Integer), 0)
            myTypeArray.SetValue(GetType(Integer), 1)
            ' Search for the indexed property whose parameters match the
            ' specified argument types and modifiers.
            Dim myPropertyInfo As PropertyInfo = myType.GetProperty("Item", _
                  GetType(Integer), myTypeArray, Nothing)
            Console.WriteLine(myType.FullName + "." + myPropertyInfo.Name + _
                  " has a property  type of " + myPropertyInfo.PropertyType.ToString())
        Catch ex As Exception
            Console.WriteLine("An exception occurred " + ex.Message.ToString())
        End Try
    End Sub 'Main
End Class 'MyTypeClass

[C#] 
using System;
using System.Reflection;
public class MyPropertyClass
{
    private int [,] myPropertyArray = new int[10,10]; 
    // Declare an indexer.
    public int this [int i,int j]
    {
        get 
        {
            return myPropertyArray[i,j];
        }
        set 
        {
            myPropertyArray[i,j] = value;
        }
    }
}
public class MyTypeClass
{
    public static void Main()
    {
        try
        {
            Type myType=typeof(MyPropertyClass);
            Type[] myTypeArray = new Type[2];
            // Create an instance of the Type array representing the number, order 
            // and type of the parameters for the property.
            myTypeArray.SetValue(typeof(int),0);
            myTypeArray.SetValue(typeof(int),1);
            // Search for the indexed property whose parameters match the
            // specified argument types and modifiers.
            PropertyInfo myPropertyInfo = myType.GetProperty("Item",
                typeof(int),myTypeArray,null);
            Console.WriteLine(myType.FullName + "." + myPropertyInfo.Name + 
                " has a property type of " + myPropertyInfo.PropertyType);
         }
        catch(Exception ex)
        {
            Console.WriteLine("An exception occurred " + ex.Message);
        }
    }
}

[C++] 
#using <mscorlib.dll>

using namespace System;
using namespace System::Reflection;
public __gc class MyPropertyClass {
private:
   int myPropertyArray[,];
   // Declare an indexer.
public:
   __property int get_Item(int i, int j) {
      return myPropertyArray[i, j];

   }
   __property void set_Item(int i, int j, int value) {

      myPropertyArray[i, j] = value;
   }

};

int main() {
   try {
      Type* myType=__typeof(MyPropertyClass);
      Type* myTypeArray[] = new Type*[2];
      // Create an instance of the Type array representing the number, order
      // and type of the parameters for the property.
      myTypeArray->SetValue(__typeof(int), 0);
      myTypeArray->SetValue(__typeof(int), 1);
      // Search for the indexed property whose parameters match the
      // specified argument types and modifiers.
      PropertyInfo*  myPropertyInfo = myType->GetProperty(S"Item",
         __typeof(int), myTypeArray, 0);
      Console::WriteLine(S"{0}.{1} has a property type of {2}", myType->FullName,
         myPropertyInfo->Name, myPropertyInfo->PropertyType);
   } catch (Exception* ex) {
      Console::WriteLine(S"An exception occurred {0}", ex->Message);
   }
}

[JScript] No example is available for JScript. To view a Visual Basic, C#, or C++ example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, .NET Compact Framework

See Also

Type Class | Type Members | System Namespace | Type.GetProperty Overload List | PropertyInfo | String | DefaultBinder | ParameterModifier | ReflectionPermission | GetPropertyImpl | GetProperties

Show:
© 2014 Microsoft. All rights reserved.