GridSummaryItem.FieldName Property

Gets or sets the name of a dataset field whose values are used for summary calculation.

Namespace: DevExpress.XtraGrid

Assembly: DevExpress.XtraGrid.v24.2.dll

Declaration

C#

[XtraSerializableProperty(1)]
[DXCategory("Data")]
public virtual string FieldName { get; set; }

VB.NET

<XtraSerializableProperty(1)>
<DXCategory("Data")>
Public Overridable Property FieldName As String

Property Value

Type	Description
String	A string value specifying the name of a data field whose values are used for summary calculation.

Remarks

If the GridSummaryItem.SummaryType property value is SummaryItemType.Count, you can leave the FieldName property set to an empty string (or set to any other value). If the GridSummaryItem.SummaryType property value is SummaryItemType.Custom, setting the FieldName property value is optional. If you want to use the GridView.CustomSummaryCalculate event’s CustomSummaryEventArgs.FieldValue parameter, you must initialize the FieldName property with the required field name. If you don’t want to use the this parameter, the FieldName property can be set to any value.

If the GridSummaryItem.SummaryType property is set to SummaryItemType.Min, SummaryItemType.Max, SummaryItemType.Sum or SummaryItemType.Average, the FieldName property must specify the name of a field bound to the column whose values must be used when calculating. Otherwise, no summary will be calculated.

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#

winforms-grid-hide-group-footer-for-specific-level/CS/HideableGroupRowFooters/Form1.cs#L59

GridGroupSummaryItem item = new GridGroupSummaryItem();
item.FieldName = "Model";
item.SummaryType = DevExpress.Data.SummaryItemType.Count;

winforms-grid-print-group-summary-under-columns/CS/Q250602/MyGridControl.cs#L97

        if (item.ShowInGroupColumnFooter == null && string.IsNullOrEmpty(item.ShowInGroupColumnFooterName))
            printSummaryInfo.Add(item.FieldName, item);
}

winforms-grid-show-multiple-group-summaries-in-group-footer-cell/CS/MultiGroupSummary/MyGridControl/MyGridView.cs#L88

if (summaryItem != null) {
    fieldName = summaryItem.FieldName;
    showInGroupColumnFooter = summaryItem.ShowInGroupColumnFooter;

xaf-how-to-extend-the-application-model/CS/ExtendModel.Module.Win/Controllers/WinGroupFooterViewController.cs#L19

IModelColumnExtender modelColumn = View.Model.Columns[
    gridView.GroupSummary[i].FieldName] as IModelColumnExtender;
if (modelColumn != null) {

VB.NET

winforms-grid-hide-group-footer-for-specific-level/VB/HideableGroupRowFooters/Form1.vb#L53

Dim item As New GridGroupSummaryItem()
item.FieldName = "Model"
item.SummaryType = DevExpress.Data.SummaryItemType.Count

winforms-grid-print-group-summary-under-columns/VB/Q250602/MyGridControl.vb#L122

If item.ShowInGroupColumnFooter Is Nothing AndAlso String.IsNullOrEmpty(item.ShowInGroupColumnFooterName) Then
    printSummaryInfo.Add(item.FieldName, item)
End If

winforms-grid-show-multiple-group-summaries-in-group-footer-cell/VB/MultiGroupSummary/MyGridControl/MyGridView.vb#L87

If summaryItem IsNot Nothing Then
    fieldName = summaryItem.FieldName
    showInGroupColumnFooter = summaryItem.ShowInGroupColumnFooter

xaf-how-to-extend-the-application-model/VB/ExtendModel.Module.Win/Controllers/WinGroupFooterViewController.vb#L20

For i As Integer = 0 To gridView.GroupSummary.Count - 1
    Dim modelColumn As IModelColumnExtender = TryCast(CType(View.Model.Columns, IModelList(Of IModelColumn))(gridView.GroupSummary(i).FieldName), IModelColumnExtender)
    If modelColumn IsNot Nothing Then