XPMemberInfo.Converter Property

Gets the value converter.

Namespace: DevExpress.Xpo.Metadata

Assembly: DevExpress.Xpo.v24.1.dll

NuGet Packages: DevExpress.Win.PivotGrid, DevExpress.Win.TreeMap, DevExpress.Xpo

NuGet Package: DevExpress.Xpo

Declaration

C#

public ValueConverter Converter { get; }

VB.NET

Public ReadOnly Property Converter As ValueConverter

Property Value

Type	Description
ValueConverter	A ValueConverter object which represents the value converter.

Remarks

There are cases when it is necessary to modify property values prior to saving them to a data store (e.g. data protection and data compression). In this case, data prior to being stored in a data store is modified according to an encryption or compression algorithm. When data is retrieved from the data store it’s decrypted or decompressed to return it to its original form.

XPO provides a way to perform such conversions by applying the ValueConverterAttribute.

Example

The following code example demonstrates how to store your boolean data in the database using the “T” string for true and “F” for false by defining a new ValueConverter descendant. You may need this converter when using an existing database in which boolean properties are stored such form.

C#

//...       
[Size(1), ValueConverter(typeof(BooleanToStringValueConverter))]
public bool Answer {
    get { return GetPropertyValue<bool>(nameof(Answer)); }
    set { SetPropertyValue<bool>(nameof(Answer), value); }
}

//...
public class BooleanToStringValueConverter : ValueConverter {
    public override object ConvertFromStorageType(object value) {
        return Convert.ToString(value) == "T";
    }
    public override object ConvertToStorageType(object value) {
        return Convert.ToBoolean(value) ? "T" : "F";
    }
    public override System.Type StorageType {
        get { return typeof(string); }
    }
}

VB.NET

'...       
<Size(1), ValueConverter(GetType(BooleanToStringValueConverter))> _
Public Property Answer() As Boolean
    Get
        Return GetPropertyValue(Of Boolean)(NameOf(Answer))
    End Get
    Set(ByVal value As Boolean)
        SetPropertyValue(Of Boolean)(NameOf(Answer), value)
    End Set
End Property

'...
Public Class BooleanToStringValueConverter
    Inherits ValueConverter
    Public Overrides Function ConvertFromStorageType(ByVal value As Object) As Object
        Return Convert.ToString(value) = "T"
    End Function
    Public Overrides Function ConvertToStorageType(ByVal value As Object) As Object
        Return If(Convert.ToBoolean(value), "T", "F")
    End Function
    Public Overrides ReadOnly Property StorageType() As System.Type
        Get
            Return GetType(String)
        End Get
    End Property
End Class