Information
The topic you requested is included in another documentation set. For convenience, it's displayed below. Choose Switch to see the topic in its original location.

Type.GetProperty Method (String, Type[])

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

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

public PropertyInfo GetProperty (
	string name,
	Type[] types
)
public final PropertyInfo GetProperty (
	String name, 
	Type[] types
)
public final function GetProperty (
	name : String, 
	types : Type[]
) : PropertyInfo
Not applicable.

Parameters

name

The String containing the name of the public property to get.

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.

Return Value

A PropertyInfo object representing the public property whose parameters match the specified argument types, if found; otherwise, a null reference (Nothing in Visual Basic).

Exception typeCondition

AmbiguousMatchException

More than one property is found with the specified name and matching the specified argument types.

ArgumentNullException

name is a null reference (Nothing in Visual Basic).

-or-

types is a null reference (Nothing in Visual Basic).

ArgumentException

types is multidimensional.

NullReferenceException

An element of types is a null reference (Nothing in Visual Basic).

A property is considered public to reflection if it has at least one accessor that is public. Otherwise the property is considered private, and you must use BindingFlags.NonPublic | BindingFlags.Instance | BindingFlags.Static (in Visual Basic, combine the values using Or) to get it.

The search for name is case-sensitive. The search includes public static and public instance properties.

If the requested property 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).

If the current Type represents a constructed generic type, this method returns the PropertyInfo with the type parameters replaced by the appropriate type arguments.

If the current Type represents a type parameter in the definition of a generic type or generic method, this method searches the properties of the class constraint.

Indexers and Default Properties

Visual Basic 2005, Visual C# 2005, and Visual C++ 2005 have simplified syntax for accessing indexed properties and allow one indexed property to be a default for its type. For example, if the variable myList refers to an ArrayList, the syntax myList[3] (myList(3) in Visual Basic) retrieves the element with the index of 3. You can overload the property.

In C#, this feature is called an indexer and cannot be refered to by name. By default, a C# indexer appears in metadata as an indexed property named "Item". However, a class library developer can use the IndexerNameAttribute attribute to change the name of the indexer in the metadata. For example, the String class has an indexer named Chars. Indexed properties created using languages other than C# can have names other than Item, as well. 

To determine whether a type has a default property, use the GetCustomAttributes method to test for the DefaultMemberAttribute attribute. If the type has DefaultMemberAttribute, the MemberName property returns the name of the default property.

The following example retrieves the Type object of a user-defined class, retrieves the property of that class, and displays the property name and type of the property as specified by the arguments passed to GetProperty.


using System;
using System.Reflection;
class MyClass1
{         
    private int [,] myArray = {{1,2},{3,4}}; 
    // Declare an indexer.
    public int this [int i,int j]   
    {
        get 
        {
            return myArray[i,j];
        }
        set 
        {
            myArray[i,j] = value;
        }
    }
}
public class MyTypeClass
{
    public static void Main(string[] args)
    {
        try
        { 
            // Get the Type object.
            Type myType=typeof(MyClass1);       
            Type[] myTypeArr = new Type[2];
            // Create an instance of a Type array.
            myTypeArr.SetValue(typeof(int),0);            
            myTypeArr.SetValue(typeof(int),1);
            // Get the PropertyInfo object for the indexed property Item, which has two integer parameters. 
            PropertyInfo myPropInfo = myType.GetProperty("Item", myTypeArr);
            // Display the property.
            Console.WriteLine("The {0} property exists in MyClass1.", myPropInfo.ToString());
        }           
        catch(NullReferenceException e)
        {
            Console.WriteLine("An exception occurred.");
            Console.WriteLine("Source : {0}" , e.Source);
            Console.WriteLine("Message : {0}" , e.Message);
        }
    }
}

import System.*;
import System.Reflection.*;

class MyClass1
{
    private int myArray[,] =  {{1, 2}, {3, 4}};
    // Declare an indexer.
    /** @property 
     */
    public int get_Item(int i, int j)
    {
        return myArray[i, j];
    } //Item

    /** @property 
     */
    public void set_Item(int i, int j, int value)
    {
        myArray[i, j] = value;
    } //Item
} //MyClass1

public class MyTypeClass
{
    public static void main(String[] args)
    {
        try {
            // Get the Type object.
            Type myType = MyClass1.class.ToType();
            Type myTypeArr[] = new Type[2];
            // Create an instance of a Type array.
            myTypeArr.SetValue(int.class.ToType(), 0);
            myTypeArr.SetValue(int.class.ToType(), 1);
            // Get the PropertyInfo object for the indexed property Item,
            // which has two integer parameters. 
            PropertyInfo myPropInfo = myType.GetProperty("Item", myTypeArr);
            // Display the property.
            Console.WriteLine("The {0} property exists in MyClass1.",
                myPropInfo.ToString());
        }
        catch (NullReferenceException e) {
            Console.WriteLine("An exception occurred.");
            Console.WriteLine("Source : {0}", e.get_Source());
            Console.WriteLine("Message : {0}", e.get_Message());
        }
    } //main
} //MyTypeClass

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

Show:
© 2014 Microsoft