ConvertValueToText メソッド

ValueToTextConverterResolved を使用して、指定した値をテキストに変換します。このメソッドは、エディターが編集モードの時にエディターの値を表示するために使用されます。

シンタックス

Visual Basic

'宣言
 
Public Function ConvertValueToText( _
   ByVal value As Object, _
   ByRef text As String, _
   ByRef error As Exception _
) As Boolean

C#

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

パラメータ

value

変換する値。

text

この出力パラメーターは、変換されたテキストに設定されます。

error

変換が失敗すると、エラーはエラーを示す値に設定されます。

戻り値の型

変換が成功すれば True、そうでなければ False。

解説

ConvertValueToText は、値をテキストに変換するために使用されます。このメソッドは一般的に （Value プロパティによって指定された） エディターの値を、エディターが編集モードに入る時にユーザーが編集できるテキストに変換するために使用されます。編集モードではない場合、TextEditorBase.ConvertValueToDisplayText メソッドが使用されてエディターに表示されるテキストに値を変換します。Text プロパティの戻り値はこのメソッドが変換するテキストに対応しますが、DisplayText プロパティの戻り値は、ConvertValueToDisplayText メソッドが変換するテキストに対応します。

注：DisplayText および ConvertValueToDisplayText メソッドは、TextEditorBase クラスに定義されます。このため、表示テキスト変換が TextEditorBase から派生するすべてのテキスト ベースのエディターで唯一適用可能です。

たとえば、XamTextEditor の ValueType プロパティが DateTime タイプに設定されて、Value プロパティが「01/01/2007」の DateTime インスタンスに設定されます。ユーザーが編集モードに入ると、このメソッドが呼び出され DateTime 値を文字列に変換します。エディターが編集モードでない場合は TextEditorBase.ConvertValueToDisplayText が使用されます。このメソッドと ConvertValueToDisplayText の違いは、ConvertValueToDisplayText が FormatProvider および Format プロパティ設定を考慮するのに対して、ConvertValueToText は考慮しない点です。

注： 一般的にこのメソッドを直接呼び出す必要はありません。このメソッドは、テキストと値の間の必要な変換を実行するために ValueEditor 自身によって自動的に呼び出されるからです。

注: テキストと値の間の変換にデフォルト変換ロジックをオーバーライドしたい場合、ValueToTextConverter および ValueToDisplayTextConverter プロパティを設定します。