ColumnBase.FieldName Property

Gets the name of the database field assigned to this column. This is a dependency property.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v18.2.Core.dll

Declaration

C#

[DefaultValue("")]
public virtual string FieldName { get; set; }

VB.NET

<DefaultValue("")>
Public Overridable Property FieldName As String

Property Value

Type	Default	Description
String	String.Empty	A String value that specifies the name of a data field.

Remarks

The FieldName or ColumnBase.Binding (that also sets FieldName internally) properties must be defined for every GridControl column.

Note

When working with data structures that contain Dynamic Objects, use the ColumnBase.Binding property instead of FieldName.

Important

Do not bind multiple columns to the same field in the data base. Only a single column can be bound to a specific field in the database. If you need to create another column bound to the same field, create a new unbound column, and set its FieldName property to a unique string. Then, handle the GridControl.CustomUnboundColumnData event to populate this column with the same data as the first column.

To learn more, see Creating Columns and Binding Them to Data Properties and Binding Columns to Data Source Fields.

Example

This example shows how to add an unbound column to the DXGrid control. This column should display the total price, calculated as follows: UnitPrice * UnitsOnOrder.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-create-unbound-columns-e1503.

Window1.xaml

<Window x:Class="DXGrid_UnboundColumns.Window1"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid"
        xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors"
        Title="Window1"
        Height="300"
        Width="552">
    <Grid>
        <dxg:GridControl x:Name="grid" CustomUnboundColumnData="grid_CustomUnboundColumnData">
            <dxg:GridControl.Columns>
                <dxg:GridColumn FieldName="ProductName" />
                <dxg:GridColumn FieldName="UnitPrice">
                    <dxg:GridColumn.EditSettings>
                        <dxe:TextEditSettings DisplayFormat="c2" />
                    </dxg:GridColumn.EditSettings>
                </dxg:GridColumn>
                <dxg:GridColumn FieldName="UnitsOnOrder" />
                <dxg:GridColumn FieldName="Total" UnboundType="Boolean" ReadOnly="True">
                    <dxg:GridColumn.EditSettings>
                        <dxe:TextEditSettings DisplayFormat="c2" />
                    </dxg:GridColumn.EditSettings>
                </dxg:GridColumn>
            </dxg:GridControl.Columns>
            <dxg:GridControl.View>
                <dxg:TableView AutoWidth="True"/>
            </dxg:GridControl.View>
        </dxg:GridControl>
    </Grid>
</Window>

Window1.xaml.vb

Imports System
Imports System.Windows
Imports DevExpress.Xpf.Grid

Namespace DXGrid_UnboundColumns
    Partial Public Class Window1
        Inherits Window

        Public Sub New()
            InitializeComponent()
            grid.ItemsSource = (New dsProductsTableAdapters.ProductsTableAdapter()).GetData()
        End Sub

        Private Sub grid_CustomUnboundColumnData(ByVal sender As Object, ByVal e As GridColumnDataEventArgs)
            If e.IsGetData Then
                Dim price As Integer = Convert.ToInt32(e.GetListSourceFieldValue("UnitPrice"))
                Dim unitsOnOrder As Integer = Convert.ToInt32(e.GetListSourceFieldValue("UnitsOnOrder"))
                e.Value = price * unitsOnOrder
            End If
        End Sub
    End Class


End Namespace

Application.xaml

<Application x:Class="DXGrid_UnboundColumns.App" xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" StartupUri="Window1.xaml">
    <Application.Resources>

    </Application.Resources>
</Application>

Application.xaml.vb

Imports System.Windows

