XPMemberInfo.MappingField Property

Gets the column’s name in the data store which the member’s value is stored in.

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 string MappingField { get; }

VB.NET

Public ReadOnly Property MappingField As String

Property Value

Type	Description
String	A String value that specifies the column’s name in the data store which the member’s value is stored in.

Remarks

Use the MappingField property to obtain the name of the column in the data store which the member’s data is stored in.

By default, the MappingField property returns the member’s name. Use the PersistentAttribute to specify the name of a field in the data store to map to.

Example

The following example shows how to use the PersistentAliasAttribute to implement a public read-only property exposing a value of the private persistent property. The expression passed in the PersistentAliasAttribute class constructor specifies the name of the field which stores the value at runtime. The field is decorated with the PersistentAttribute whose PersistentAttribute.MapTo property holds the name of the data store column where the field’s value is stored.

C#

using DevExpress.Xpo;

// ...
[Persistent("DefaultAddress")]
private string mDefaultAddress;

[PersistentAlias(nameof(mDefaultAddress))]
public string DefaultAddress {
    get {
        return mDefaultAddress;
    }
}

VB.NET

Imports DevExpress.Xpo

' ...
<Persistent("DefaultAddress")> _
Private mDefaultAddress As String

<PersistentAlias(NameOf(mDefaultAddress))> _
Public ReadOnly Property DefaultAddress() As String
   Get
      Return mDefaultAddress
   End Get
End Property

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the MappingField property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

XPO_how-to-create-persistent-classes-mapped-to-tables-with-a-composite-primary-key-at-runtime-e4606/CS/XpoConsoleApplication/XPComplexCustomMemberInfo.cs#L46

    if (this.valueParent == null) return base.Name;
    return this.valueParent.MappingField + base.Name;
}