Bind a Report to a List Object at Design Time and Supply Data at Runtime

• Aug 28, 2020
• 3 minutes to read

This tutorial demonstrates how to use an object data source to bind a report to a List<T> object.

1. Create a new application or open an existing application.

2. Add a new blank report to it.

3. Add a new Data.cs file with the following code to the application:

   Data.cs

   using System;
   // ...
   
   namespace WindowsApplication1 {
       public class Data {
           public Data() {
           }
           private int _id;
           private string _name;
           private DateTime _date;
           public int Id {
               get { return this._id; }
               set { this._id = value; }
           }
           public string Name {
               get { return this._name; }
               set { this._name = value; }
           }
           public DateTime Date {
               get { return this._date; }
               set { this._date = value; }
           }
       }
   }
   

   Data.vb

   Imports System
   ' ...
   
   Namespace WindowsApplication1
       Public Class Data
           Public Sub New()
           End Sub
           Private _id As Integer
           Private _name As String
           Private _date As DateTime
           Public Property Id() As Integer
               Get
                   Return Me._id
               End Get
               Set(ByVal value As Integer)
                   Me._id = value
               End Set
           End Property
           Public Property Name() As String
               Get
                   Return Me._name
               End Get
               Set(ByVal value As String)
                   Me._name = value
               End Set
           End Property
           Public Property [Date]() As DateTime
               Get
                   Return Me._date
               End Get
               Set(ByVal value As DateTime)
                   Me._date = value
               End Set
           End Property
       End Class
   End Namespace
   

4. Rebuild the solution.

5. Invoke the Data Source Wizard and follow the Wizard’s steps to bind the report to the Data object.

   

   5.1. Open the report’s smart tag, expand the Data Source property’s drop-down list, and click Add Report Data Source.

   

   5.2. Select Object and click Next.

   

   5.3. Select the assembly and click Next.

   

   5.4. Select the Data object and click Next.

   

   5.5. Select Retrieve the data source schema and click Finish.

   

   5.6. The report’s data source is set to objectDataSource1.

6. Drop data fields from the Field List onto the report.

   

7. Handle the Form1_Load event to populate and assign the report’s data source.

   C#

   using System;
   using System.Windows.Forms;
   using System.Collections.Generic;
   using DevExpress.XtraReports.UI;
   // ...
   
   private void Form1_Load(object sender, EventArgs e) {
       XtraReport1 report = new XtraReport1();
       report.DataSource = CreateData();
   
       ReportPrintTool tool = new ReportPrintTool(report);
       tool.ShowPreview();
   }
   
   private  List<Data> CreateData() {
       List<Data> data = new List<Data>();
   
       Data item1 = new Data();
       item1.Date = DateTime.Now;
       item1.Id = 0;
       item1.Name = "First";
       data.Add(item1);
   
       Data item2 = new Data();
       item2.Date = DateTime.Now;
       item2.Id = 1;
       item2.Name = "Second";
       data.Add(item2);
   
       Data item3 = new Data();
       item3.Date = DateTime.Now;
       item3.Id = 2;
       item3.Name = "Third";
       data.Add(item3);
   
       return data;
   }
   

   VB.NET

   Imports System
   Imports System.Windows.Forms
   Imports System.Collections.Generic
   Imports DevExpress.XtraReports.UI
   ' ...
   
   Private Sub Form1_Load(ByVal sender As Object, _ 
   ByVal e As EventArgs) Handles MyBase.Load
       Dim report As New XtraReport1()
       report.DataSource = CreateData()
   
       Dim Tool As ReportPrintTool = New ReportPrintTool(report)
       Tool.ShowPreview
   End Sub
   
   Private Function CreateData() As List(Of Data)
       Dim data As New List(Of Data)()
   
       Dim item1 As New Data()
       item1.Date = DateTime.Now
       item1.Id = 0
       item1.Name = "First"
       data.Add(item1)
   
       Dim item2 As New Data()
       item2.Date = DateTime.Now
       item2.Id = 1
       item2.Name = "Second"
       data.Add(item2)
   
       Dim item3 As New Data()
       item3.Date = DateTime.Now
       item3.Id = 2
       item3.Name = "Third"
       data.Add(item3)
   
       Return data
   End Function
   

Run the application and view the result.