Bind a Report to a Collection that Implements the ITypedList Interface (Runtime Sample)

Oct 09, 2023
7 minutes to read

In This Article

Implement the ITypedList Interface to Data Objects

This tutorial demonstrates how to create a hierarchical master-detail data source at runtime and bind a report to it.

#Implement the ITypedList Interface to Data Objects

If a report’s data source consists of objects created at runtime, it should implement the ITypedList interface. The code below demonstrates how to implement the ITypedList interface for a 3-tier Supplier-Product-OrderDetail hierarchical data source.

C#
VB.NET

using System;
using System.Collections;
using System.ComponentModel;
// ...

public class SupplierCollection : ArrayList, ITypedList {
    PropertyDescriptorCollection ITypedList.GetItemProperties(PropertyDescriptor[] listAccessors) {
        if (listAccessors != null && listAccessors.Length > 0) {
            PropertyDescriptor listAccessor = listAccessors[listAccessors.Length - 1];
            if (listAccessor.PropertyType.Equals(typeof(ProductCollection)))
                return TypeDescriptor.GetProperties(typeof(Product));
            else if (listAccessor.PropertyType.Equals(typeof(OrderDetailCollection)))
                return TypeDescriptor.GetProperties(typeof(OrderDetail));
        }
        return TypeDescriptor.GetProperties(typeof(Supplier));
    }
    string ITypedList.GetListName(PropertyDescriptor[] listAccessors) {
        return "Suppliers";
    }
}

public class Supplier {
    static int nextID = 0;
    int id;
    string name;
    ProductCollection products = new ProductCollection();

    public ProductCollection Products { get { return products; } }
    public int SupplierID { get { return id; } }
    public string CompanyName { get { return name; } }

    public Supplier(string name) {
        this.name = name;

        this.id = nextID;
        nextID++;
    }
    public void Add(Product product) {
        products.Add(product);
    }
}

public class ProductCollection : ArrayList, ITypedList {
    PropertyDescriptorCollection ITypedList.GetItemProperties(PropertyDescriptor[] listAccessors) {
        return TypeDescriptor.GetProperties(typeof(Product));
    }
    string ITypedList.GetListName(PropertyDescriptor[] listAccessors) {
        return "Products";
    }
}

public class Product {
    static int nextID = 0;

    OrderDetailCollection orderDetails = new OrderDetailCollection();
    int suppID;
    int prodID;
    string name;

    public int SupplierID { get { return suppID; } }
    public int ProductID { get { return prodID; } }
    public string ProductName { get { return name; } }
    public OrderDetailCollection OrderDetails { get { return orderDetails; } }

    public Product(int suppID, string name) {
        this.suppID = suppID;
        this.name = name;

        this.prodID = nextID;
        nextID++;
    }
}

public class OrderDetailCollection : ArrayList, ITypedList {
    PropertyDescriptorCollection ITypedList.GetItemProperties(PropertyDescriptor[] listAccessors) {
        return TypeDescriptor.GetProperties(typeof(OrderDetail));
    }
    string ITypedList.GetListName(PropertyDescriptor[] listAccessors) {
        return "OrderDetails";
    }
}

public class OrderDetail {
    int prodID;
    short quantity;
    public int ProductID { get { return prodID; } }
    public short Quantity { get { return quantity; } }

    public OrderDetail(int prodID, int quantity) {
        this.prodID = prodID;
        this.quantity = Convert.ToInt16(quantity);
    }
}

Imports System
Imports System.Collections
Imports System.ComponentModel
' ...


Public Class SupplierCollection
    Inherits ArrayList
    Implements ITypedList
    Private Function GetItemProperties(ByVal listAccessors() As PropertyDescriptor) _ 
    As PropertyDescriptorCollection Implements ITypedList.GetItemProperties
        If listAccessors IsNot Nothing AndAlso listAccessors.Length > 0 Then
            Dim listAccessor As PropertyDescriptor = listAccessors(listAccessors.Length - 1)
            If listAccessor.PropertyType.Equals(GetType(ProductCollection)) Then
                Return TypeDescriptor.GetProperties(GetType(Product))
            ElseIf listAccessor.PropertyType.Equals(GetType(OrderDetailCollection)) Then
                Return TypeDescriptor.GetProperties(GetType(OrderDetail))
            End If
        End If
        Return TypeDescriptor.GetProperties(GetType(Supplier))
    End Function
    Private Function GetListName(ByVal listAccessors() As PropertyDescriptor) As String _
    Implements ITypedList.GetListName
        Return "Suppliers"
    End Function
End Class

Public Class Supplier
    Private Shared nextID As Integer = 0
    Private id As Integer
    Private name As String
    Private products_Renamed As New ProductCollection()

    Public ReadOnly Property Products() As ProductCollection
        Get
            Return products_Renamed
        End Get
    End Property
    Public ReadOnly Property SupplierID() As Integer
        Get
            Return id
        End Get
    End Property
    Public ReadOnly Property CompanyName() As String
        Get
            Return name
        End Get
    End Property

    Public Sub New(ByVal name As String)
        Me.name = name

        Me.id = nextID
        nextID += 1
    End Sub
    Public Sub Add(ByVal product As Product)
        products_Renamed.Add(product)
    End Sub
