BaseEditSettings.DisplayTextConverter Property

Gets or sets a converter for the editor’s display value. This is a dependency property.

Namespace: DevExpress.Xpf.Editors.Settings

Assembly: DevExpress.Xpf.Core.v24.2.dll

NuGet Package: DevExpress.Wpf.Core

Declaration

C#

public IValueConverter DisplayTextConverter { get; set; }

VB.NET

Public Property DisplayTextConverter As IValueConverter

Property Value

Type	Description
IValueConverter	An object that implements the IValueConverter interface.

Property Paths

You can access this nested property as listed below:

Object Type	Path to DisplayTextConverter
BarEditItem	.EditSettings .DisplayTextConverter
FilterField	.EditSettings .DisplayTextConverter
ColumnBase	.ActualEditSettings .DisplayTextConverter
ColumnBase	.EditSettings .DisplayTextConverter
TreeViewControl	.EditSettings .DisplayTextConverter
PropertyDefinition	.EditSettings .DisplayTextConverter
SpreadsheetCustomCellEditEventArgs	.EditSettings .DisplayTextConverter

Remarks

The editor displays formatted text if the editor value is not being edited (for example, if the editor is not focused or it is read-only). You can use DevExpress Converters or create a custom converter (that implements the IValueConverter interface) to format displayed text.

The following code sample uses the DisplayTextConverter property to allow users to search and filter grid data by display values of a checked column:

XAML

<dxg:GridColumn FieldName="IsChecked">
    <dxg:GridColumn.EditSettings>
        <!--Use TextEditSettings if you want to also display your custom text in cells-->
        <dxe:CheckEditSettings DisplayTextConverter="{dxmvvm:BooleanToObjectConverter TrueValue=Yes, FalseValue=No}"/>
    </dxg:GridColumn.EditSettings>
</dxg:GridColumn>

Refer to the following help topic for more information: Format Cell Values - DisplayTextConverter.