ElementTypeDescriptor.GetPropertyDescriptorDisplayName Method

Article
04/26/2013

Returns a localized string for the display name of a domain property.

Namespace: Microsoft.VisualStudio.Modeling.Design
Assembly: Microsoft.VisualStudio.Modeling.Sdk.11.0 (in Microsoft.VisualStudio.Modeling.Sdk.11.0.dll)

Syntax

'Declaration
Protected Friend Overridable Function GetPropertyDescriptorDisplayName ( _
    propertyDescriptor As ElementPropertyDescriptor _
) As String

protected internal virtual string GetPropertyDescriptorDisplayName(
    ElementPropertyDescriptor propertyDescriptor
)

protected public:
virtual String^ GetPropertyDescriptorDisplayName(
    ElementPropertyDescriptor^ propertyDescriptor
)

abstract GetPropertyDescriptorDisplayName : 
        propertyDescriptor:ElementPropertyDescriptor -> string  
override GetPropertyDescriptorDisplayName : 
        propertyDescriptor:ElementPropertyDescriptor -> string

function GetPropertyDescriptorDisplayName(
    propertyDescriptor : ElementPropertyDescriptor
) : String

Parameters

propertyDescriptor
Type: Microsoft.VisualStudio.Modeling.Design.ElementPropertyDescriptor

The descriptor for the domain property for which to get the display name.

Return Value

Type: String
A localized string for the display name of the domain property.

Exceptions

Exception	Condition
ArgumentNullException	propertyDescriptor is nulla null reference (Nothing in Visual Basic).

Remarks

When an owner is specified when a domain property descriptor is created, then the DisplayName property of the property descriptor calls the GetPropertyDescriptorDisplayName method of the owner, and provides itself as the propertyDescriptor parameter. In a derived class, this can provide a central place to set the display names for all the properties of the element.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via