DataValueToText(Object,EmbeddableEditorOwnerBase,Object,Boolean) Method

Converts data value to text making use of any format provider and format strings that owner may provide. If unsuccessful, returns null.

Syntax

Visual Basic

public virtual string DataValueToText( 
   object valueToConvert,
   EmbeddableEditorOwnerBase owner,
   object ownerContext,
   bool applyFormatString
)

C#

'Declaration
 
Public Overloads Overridable Function DataValueToText( _
   ByVal valueToConvert As Object, _
   ByVal owner As EmbeddableEditorOwnerBase, _
   ByVal ownerContext As Object, _
   ByVal applyFormatString As Boolean _
) As String

 

Parameters

valueToConvert

The value to be converted

owner

An object that derives from the EmbeddableEditorOwnerBase class.

ownerContext

An object that is used to get the value to render via a call to the EmbeddableEditorOwnerBase.GetValue method.

applyFormatString

Specifies whether the format string returned by the owner via the EmbeddableEditorOwnerBase.GetFormatInfo method should be used when formatting the text. The format string should not be applied to embeddable elements that are currently in edit mode.

Return Value

A string representation of the provided value.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows 7, 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