ValueToTextConverter Property

Specifies the converter used for converting between text and value.

Syntax

Visual Basic

'Declaration
 
Public Property ValueToTextConverter As IValueConverter

C#

public IValueConverter ValueToTextConverter {get; set;}

Remarks

The conversions between the 'string' and the ValueType by default are done using built in conversion logic. You can override the conversion logic by setting the ValueToDisplayTextConverter and ValueToTextConverter. ValueToTextConverter is used when the editor is in edit mode where as ValueToDisplayTextConverter is used when the editor is not in edit mode.

Note: An editor can edit values of types other than 'string'. For example, a XamTextEditor can edit values of types DateTime. You can specify the type of values being edited by the editor using the Infragistics.Windows.Editors.ValueEditor.ValueType property.

Although the built-in default conversion logic should be sufficient for most situations, you may want make use of this functionality to provide custom logic for converting user input into value type object. Examples where this would be needed are if you are editing custom objects where the built-in conversion logic would not know how to convert text into custom object type. Or you want to support entering certain symbols in the text that signify certain aspect of the value - for example you want 'k' in '2k' to be interpreted as 1000 magnitude, or +1d to be interpreted as tomorrow's date when editing DateTime.

Note that not all derived editors support or utilize ValueToTextConverter. Editors where value to text conversions are performed intrinsically, such as Infragistics.Windows.Editors.XamComboEditor where both the value and text are retrieved from the selected item, do not support ValueToTextConverter.

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