XRTable Class

A Table control.

Namespace: DevExpress.XtraReports.UI

Assembly: DevExpress.XtraReports.v17.2.dll

NuGet Package: DevExpress.Reporting.Core

Declaration

C#

public class XRTable :
    XRControl,
    IWeightyContainer,
    ISupportInitialize

VB.NET

Public Class XRTable
    Inherits XRControl
    Implements IWeightyContainer,
               ISupportInitialize

Related API Members

The following members return XRTable objects:

• XRTable.CreateTable(RectangleF, Int32, Int32)
• XRTableRow.Table

Remarks

The XRTable control is intended to represent data in tabular form. A table consists of rows, accessed via its XRTable.Rows property. Every row consists of a number of cells, contained in the collections returned by the XRTableRow.Cells property of each row.

The following example illustrates the best approach to create large tables in code, which uses the XRTableCell.Weight and XRTableRow.Weight properties to specify the cell size (instead of using the XRTableCell.WidthF and XRTableRow.WidthF properties that are better suited for creating smaller tables).

The table generation occurs within the XRTable.BeginInit and XRTable.EndInit method calls.

C#

using DevExpress.XtraReports.UI;
// ...

private XRTable CreateLargeTable(int rowCount, int cellCount) {
    XRTable table = new XRTable();
    table.BeginInit();
    for (int i = 0; i < rowCount; i++) {
        XRTableRow row = new XRTableRow() { Weight = 1 };
        for (int j = 0; j < cellCount; j++) {
            XRTableCell cell = new XRTableCell() { Weight = 1 };
            row.Cells.Add(cell);
        }
        table.Rows.Add(row);
    }
    table.EndInit();

    return table;
}

VB.NET

Imports DevExpress.XtraReports.UI
' ...

Private Function CreateLargeTable(rowCount As Integer, cellCount As Integer) As XRTable
    Dim table As New XRTable()
    table.BeginInit()
    For i As Integer = 0 To rowCount - 1
        Dim row As New XRTableRow() With {.Weight = 1}
        For j As Integer = 0 To cellCount - 1
            Dim cell As New XRTableCell() With {.Weight = 1}
            row.Cells.Add(cell)
        Next
        table.Rows.Add(row)
    Next
    table.EndInit()

    Return table
End Function

When creating descendants of the XRTable and XRTableRow classes, you can override their protected virtual CreateRow and CreateCell methods. These methods are invoked in all designer operations, except for dropping multiple items from the Field List. The following example illustrates this approach.

C#

using DevExpress.XtraReports.UI;
using System.ComponentModel;
// ...

namespace WindowsFormsApplication1 {
    [ToolboxItem(true)]
    public class XRTableEx : XRTable {
        protected override XRTableRow CreateRow() {
            return new XRTableRowEx();
        }
    }

    public class XRTableRowEx : XRTableRow {
        public XRTableRowEx()
            : base() {
            SizeF = new System.Drawing.SizeF(120, this.DefaultHeight);
        }

        protected override XRTableCell CreateCell() {
            return new XRTableCellEx();
        }

        protected override int DefaultHeight {
            get {
                return 35;
            }
        }
    }

    public class XRTableCellEx : XRTableCell {
        public XRTableCellEx() {
            Text = "MyCustomXRTableCellEx";
        }
    }
}

VB.NET

Imports DevExpress.XtraReports.UI
Imports System.ComponentModel
' ...

Namespace WindowsFormsApplication1
    <ToolboxItem(True)> _
    Public Class XRTableEx
        Inherits XRTable
        Protected Overrides Function CreateRow() As XRTableRow
            Return New XRTableRowEx()
        End Function
    End Class

    Public Class XRTableRowEx
        Inherits XRTableRow
        Public Sub New()
            MyBase.New()
            SizeF = New System.Drawing.SizeF(120, Me.DefaultHeight)
        End Sub

        Protected Overrides Function CreateCell() As XRTableCell
            Return New XRTableCellEx()
        End Function

        Protected Overrides ReadOnly Property DefaultHeight() As Integer
            Get
                Return 35
            End Get
        End Property
    End Class

    Public Class XRTableCellEx
        Inherits XRTableCell
        Public Sub New()
            Text = "MyCustomXRTableCellEx"
        End Sub
    End Class
End Namespace

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

Implements

IScriptable

Inheritance

Object

MarshalByRefObject

Component

XRControl

XRTable