End Class

Public Class ProductCollection
    Inherits ArrayList
    Implements ITypedList
    Private Function GetItemProperties(ByVal listAccessors() As PropertyDescriptor) As 
        PropertyDescriptorCollection Implements ITypedList.GetItemProperties
        Return TypeDescriptor.GetProperties(GetType(Product))
    End Function
    Private Function GetListName(ByVal listAccessors() As PropertyDescriptor) As String _
    Implements ITypedList.GetListName
        Return "Products"
    End Function
End Class

Public Class Product
    Private Shared nextID As Integer = 0

    Private orderDetails_Renamed As New OrderDetailCollection()
    Private suppID As Integer
    Private prodID As Integer
    Private name As String

    Public ReadOnly Property SupplierID() As Integer
        Get
            Return suppID
        End Get
    End Property
    Public ReadOnly Property ProductID() As Integer
        Get
            Return prodID
        End Get
    End Property
    Public ReadOnly Property ProductName() As String
        Get
            Return name
        End Get
    End Property
    Public ReadOnly Property OrderDetails() As OrderDetailCollection
        Get
            Return orderDetails_Renamed
        End Get
    End Property

    Public Sub New(ByVal suppID As Integer, ByVal name As String)
        Me.suppID = suppID
        Me.name = name

        Me.prodID = nextID
        nextID += 1
    End Sub
End Class

Public Class OrderDetailCollection
    Inherits ArrayList
    Implements ITypedList
    Private Function GetItemProperties(ByVal listAccessors() As PropertyDescriptor) As 
    PropertyDescriptorCollection Implements ITypedList.GetItemProperties
        Return TypeDescriptor.GetProperties(GetType(OrderDetail))
    End Function
    Private Function GetListName(ByVal listAccessors() As PropertyDescriptor) As String _
    Implements ITypedList.GetListName
        Return "OrderDetails"
    End Function
End Class

Public Class OrderDetail
    Private prodID As Integer
    Private quantity_Renamed As Short
    Public ReadOnly Property ProductID() As Integer
        Get
            Return prodID
        End Get
    End Property
    Public ReadOnly Property Quantity() As Short
        Get
            Return quantity_Renamed
        End Get
    End Property

    Public Sub New(ByVal prodID As Integer, ByVal quantity As Integer)
        Me.prodID = prodID
        Me.quantity_Renamed = Convert.ToInt16(quantity)
    End Sub
End Class

#Create Data

The following code demonstrates how to create the data objects declared in the previous section and populate them with data:

C#
VB.NET

private SupplierCollection CreateData() {
    SupplierCollection suppliers = new SupplierCollection();

    Supplier supplier = new Supplier("Exotic Liquids");
    suppliers.Add(supplier);
    supplier.Add(CreateProduct(supplier.SupplierID, "Chai"));
    supplier.Add(CreateProduct(supplier.SupplierID, "Chang"));
    supplier.Add(CreateProduct(supplier.SupplierID, "Aniseed Syrup"));

    supplier = new Supplier("New Orleans Cajun Delights");
    suppliers.Add(supplier);
    supplier.Add(CreateProduct(supplier.SupplierID, "Chef Anton's Cajun Seasoning"));
    supplier.Add(CreateProduct(supplier.SupplierID, "Chef Anton's Gumbo Mix"));

    supplier = new Supplier("Grandma Kelly's Homestead");
    suppliers.Add(supplier);
    supplier.Add(CreateProduct(supplier.SupplierID, "Grandma's Boysenberry Spread"));
    supplier.Add(CreateProduct(supplier.SupplierID, "Uncle Bob's Organic Dried Pears"));
    supplier.Add(CreateProduct(supplier.SupplierID, "Northwoods Cranberry Sauce"));

    return suppliers;
}

static Random random = new Random(5);

private Product CreateProduct(int supplierID, string productName) {
    Product product = new Product(supplierID, productName);

    product.OrderDetails.AddRange(new OrderDetail[] { 
        new OrderDetail(product.ProductID, random.Next(0, 100)), 
        new OrderDetail(product.ProductID, random.Next(0, 100)),
        new OrderDetail(product.ProductID, random.Next(0, 100)) });

    return product;
}

Private Function CreateData() As SupplierCollection
    Dim suppliers As New SupplierCollection()

    Dim supplier As New Supplier("Exotic Liquids")
    suppliers.Add(supplier)
    supplier.Add(CreateProduct(supplier.SupplierID, "Chai"))
    supplier.Add(CreateProduct(supplier.SupplierID, "Chang"))
    supplier.Add(CreateProduct(supplier.SupplierID, "Aniseed Syrup"))

    supplier = New Supplier("New Orleans Cajun Delights")
    suppliers.Add(supplier)
    supplier.Add(CreateProduct(supplier.SupplierID, "Chef Anton's Cajun Seasoning"))
    supplier.Add(CreateProduct(supplier.SupplierID, "Chef Anton's Gumbo Mix"))

    supplier = New Supplier("Grandma Kelly's Homestead")
    suppliers.Add(supplier)
    supplier.Add(CreateProduct(supplier.SupplierID, "Grandma's Boysenberry Spread"))
    supplier.Add(CreateProduct(supplier.SupplierID, "Uncle Bob's Organic Dried Pears"))
    supplier.Add(CreateProduct(supplier.SupplierID, "Northwoods Cranberry Sauce"))

    Return suppliers
