XRTable.BeginInit() Method

Starts the XRTable‘s initialization. Initialization occurs at runtime.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v17.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public void BeginInit()

VB.NET

Public Sub BeginInit

Remarks

To create XRTable at runtime and manually add XRTableRow and XRTableCell objects to it, it is always required to enclose this code inside the BeginInit and XRTable.EndInit method calls.

Because the final size of a table does not consider the size of its rows and cells , you need to manually set the table size and width (or, call the XRTable.AdjustSize method) before calling the XRTable.EndInit method.

Note

The height of a table should be explicitly specified only if the cell content is not expected to stretch the cells (e.g., this may happen when their XRTableCell.CanGrow property is enabled).

Example

This example demonstrates how to create an XRTable at runtime.

Please note that it is always required to call the XRTable.BeginInit and XRTable.EndInit methods if you modify XRTable.Rows and XRTableRow.Cells collections at runtime.

Tip

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

C#

using System.Drawing;
using System.Drawing.Printing;
using DevExpress.XtraReports.UI;
// ...

private void XtraReport1_BeforePrint(object sender, PrintEventArgs e) {
    this.Detail.Controls.Add(CreateXRTable());
}

public XRTable CreateXRTable() {
    int cellsInRow = 3;
    int rowsCount = 3;
    float rowHeight = 25f;

    XRTable table = new XRTable();
    table.Borders = DevExpress.XtraPrinting.BorderSide.All;
    table.BeginInit();

    for (int i = 0; i < rowsCount; i++) {
        XRTableRow row = new XRTableRow();
        row.HeightF = rowHeight;
        for (int j = 0; j < cellsInRow; j++) {
            XRTableCell cell = new XRTableCell();
            row.Cells.Add(cell);
        }
        table.Rows.Add(row);
    }

    table.BeforePrint += new PrintEventHandler(table_BeforePrint);
    table.AdjustSize();
    table.EndInit();
    return table;
}

// The following code makes the table span to the entire page width.
void table_BeforePrint(object sender, PrintEventArgs e) {
    XRTable table = ((XRTable)sender);
    table.LocationF = new DevExpress.Utils.PointFloat(0F, 0F);
    table.WidthF = this.PageWidth - this.Margins.Left - this.Margins.Right;
}

VB.NET

Imports System.Drawing
Imports System.Drawing.Printing
Imports DevExpress.XtraReports.UI
' ...

Private Sub XtraReport1_BeforePrint(ByVal sender As Object, _ 
ByVal e As PrintEventArgs) Handles MyBase.BeforePrint
    Me.Detail.Controls.Add(CreateXRTable())
End Sub

Public Function CreateXRTable() As XRTable
    Dim cellsInRow As Integer = 3
    Dim rowsCount As Integer = 3
    Dim rowHeight As Single = 25f

    Dim table As New XRTable()
    table.Borders = DevExpress.XtraPrinting.BorderSide.All
    table.BeginInit()

    For i As Integer = 0 To rowsCount - 1
        Dim row As New XRTableRow()
        row.HeightF = rowHeight
        For j As Integer = 0 To cellsInRow - 1
            Dim cell As New XRTableCell()
            row.Cells.Add(cell)
        Next j
        table.Rows.Add(row)
    Next i

    AddHandler table.BeforePrint, AddressOf table_BeforePrint
    table.AdjustSize()
    table.EndInit()
    Return table
End Function

' The following code makes the table span to the entire page width.
Private Sub table_BeforePrint(ByVal sender As Object, ByVal e As PrintEventArgs)
    Dim table As XRTable = (CType(sender, XRTable))
    table.LocationF = New DevExpress.Utils.PointFloat(0F, 0F)
    table.WidthF = Me.PageWidth - Me.Margins.Left - Me.Margins.Right
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BeginInit() 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#

reporting-winforms-best-fit-table-row-height/CS/dx_sample/XtraReport1.cs#L17

CreateDocument();
xrTable2.BeginInit();
xrTable2.HeightF = DetailHeight;

VB.NET

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

InitNewTableInstancesAt(rep, font, tableHeader, tableDetail, New PointF(0, 0))
tableHeader.BeginInit()
tableDetail.BeginInit()

reporting-winforms-best-fit-table-row-height/VB/dx_sample/XtraReport1.vb#L21

CreateDocument()
xrTable2.BeginInit()
xrTable2.HeightF = DetailHeight