XRCrossTab.DataSource Property

Specifies the Cross Tab control’s data source.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.1.dll

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

Declaration

C#

[DefaultValue(null)]
[SRCategory(ReportStringId.CatData)]
public object DataSource { get; set; }

VB.NET

<SRCategory(ReportStringId.CatData)>
<DefaultValue(Nothing)>
Public Property DataSource As Object

Property Value

Type	Default	Description
Object	null	An object that provides data to the Cross Tab control.

Remarks

Use the DataSource and DataMember properties to provide a data source to the XRCrossTab control individually.

At design time, you can access the DataSource property in the Cross Tab control’s smart tag. Expand this property’s drop-down list and click Add Report Data Source.

Follow the steps in the invoked Data Source Wizard to configure a data source. Once you complete the wizard, the DataSource and DataMember properties are set.

Note

Do not use dots in the data source name since the report engine uses them to separate the names of different data items (data source, table, relation, field, etc.)

A data source’s fields become available in the Field List. Drop these fields onto cross-tab areas to define the control layout.

The Cross Tab control supports three field areas:

• Rows (RowFields collection) - defines the row headers;

• Columns (ColumnFields collection) - defines the column headers;

• Data (DataFields collection) - defines fields against which to calculate summaries.

Note

If you place the Cross Tab control in the Detail band, ensure that a report’s DataSource property is not set. Otherwise, the Cross Tab data is printed as many times as there are rows in the report data source.

See the Provide Data to Reports documentation section for more information about data sources.

Example

The following example demonstrates how to create and configure the Cross Tab control in code.

Tip

Online Example: How to use the XRCrossTab control to create a cross-tab report

C#

using System.Drawing;
using DevExpress.DataAccess.ConnectionParameters;
using DevExpress.DataAccess.Sql;
using DevExpress.XtraPrinting;
using DevExpress.XtraReports.UI;
using DevExpress.XtraReports.UI.CrossTab;
// ...

private XtraReport CreateReport() {
    // Create a blank report.
    XtraReport crossTabReport = new XtraReport() {
        VerticalContentSplitting = VerticalContentSplitting.Smart,
        HorizontalContentSplitting = HorizontalContentSplitting.Smart
    };

    // Create the Detail band and add it to the report.
    DetailBand detail = new DetailBand();
    crossTabReport.Bands.Add(detail);

    // Create the Cross Tab control and add it to the Detail band.
    XRCrossTab crossTab = new XRCrossTab();
    detail.Controls.Add(crossTab);
    crossTab.PrintOptions.RepeatColumnHeaders = true;
    crossTab.PrintOptions.RepeatRowHeaders = true;

    // Create a data source.
    Access97ConnectionParameters connectionParameters = new Access97ConnectionParameters(@"|DataDirectory|\nwind.mdb", "", "");
    SqlDataSource ds = new SqlDataSource(connectionParameters);

    // Create an SQL query to access the SalesPerson view.
    SelectQuery query = SelectQueryFluentBuilder.AddTable("SalesPerson")
                .SelectColumn("CategoryName")
                .SelectColumn("ProductName")
                .SelectColumn("Country")
                .SelectColumn("Sales Person")
                .SelectColumn("Quantity")
                .SelectColumn("Extended Price").Build("SalesPerson");
    ds.Queries.Add(query);

    // Bind the Cross Tab control to data.
    crossTab.DataSource = ds;
    crossTab.DataMember = "SalesPerson";

    // Generate the Cross Tab's fields.
    crossTab.RowFields.Add(new CrossTabRowField() { FieldName = "CategoryName" });
    crossTab.RowFields.Add(new CrossTabRowField() { FieldName = "ProductName" });
    crossTab.ColumnFields.Add(new CrossTabColumnField() { FieldName = "Country" });
    crossTab.ColumnFields.Add(new CrossTabColumnField() { FieldName = "Sales Person" });
    crossTab.DataFields.Add(new CrossTabDataField() { FieldName = "Quantity" });
    crossTab.DataFields.Add(new CrossTabDataField() { FieldName = "Extended Price" });
    crossTab.GenerateLayout();

    // Format the cells.
    foreach(var c in crossTab.ColumnDefinitions) {
        // Enable auto-width for all columns.
        c.AutoWidthMode = DevExpress.XtraReports.UI.AutoSizeMode.GrowOnly;
    }

    foreach(XRCrossTabCell c in crossTab.Cells) {
        if(c.DataLevel == 1 && c.RowIndex != 2) {
            // Specify the format string for the "Extended Price" cells.
            c.TextFormatString = "{0:c}";
        }
    }

    // Assign styles to the Cross Tab control.
    crossTab.CrossTabStyles.GeneralStyle = new XRControlStyle() { 
        Name = "Default",
        Borders = BorderSide.All,
        Padding = new PaddingInfo() { All = 2 }                
    };
    crossTab.CrossTabStyles.DataAreaStyle = crossTab.CrossTabStyles.TotalAreaStyle = new XRControlStyle() {
        Name = "Data",
        TextAlignment = TextAlignment.TopRight
    };
    crossTab.CrossTabStyles.HeaderAreaStyle = new XRControlStyle() {
        Name = "HeaderAndTotals",
        BackColor = Color.WhiteSmoke
    };
    return crossTabReport;
}

