Type.GetProperty Method (String, Type)

Searches for the public property with the specified name and return type.

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

Public Function GetProperty ( _
	name As String, _
	returnType As Type _
) As PropertyInfo
Dim instance As Type
Dim name As String
Dim returnType As Type
Dim returnValue As PropertyInfo

returnValue = instance.GetProperty(name, returnType)
public final PropertyInfo GetProperty (
	String name, 
	Type returnType
public final function GetProperty (
	name : String, 
	returnType : Type
) : PropertyInfo
Not applicable.



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


The return type of the property.

Return Value

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

Exception typeCondition


More than one property is found with the specified name.


name 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 defines a class with one property and retrieves the name and type of the property.

Imports System
Imports System.Reflection
Class MyClass1
    Private myMessage As [String] = "Hello World."
    Public Property MyProperty1() As String
            Return myMessage
        End Get
        Set(ByVal Value As String)
            myMessage = Value
        End Set
    End Property
End Class 'MyClass1

Class TestClass
    Shared Sub Main()
            Dim myType As Type = GetType(MyClass1)
            ' Get the PropertyInfo object representing MyProperty1. 
            Dim myStringProperties1 As PropertyInfo = myType.GetProperty("MyProperty1", GetType(String))
            Console.WriteLine("The name of the first property of MyClass1 is {0}.", myStringProperties1.Name)
            Console.WriteLine("The type of the first property of MyClass1 is {0}.", myStringProperties1.PropertyType.ToString())
        Catch e As ArgumentNullException
            Console.WriteLine("ArgumentNullException :" + e.Message.ToString())
        Catch e As AmbiguousMatchException
            Console.WriteLine("AmbiguousMatchException :" + e.Message.ToString())
        Catch e As NullReferenceException
            Console.WriteLine("Source : {0}", e.Source.ToString())
            Console.WriteLine("Message : {0}", e.Message.ToString())
        End Try
    End Sub 'Main
End Class 'TestClass

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

class MyClass1
    private String myMessage = "Hello World.";

    /** @property 
    public String get_MyProperty1()
        return myMessage;
    } //MyProperty1

    /** @property 
    public void set_MyProperty1(String value)
        myMessage = value;
    } //MyProperty1
} //MyClass1

class TestClass
    public static void main(String[] args)
        try {
            Type myType = MyClass1.class.ToType();
            // Get the PropertyInfo object representing MyProperty1. 
            PropertyInfo myStringProperties1 = myType.GetProperty("MyProperty1",
            Console.WriteLine("The name of the first property of MyClass1" 
                + " is {0}.", myStringProperties1.get_Name());
            Console.WriteLine("The type of the first property of MyClass1" 
                + " is {0}.", myStringProperties1.GetType());
        catch (ArgumentNullException e) {
            Console.WriteLine("ArgumentNullException :" + e.get_Message());
        catch (AmbiguousMatchException e) {
            Console.WriteLine("AmbiguousMatchException :" + e.get_Message());
        catch (NullReferenceException e) {
            Console.WriteLine("Source : {0}", e.get_Source());
            Console.WriteLine("Message : {0}", e.get_Message());
    } //main
} //TestClass

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

.NET Compact Framework

Supported in: 2.0, 1.0

XNA Framework

Supported in: 1.0