XRTableCellCollection.Add(XRTableCell) Method

Appends the specified XRTableCell to the table row’s collection of cells.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v20.2.dll

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

Declaration

C#

public int Add(
    XRTableCell cell
)

VB.NET

Public Function Add(
    cell As XRTableCell
) As Integer

Parameters

Name	Type	Description
cell	XRTableCell	An XRTableCell object to append to the collection.

Returns

Type	Description
Int32	An integer value specifying the index of the new element in the collection. This method adds the XRTableCell object to the end of the collection.

Remarks

This method is intended to be used instead of the XRControlCollection.Add when a cell is added to a table row.

Note

If you’re creating an XRTable object at runtime and manually add XRTableRow and XRTableCell objects to it, it is always required to enclose this code inside the XRTable.BeginInit and XRTable.EndInit method calls. Also, the final size of the table doesn’t consider the size of table rows and table cells being added to it. So, you need to manually set the table size and width before calling the XRTable.EndInit method.

Example

The code sample below illustrates how to create an XRTable at runtime.

Tip

Online Example: Runtime table creation best practices (iterative approach)

C#

using DevExpress.XtraReports.UI;
// ...
// Create a report.
XtraReport report = new XtraReport();

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

// Create a table and add it to the detail band.
XRTable table = new XRTable();
detailBand.Controls.Add(table);

// Add rows and colums to the table.
int numRows = 10;
int numCols = 20;

table.BeginInit();

for (int i = 0; i < numRows; i++) {
    XRTableRow row = new XRTableRow();
    table.Rows.Add(row);

    for (int j = 0; j < numCols; j++) {
        XRTableCell cell = new XRTableCell();
        table.Rows[i].Cells.Add(cell);
    }
}

// Set table size.
table.HeightF = 50;
table.WidthF = 500;

table.EndInit();

VB.NET

Imports DevExpress.XtraReports.UI
' ...
' Create a report.
Dim report As New XtraReport()

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

' Create a table and add it to the detail band.
Dim table As New XRTable()
detailBand.Controls.Add(table)

' Add rows and colums to the table.
Dim numRows As Integer = 10
Dim numCols As Integer = 20

table.BeginInit()

For i As Integer = 0 To numRows - 1
    Dim row As New XRTableRow()
    table.Rows.Add(row)

    For j As Integer = 0 To numCols - 1
        Dim cell As New XRTableCell()
        table.Rows(i).Cells.Add(cell)
    Next j
Next i

' Set table size.
table.HeightF = 50
table.WidthF = 500

table.EndInit()

The following code sample creates an XRTable at runtime and binds the table to data:

C#

using DevExpress.XtraReports.UI;
using DevExpress.DataAccess.Sql;
using DevExpress.DataAccess.ConnectionParameters;
// ...
private static SqlDataSource CreateSQLDataSource() {
    // Create a data source with the required connection parameters.  
    Access97ConnectionParameters connectionParameters = new Access97ConnectionParameters("Data/nwind.mdb", "", "");
    SqlDataSource dataSource = new SqlDataSource(connectionParameters);

    // Create a SELECT query.
    SelectQuery query = SelectQueryFluentBuilder
        .AddTable("Products")
        .SelectColumn("ProductName")
        .SelectColumn("UnitPrice")
        .Build("selectQuery");

    // Add the query to the collection and return the data source. 
    dataSource.Queries.Add(query);
    dataSource.Fill();
    return dataSource;
}
// ...
// Create a new data source.
SqlDataSource sqlDataSource = CreateSQLDataSource();

// Create a new report and assign the data source to it.
XtraReport report = new XtraReport();
report.DataSource = sqlDataSource;
report.DataMember = "Products";

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

// Create a table and add it to the detail band.
XRTable table = new XRTable();
detailBand.Controls.Add(table);

// Create a row and add the product name and product price cells to the row.
table.BeginInit();

XRTableRow row = new XRTableRow();
table.Rows.Add(row);

XRTableCell productName = new XRTableCell();
XRTableCell productPrice = new XRTableCell();

row.Cells.Add(productName);
row.Cells.Add(productPrice);

// Bind the table cells to the data fields.
productName.ExpressionBindings.Add(new ExpressionBinding("BeforePrint", "Text", "[ProductName]"));
productPrice.ExpressionBindings.Add(new ExpressionBinding("BeforePrint", "Text", "[UnitPrice]"));