VB.NET

Imports System.Drawing
Imports DevExpress.DataAccess.ConnectionParameters
Imports DevExpress.DataAccess.Sql
Imports DevExpress.XtraPrinting
Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.UI.CrossTab
' ...

Private Function CreateReport() As XtraReport
    ' Create a blank report.
    Dim crossTabReport As New XtraReport() With {
        .VerticalContentSplitting = VerticalContentSplitting.Smart,
        .HorizontalContentSplitting = HorizontalContentSplitting.Smart
    }

    ' Create the Detail band and add it to the report.
    Dim detail As New DetailBand()
    crossTabReport.Bands.Add(detail)

    ' Create the Cross Tab control and add it to the Detail band.
    Dim crossTab As New XRCrossTab()
    detail.Controls.Add(crossTab)
    crossTab.PrintOptions.RepeatColumnHeaders = True
    crossTab.PrintOptions.RepeatRowHeaders = True

    ' Create a data source.
    Dim connectionParameters As New Access97ConnectionParameters("|DataDirectory|\nwind.mdb", "", "")
    Dim ds As New SqlDataSource(connectionParameters)

    ' Create an SQL query to access the SalesPerson view.
    Dim query As SelectQuery = SelectQueryFluentBuilder.AddTable("SalesPerson").SelectColumn("CategoryName").SelectColumn("ProductName").SelectColumn("Country").SelectColumn("Sales Person").SelectColumn("Quantity").SelectColumn("Extended Price").Build("SalesPerson")
    ds.Queries.Add(query)

    ' Bind the Cross tab control to data.
    crossTab.DataSource = ds
    crossTab.DataMember = "SalesPerson"

    ' Generate the Cross Tab's fields.
    crossTab.RowFields.Add(New CrossTabRowField() With {.FieldName = "CategoryName"})
    crossTab.RowFields.Add(New CrossTabRowField() With {.FieldName = "ProductName"})
    crossTab.ColumnFields.Add(New CrossTabColumnField() With {.FieldName = "Country"})
    crossTab.ColumnFields.Add(New CrossTabColumnField() With {.FieldName = "Sales Person"})
    crossTab.DataFields.Add(New CrossTabDataField() With {.FieldName = "Quantity"})
    crossTab.DataFields.Add(New CrossTabDataField() With {.FieldName = "Extended Price"})
    crossTab.GenerateLayout()                      

    ' Format the cells.
    For Each c In crossTab.ColumnDefinitions
        ' Enable auto-width for all columns.
        c.AutoWidthMode = DevExpress.XtraReports.UI.AutoSizeMode.GrowOnly
    Next c

    For Each c As XRCrossTabCell In crossTab.Cells
        If c.DataLevel = 1 AndAlso c.RowIndex <> 2 Then
            ' Specify the format string for the "Extended Price" cells.
            c.TextFormatString = "{0:c}"
        End If
    Next c


    ' Assign styles to the Cross Tab control.
    crossTab.CrossTabStyles.GeneralStyle = New XRControlStyle() With {
        .Name = "Default",
        .Borders = BorderSide.All,
        .Padding = New PaddingInfo() With {.All = 2}
    }
    crossTab.CrossTabStyles.TotalAreaStyle = New XRControlStyle() With {
        .Name = "Data",
        .TextAlignment = TextAlignment.TopRight
    }
    crossTab.CrossTabStyles.DataAreaStyle = crossTab.CrossTabStyles.TotalAreaStyle
    crossTab.CrossTabStyles.HeaderAreaStyle = New XRControlStyle() With {
        .Name = "HeaderAndTotals",
        .BackColor = Color.WhiteSmoke
    }
    Return crossTabReport
End Function

Related API	Description
XRCrossTab.DataSource	Specifies the Cross Tab control’s data source.
XRCrossTab.DataMember	Specifies the data source member that provides data to the Cross Tab control.
XRCrossTab.RowFields	Provides access to the collection of the Cross Tab’s row fields.
XRCrossTab.ColumnFields	Provides access to the collection of the Cross Tab’s column fields.
XRCrossTab.DataFields	Provides access to the collection of the Cross Tab’s data fields.
XRCrossTab.GenerateLayout	Generate the Cross Tab cells based on the specified fields.
XRCrossTab.PrintOptions	Provides access to the Cross Tab’s print options.
CrossTabStyles.GeneralStyle	Specifies the Cross Tab control’s general appearance settings.
CrossTabStyles.DataAreaStyle	Specifies appearance settings for the Cross Tab control’s data area.
CrossTabStyles.HeaderAreaStyle	Specifies appearance settings for the Cross Tab control’s header area.
CrossTabStyles.TotalAreaStyle	Specifies appearance settings for the Cross Tab control’s total area.
XtraReport.VerticalContentSplitting	Gets or sets a value indicating whether report controls outside the right page margin should be split across pages, or moved in their entirety to the next page.
XtraReport.HorizontalContentSplitting	When the brick dimensions do not fit into the bottom page margin, specifies whether the brick content is split across two pages or moved to a new page.

Tip

You can further customize the resulting cross-tab report in the End-User Report Designer.

Implements

DevExpress.Data.IDataContainerBase.DataSource