ElementTypeDescriptor.GetDescription Method

Article
11/24/2013

Returns a localized string for the description of a domain property.

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

Syntax

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

protected internal virtual string GetDescription(
    ElementPropertyDescriptor propertyDescriptor
)

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

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

function GetDescription(
    propertyDescriptor : ElementPropertyDescriptor
) : String

Parameters

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

The descriptor for the domain property for which to get the description.

Return Value

Type: System.String
A localized string for the description 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 Description property of the property descriptor calls the GetDescription method of the owner, and provides itself as the propertyDescriptor parameter.

.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