End Function

Private Shared random As New Random(5)

Private Function CreateProduct(ByVal supplierID As Integer, ByVal productName As String) As Product
    Dim product As New Product(supplierID, productName)

    product.OrderDetails.AddRange(New OrderDetail() { _
        New OrderDetail(product.ProductID, random.Next(0, 100)), _
        New OrderDetail(product.ProductID, random.Next(0, 100)), _
        New OrderDetail(product.ProductID, random.Next(0, 100))})

    Return product
End Function

#Create a Report

The following code demonstrates how to create a 3-tier master-detail report at runtime, add bands and controls to it, and bind the report to an ITypedList data source that was created in the previous sections.

C#
VB.NET

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

private XtraReport CreateReport() {
    XtraReport report = new XtraReport();

    DetailBand detail = new DetailBand();
    detail.Height = 30;
    report.Bands.Add(detail);

    DetailReportBand detailReport1 = new DetailReportBand();
    report.Bands.Add(detailReport1);

    DetailBand detail1 = new DetailBand();
    detail1.Height = 30;
    detailReport1.Bands.Add(detail1);

    DetailReportBand detailReport2 = new DetailReportBand();
    detailReport1.Bands.Add(detailReport2);

    DetailBand detail2 = new DetailBand();
    detail2.Height = 30;
    detailReport2.Bands.Add(detail2);

    report.DataSource = CreateData();
    detailReport1.DataMember = "Products";
    detailReport2.DataMember = "Products.OrderDetails";

    detail.Controls.Add(CreateBoundLabel("CompanyName", Color.Gold, 0));
    detail1.Controls.Add(CreateBoundLabel("Products.ProductName", Color.Aqua, 100));
    detail2.Controls.Add(CreateBoundLabel("Products.OrderDetails.Quantity", Color.Pink, 200));

    return report;
}

private XRLabel CreateBoundLabel(string dataMember, Color backColor, int offset) {
    XRLabel label = new XRLabel();
    // Bind the label to data.
    label.ExpressionBindings.Add(new ExpressionBinding("BeforePrint", "Text", dataMember));
    label.BackColor = backColor;
    label.Location = new Point(offset, 0);

    return label;
}

Imports DevExpress.XtraReports.UI
Imports DevExpress.XtraReports.Configuration
' ...

Private Function CreateReport() As XtraReport
    Dim report As New XtraReport()

    Dim detail As New DetailBand()
    detail.Height = 30
    report.Bands.Add(detail)

    Dim detailReport1 As New DetailReportBand()
    report.Bands.Add(detailReport1)

    Dim detail1 As New DetailBand()
    detail1.Height = 30
    detailReport1.Bands.Add(detail1)

    Dim detailReport2 As New DetailReportBand()
    detailReport1.Bands.Add(detailReport2)

    Dim detail2 As New DetailBand()
    detail2.Height = 30
    detailReport2.Bands.Add(detail2)

    report.DataSource = CreateData()
    detailReport1.DataMember = "Products"
    detailReport2.DataMember = "Products.OrderDetails"

    detail.Controls.Add(CreateBoundLabel("CompanyName", Color.Gold, 0))
    detail1.Controls.Add(CreateBoundLabel("Products.ProductName", Color.Aqua, 100))
    detail2.Controls.Add(CreateBoundLabel("Products.OrderDetails.Quantity", Color.Pink, 200))

    Return report
End Function

Private Function CreateBoundLabel(ByVal dataMember As String, 
ByVal backColor As Color, ByVal offset As Integer) As XRLabel
    Dim label As New XRLabel()
    ' Bind the label to data.
    label.ExpressionBindings.Add(New ExpressionBinding("BeforePrint", "Text", dataMember))
    label.BackColor = backColor
    label.Location = New Point(offset, 0)

    Return label
End Function

#View the Result

The following code creates a report and shows its preview:

C#
VB.NET

private void button1_Click(object sender, EventArgs e) {
    XtraReport report = CreateReport();

    // Show the report's print preview.
    ReportPrintTool printTool = new ReportPrintTool(report);
    printTool.ShowPreview();
}

Private Sub button1_Click(ByVal sender As Object, ByVal e As EventArgs) _
Handles button1.Click
    Dim report As XtraReport = CreateReport()

    ' Show the report's print preview.
    Dim printTool As New ReportPrintTool(report)
    printTool.ShowPreview()
End Sub

The resulting report is shown in the image below.

HowTo_ITypedList1

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Controls

Tools

Controls and Extensions

Tools

Maintenance Mode

Bind a Report to a Collection that Implements the ITypedList Interface (Runtime Sample)

#Implement the ITypedList Interface to Data Objects

#Create Data

#Create a Report

#View the Result