RolePlayerPropertyDescriptor.GetSetFieldString Method

  • Article

Returns a localized string for the name of the set value transaction.

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

Syntax

'Declaration
Protected Overridable Function GetSetFieldString ( _
    caption As String _
) As String

protected virtual string GetSetFieldString(
    string caption
)

protected:
virtual String^ GetSetFieldString(
    String^ caption
)

abstract GetSetFieldString : 
        caption:string -> string 
override GetSetFieldString : 
        caption:string -> string 

protected function GetSetFieldString(
    caption : String
) : String

Parameters

  • caption
    Type: System.String
    The localized string that describes the value that will be set.

Return Value

Type: System.String
A localized string for the name of the set value transaction.

Exceptions

Exception Condition
ArgumentNullException

The caption parameter is nulla null reference (Nothing in Visual Basic).

Remarks

The SetValue method initiates a set value transaction for the described property.

The phrase is localized based on the culture used by the current thread. The resources included in the Visual Studio 2008 SDK only support English.

This method uses composition to generate the phrase.

.NET Framework Security

See Also

Reference

RolePlayerPropertyDescriptor Class

Microsoft.VisualStudio.Modeling.Design Namespace