table.EndInit();

VB.NET

Imports DevExpress.XtraReports.UI
Imports DevExpress.DataAccess.Sql
Imports DevExpress.DataAccess.ConnectionParameters
' ...
Private Shared Function CreateSQLDataSource() As SqlDataSource
    ' Create a data source with the required connection parameters.  
    Dim connectionParameters As New Access97ConnectionParameters("Data/nwind.mdb", "", "")
    Dim dataSource As New SqlDataSource(connectionParameters)

    ' Create a SELECT query.
    Dim query As SelectQuery = SelectQueryFluentBuilder.AddTable("Products").SelectColumn("ProductName").SelectColumn("UnitPrice").Build("selectQuery")

    ' Add the query to the collection and return the data source. 
    dataSource.Queries.Add(query)
    dataSource.Fill()
    Return dataSource
End Function
' ...
' Create a new data source.
Dim sqlDataSource As SqlDataSource = CreateSQLDataSource()

' Create a new report and assign the data source to it.
Dim report As New XtraReport()
report.DataSource = sqlDataSource
report.DataMember = "Products"

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

' Create a table and add it to the detail band.
Dim table As New XRTable()
detailBand.Controls.Add(table)

' Create a row and add the product name and product price cells to the row.
table.BeginInit()

Dim row As New XRTableRow()
table.Rows.Add(row)

Dim productName As New XRTableCell()
Dim productPrice As New XRTableCell()

row.Cells.Add(productName)
row.Cells.Add(productPrice)

' Bind the table cells to the data fields.
productName.ExpressionBindings.Add(New ExpressionBinding("BeforePrint", "Text", "[ProductName]"))
productPrice.ExpressionBindings.Add(New ExpressionBinding("BeforePrint", "Text", "[UnitPrice]"))

table.EndInit()

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Add(XRTableCell) method.

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-create-a-custom-exporter-for-pivotgridcontrol-with-xtrareport/CS/Report_at_Runtime/PivotReportGenerator.cs#L207

// Place the cells into the corresponding tables
header.Rows[0].Cells.Add(headerCell);
detail.Rows[0].Cells.Add(detailCell);

how-to-create-a-custom-exporter-that-supports-autorowheight-bestfit-and-fittopage-t274241/CS/WpfApplication31/PivotReportGenerator.cs#L195

// Place the cells into the corresponding tables
header.Rows[0].Cells.Add(headerCell);
detail.Rows[0].Cells.Add(detailCell);

Reporting_how-to-create-a-label-in-the-pageheader-band-when-a-field-is-dragged-from-the-t457241/CS/T457241/CustomFieldListDragDropService.cs#L125

headerCell.Font = new Font("Calibry", 11, FontStyle.Bold);
row.Cells.Add(headerCell);
host.Container.Add(headerCell);

reporting-create-table-at-runtime/CS/XtraReport1.cs#L33

    XRTableCell cell = new XRTableCell();
    row.Cells.Add(cell);
}

VB.NET

reporting-winforms-create-simple-table/VB/XtraReport1.vb#L34

' Construct the table.
row.Cells.Add(cell0)
row.Cells.Add(cell1)

winforms-create-a-custom-exporter-for-pivotgridcontrol-with-xtrareport/VB/Report_at_Runtime/PivotReportGenerator.vb#L199

' Place the cells into the corresponding tables
header.Rows(0).Cells.Add(headerCell)
detail.Rows(0).Cells.Add(detailCell)

how-to-create-a-custom-exporter-that-supports-autorowheight-bestfit-and-fittopage-t274241/VB/WpfApplication31/PivotReportGenerator.vb#L205

' Place the cells into the corresponding tables
header.Rows(0).Cells.Add(headerCell)
detail.Rows(0).Cells.Add(detailCell)

Reporting_how-to-create-a-label-in-the-pageheader-band-when-a-field-is-dragged-from-the-t457241/VB/T457241/CustomFieldListDragDropService.vb#L134

headerCell.Font = New Font("Calibry", 11, FontStyle.Bold)
row.Cells.Add(headerCell)
Host.Container.Add(headerCell)

reporting-create-table-at-runtime/VB/XtraReport1.vb#L33

    Dim cell As XRTableCell = New XRTableCell()
    row.Cells.Add(cell)
Next