ConvertValueToDisplayText Method

Converts the specified value to display text using the ValueToDisplayTextConverterResolved. Returns true if the conversion succeeds. This method is used to display the value of the editor when the editor is not in edit mode.

Syntax

Visual Basic

'Declaration
 
Public Function ConvertValueToDisplayText( _
   ByVal value As Object, _
   ByRef text As String, _
   ByRef error As Exception _
) As Boolean

C#

public bool ConvertValueToDisplayText( 
   object value,
   out string text,
   out Exception error
)

Parameters

value

The value to convert.

text

This will be set to the converted text.

error

If conversion fails, error is set to a value that indicates the error.

Return Value

True if success, false otherwise.

Remarks

See remarks section of ValueEditor.ConvertValueToText method for more information.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2