Export (0) Print
Expand All

Type.GetProperty Method (String, Type)

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

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

'Declaration
Public Function GetProperty ( _
	name As String, _
	returnType As Type _
) As PropertyInfo

Parameters

name
Type: System.String

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

returnType
Type: System.Type

The return type of the property.

Return Value

Type: System.Reflection.PropertyInfo
An object representing the public property with the specified name, if found; otherwise, Nothing.

Implements

_Type.GetProperty(String, Type)

ExceptionCondition
AmbiguousMatchException

More than one property is found with the specified name.

ArgumentNullException

name is Nothing, or returnType is Nothing.

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 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(Type, Boolean) 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 
        Get 
            Return myMessage
        End Get 
        Set(ByVal Value As String)
            myMessage = Value
        End Set 
    End Property 
End Class 'MyClass1

Class TestClass
    Shared Sub Main()
        Try 
            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 
	'Output: 
	'The name of the first property of MyClass1 is MyProperty1. 
	'The type of the first property of MyClass1 is System.String. 

    End Sub 'Main
End Class 'TestClass

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

.NET for Windows Phone apps

Supported in: Windows Phone 8.1, Windows Phone 8, Silverlight 8.1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft