GroupField.FieldName Property

Specifies the name of a data field that is used as a criterion for creating a group in a report.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v19.1.dll

NuGet Packages: DevExpress.Reporting.Core, DevExpress.WindowsDesktop.Core

Declaration

C#

[DefaultValue("")]
[SRCategory(ReportStringId.CatBehavior)]
public string FieldName { get; set; }

VB.NET

<DefaultValue("")>
<SRCategory(ReportStringId.CatBehavior)>
Public Property FieldName As String

Property Value

Type	Default	Description
String	String.Empty	A String value, specifying the field name in the report data member.

Remarks

The report data source is defined by the XtraReportBase.DataSource and XtraReportBase.DataMember properties.

When the report data source is not defined at design time, you can specify a static value for the FieldName property of a GroupField.

Example

The report created in this example is bound to the CategoryProducts view of the sample Northwind database (the nwind.mdb file located in the directory, where you installed DevExpress demos).

This report contains two bands: DetailBand and GroupHeaderBand, and the Group Header band groups data by the “CategoryName” data field.

At runtime, data grouping can only be done prior to a report document is being created. To group data just before a report is printed/previewed, use the XRControl.BeforePrint event.

Please make sure to include all necessary assemblies to the References list of your project.

C#

using System;
using System.Windows.Forms;
using DevExpress.XtraReports.UI;
using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Sql;
using DevExpress.XtraReports.Configuration;
// ...

public XtraReport CreateDataGroupingReport() {
    // Create a report.
    XtraReport report = new XtraReport();

    // Create a data source with the required connection parameters.  
    Access97ConnectionParameters connectionParameters =
        new Access97ConnectionParameters("../../nwind.mdb", "", "");
    SqlDataSource ds = new SqlDataSource(connectionParameters);   
    CustomSqlQuery query = new CustomSqlQuery();
    query.Name = "customQuery";
    query.Sql = "SELECT * FROM CategoryProducts";
    ds.Queries.Add(query);
    ds.RebuildResultSchema();

    // Assign the data source to the report.
    report.DataSource = ds;
    report.DataMember = "customQuery";

    // Create a detail band and add it to the report.
    DetailBand detail = new DetailBand { HeightF = 40 };
    report.Bands.Add(detail);

    // Create a group header band and add it to the report.
    GroupHeaderBand ghBand = new GroupHeaderBand { HeightF = 40 };
    report.Bands.Add(ghBand);

    // Create a group field and assign it to the group header band.
    GroupField groupField = new GroupField("CategoryName");
    ghBand.GroupFields.Add(groupField);

    // Create new labels.
    XRLabel labelGroup = new XRLabel { ForeColor = System.Drawing.Color.Blue };
    XRLabel labelDetail = new XRLabel { LocationF = new System.Drawing.PointF(30, 0) };

    // Specify labels' bindings depending on the report's data binding mode.
    if (Settings.Default.UserDesignerOptions.DataBindingMode == DataBindingMode.Bindings) {
        labelGroup.DataBindings.Add("Text", null, "customQuery.CategoryName");
        labelDetail.DataBindings.Add("Text", null, "customQuery.ProductName");
    } else {
        labelGroup.ExpressionBindings.Add(new ExpressionBinding("BeforePrint", "Text", "[CategoryName]"));
        labelDetail.ExpressionBindings.Add(new ExpressionBinding("BeforePrint", "Text", "[ProductName]"));
    }
    // Add these labels to the report's bands.    
    ghBand.Controls.Add(labelGroup);          
    detail.Controls.Add(labelDetail);

    return report;
}

VB.NET

Imports System
Imports System.Windows.Forms
Imports DevExpress.XtraReports.UI
Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Sql
Imports DevExpress.XtraReports.Configuration
' ...

Public Function CreateDataGroupingReport() As XtraReport
    ' Create a report.
    Dim report As XtraReport = New XtraReport()

    ' Create a data source with the required connection parameters.
    Dim connectionParameters As Access97ConnectionParameters = New Access97ConnectionParameters("../../nwind.mdb", "",
    Dim ds As SqlDataSource = New SqlDataSource(connectionParameters)
    Dim query As CustomSqlQuery = New CustomSqlQuery()
    query.Name = "customQuery"
    query.Sql = "SELECT * FROM CategoryProducts"
    ds.Queries.Add(query)
    ds.RebuildResultSchema()

    ' Assign the data source to the report.
    report.DataSource = ds
    report.DataMember = "customQuery"

    ' Create a detail band and add it to the report.
    Dim detail As DetailBand = New DetailBand With {.HeightF = 40}
    report.Bands.Add(detail)

    ' Create a group header band and add it to the report.
    Dim ghBand As GroupHeaderBand = New GroupHeaderBand With {.HeightF = 40}
    report.Bands.Add(ghBand)

    ' Create a group field and assign it to the group header band.
    Dim groupField As GroupField = New GroupField("CategoryName")
    ghBand.GroupFields.Add(groupField)

    ' Create new labels.
    Dim labelGroup As XRLabel = New XRLabel With {.ForeColor = System.Drawing.Color.Blue }
    Dim labelDetail As XRLabel = New XRLabel With {.LocationF = New System.Drawing.PointF(30, 0)}

    ' Specify label bindings depending on the report's data binding mode.
    If Settings.[Default].UserDesignerOptions.DataBindingMode = DataBindingMode.Bindings Then
        labelGroup.DataBindings.Add("Text", Nothing, "customQuery.CategoryName")
        labelDetail.DataBindings.Add("Text", Nothing, "customQuery.ProductName")
    Else
        labelGroup.ExpressionBindings.Add(New ExpressionBinding("BeforePrint", "Text", "[CategoryName]"))
        labelDetail.ExpressionBindings.Add(New ExpressionBinding("BeforePrint", "Text", "[ProductName]"))
    End If
    ' Add these labels to the report's bands.
    ghBand.Controls.Add(labelGroup)
    detail.Controls.Add(labelDetail)
    Return report
End Function

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#

Reporting_how-to-sort-report-data-in-print-preview-by-using-a-drop-down-menu-t210208/CS/dxSampleGroupSort/SortReportTableHelpers/HelpSortItem.cs#L113

foreach (GroupField field in DataBand.SortFields) {
    if (field.FieldName == FieldName) {
        fToRemove.Add(field);

Reporting_how-to-sort-a-report-in-preview-e770/CS/XtraReport1.cs#L27

GroupField grField = new GroupField();
grField.FieldName = ((XRControl)sender).Tag.ToString();
grField.SortOrder = XRColumnSortOrder.Ascending;

VB.NET

Reporting_how-to-sort-report-data-in-print-preview-by-using-a-drop-down-menu-t210208/VB/dxSampleGroupSort/SortReportTableHelpers/HelpSortItem.vb#L110

For Each field As GroupField In DataBand.SortFields
    If field.FieldName = FieldName Then
        fToRemove.Add(field)

Reporting_how-to-sort-a-report-in-preview-e770/VB/XtraReport1.vb#L29

Dim grField As New GroupField()
grField.FieldName = (CType(sender, XRControl)).Tag.ToString()
grField.SortOrder = XRColumnSortOrder.Ascending