Back to Devexpress

XRTableCellCollection.Add(XRTableCell) Method

xtrareports-devexpress-dot-xtrareports-dot-ui-dot-xrtablecellcollection-dot-add-x28-devexpress-dot-xtrareports-dot-ui-dot-xrtablecell-x29.md

latest8.9 KB
Original Source

XRTableCellCollection.Add(XRTableCell) Method

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

Namespace : DevExpress.XtraReports.UI

Assembly : DevExpress.XtraReports.v25.2.dll

NuGet Package : DevExpress.Reporting.Core

Declaration

csharp
public int Add(
    XRTableCell cell
)
vb
Public Function Add(
    cell As XRTableCell
) As Integer

Parameters

NameTypeDescription
cellXRTableCell

An XRTableCell object to append to the collection.

|

Returns

TypeDescription
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 a XRTable at runtime.

csharp
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.
XRTable table = new XRTable();

// Add rows and columns 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();

// Add the table to the detail band and adjust the band height.
detailBand.Controls.Add(table);
detailBand.HeightF = table.HeightF;
vb
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.
            Dim table As New XRTable()

            ' Add rows and columns 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()

            ' Add the table to the detail band and adjust the band height.
            detailBand.Controls.Add(table)
            detailBand.HeightF = table.HeightF

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.

reporting-winforms-create-table-at-runtime/CS/TableReport.cs#L32

csharp
cell.Text = string.Format("Row: {0}; Column:{1}", i, j);
    row.Cells.Add(cell);
}

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

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

winforms-reporting-create-grid-based-report/CS/ConvertGridToReportExample/XtraReport1.cs#L67

csharp
cell.Text = columns[i].ToString();
row.Cells.Add(cell);

reporting-use-multi-value-parameter-as-table-column-chooser/CS/T333639/SampleReport.cs#L52

csharp
headerCell.Text = description;
this.trHeader.Cells.Add(headerCell);

reporting-mvc-generate-report-dynamically-for-specified-query/CS/ReportForQueryExample/PredefinedReports/TestReport.cs#L68

csharp
cell.Text = dc.Name;
    dynamicTable.Rows.FirstRow.Cells.Add(cell);
}

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

vb
cell.Text = String.Format("Row: {0}; Column:{1}", i, j)
    row.Cells.Add(cell)
Next j

asp-net-mvc-grid-create-report-based-on-grid-layout/VB/E4755/Models/ReportHelperMVC.vb#L121

vb
cell.Text = columns(i).FieldName
row.Cells.Add(cell)

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

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

winforms-reporting-create-grid-based-report/VB/ConvertGridToReportExample/XtraReport1.vb#L65

vb
cell.Text = columns(i).ToString()
row.Cells.Add(cell)

reporting-use-multi-value-parameter-as-table-column-chooser/VB/T333639/SampleReport.vb#L49

vb
Dim headerCell As New XRTableCell() With {.Text = description}
Me.trHeader.Cells.Add(headerCell)

See Also

XRTableCellCollection Class

XRTableCellCollection Members

DevExpress.XtraReports.UI Namespace