Namespace DXGrid_UnboundColumns
    ''' <summary>
    ''' Interaction logic for App.xaml
    ''' </summary>
    Partial Public Class App
        Inherits Application

    End Class
End Namespace

Window1.xaml.cs

using System;
using System.Windows;
using DevExpress.Xpf.Grid;

namespace DXGrid_UnboundColumns {
    public partial class Window1 : Window {
        public Window1() {
            InitializeComponent();
            grid.ItemsSource = new dsProductsTableAdapters.ProductsTableAdapter().GetData();
        }

        private void grid_CustomUnboundColumnData(object sender, GridColumnDataEventArgs e) {
            if (e.IsGetData) {
                int price = Convert.ToInt32(e.GetListSourceFieldValue("UnitPrice"));
                int unitsOnOrder = Convert.ToInt32(e.GetListSourceFieldValue("UnitsOnOrder"));
                e.Value = price * unitsOnOrder;
            }
        }
    }


}

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the FieldName 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#

how-to-show-the-appointments-search-result-in-searchresult-view-for-schedulercontrol-simil-t278605/CS/SearchResultViewDemo/SearchResultView.xaml#L17

<dxg:GridControl.Columns>
    <dxg:GridColumn FieldName="Subject"/>
    <dxg:GridColumn FieldName="Start">

how-to-convert-and-then-print-gridcontrol-by-using-xtrareport-e4658/CS/DXGridSample/Window17.xaml#L15

<dxg:GridControl.Columns>
    <dxg:GridColumn FieldName="MyBoolUnb" UnboundType="Object" Name="gridColumn111"/>
    <dxg:GridColumn FieldName="MyBool" AllowSorting="False"  Name="gridColumn1"/>

how-to-implement-crud-operations-using-dxgrid-with-entity-framework-instant-feedback-e3759/CS/MainWindow.xaml#L57

<dxg:GridControl.Columns>
    <dxg:GridColumn Name="colCustomerID" FieldName="CustomerID" Width="70" />
    <dxg:GridColumn Name="colCompany" FieldName="CompanyName" />

how-to-merge-band-and-column-headers-t417753/CS/DXSample/MainWindow.xaml#L27

<dxg:GridControlBand.Columns>
    <dxg:GridColumn FieldName="FullName"/>
</dxg:GridControlBand.Columns>

how-to-bind-to-custom-service-with-restrictions/CS/MainWindow.xaml#L18

<dxg:GridControl.Columns>
    <dxg:GridColumn x:Name="hotColumn" FieldName="Hot" Visible="False" ShowInColumnChooser="False" AllowSorting="True" AllowedSortOrders="Descending" SortOrder="Descending"/>
    <dxg:GridColumn x:Name="weekColumn" FieldName="Week" Visible="False" ShowInColumnChooser="False" AllowSorting="True" AllowedSortOrders="Descending" />

VB.NET

how-to-change-background-color-for-modified-cells-e1297/VB/HighlightChangedCellBehavior.vb#L48

If Not IsServiceColumn(e.Column) Then
    Dim fieldName = $"{UnboundColumnPrefix}{e.Column.FieldName}"
    Dim key = Tuple.Create(e.Row, fieldName)

how-to-convert-and-then-print-gridcontrol-by-using-xtrareport-e4658/VB/DXGridSample/ReportHelper.vb#L51

label.SizeF = DirectCast(detailsInfo(col), XRTableCell).SizeF
label.DataBindings.Add("Text", Nothing, col.FieldName)
label.Summary = New XRSummary() With {.Running = SummaryRunning.Report}

how-to-filter-a-lookupedit-in-one-column-based-on-the-value-of-another-column-e3826/VB/MainWindow.xaml.vb#L54

Private Sub OnTableViewShownEditor(ByVal sender As Object, ByVal e As EditorEventArgs)
    If e.Column.FieldName <> "CityId" Then
        Return

how-to-extend-vertical-lines-to-the-bottom-and-color-even-odd-rows-e2601/VB/WpfApplication21/MainWindow.xaml.vb#L41

grid.TotalSummary.Add(New GridSummaryItem() With {.FieldName = column.FieldName, .SummaryType = SummaryItemType.Sum, .ShowInColumn = column.FieldName})

how-to-display-custom-text-within-data-cells-and-groups-t327301/VB/DXSample/MainWindow.xaml.vb#L14

Private Sub GridControl_CustomColumnDisplayText(ByVal sender As Object, ByVal e As DevExpress.Xpf.Grid.CustomColumnDisplayTextEventArgs)
    If e.Column.FieldName = "AccessLevel" Then
        Select Case CInt((e.Value))