Crystal Reports Push Model Conversion Utility (.NET)

Category:

C#, VB.NET, ASP.NET

Type:

Classes

Difficulty:

Intermediate

Author:

Jeff Winn

Version Compatibility: Visual Basic.NET, ASP.NET

More information:

This class is used to convert datasets retrieved by SQL server connections to a format usable by the Crystal Reports engine using the Push model described in the documentation.

The documentation and examples are included with the class for portability. It will also help you start out using the Push model with Crystal Reports if you are unsure where to begin.

Instructions: Copy the declarations and code below and paste directly into your VB project.

Declarations:
#Region " Imports " Imports System.Data #End Region

Code:

' Crystal Reports Conversion Class
' Written By: Jeffrey Winn
' 
' This class is to be used as a general utility for converting DataSets pulled from
' the server to a format that is usable by the Crystal Reports Engine. Since this 
' class requires you to use the PUSH method for the report, you MUST have a DataSet
' file in your project. Generally these are XSD files.
'
' I created this class because there was no information available on the Internet 
' on how to use multiple servers for the same report. This class hasn't been tested
' much for other people since I only intended it to be for my own use, but it will
' help many of you start using this method.

Public Class CrystalConvertor

#Region " Function Examples "

' FUNCTION ConvertDataSet
    ' Variables: vwPrint is the name of a DataSet object that I added to the project
    '   which is being held in a dataset file named dstReport.xsd 
    ' Requirements: You will first need to add a DataSet object to your project and
    '   add a table to that which you are wanting to use. Then create the report 
    '   and when asked what server to use, tell it to use the dataset that you just
    '   created. To use a PUSH method for the reports THIS MUST BE COMPLETED FIRST.
    ' Note: This example uses a custom built ADO.NET utility that I designed to 
    '   connect to a SQL server and format the information into a DataSet object.

'   Dim rptTemp As New rptMyReport, cvtr As New CrystalConvertor
    '   rptTemp.SetDataSource(cvtr.ConvertDataSet(objADO.ExecuteSQL("SELECT * FROM vwPrint"), "vwPrint"))

#End Region

Public Function ConvertDataset(ByVal dsValue As DataSet, ByVal dsName As String) As DataSet
        ' Purpose: Used to format the DataSet 'dsValue' to the proper convention
        '          which is used by the Crystal Reports engine.
        ' Variables: dsName -  This MUST be the exact same name as the DataSet object
        '                      listed in the project.
        '            dsValue - This value is the DataSet used within the application
        '                      passed to the function for conversion.
        ' Syntax: cvtr.ConvertDataset(dsTemp, "MyDataSet")

Dim dsCol As DataColumn, dsRow As DataRow, dsReport As New DataSet(dsName)
        Dim dsTable As New DataTable(dsName)
        For Each dsCol In dsValue.Tables(0).Columns
            dsTable.Columns.Add(dsCol.Caption)
        Next

Dim tdsRow As DataRow, tObject As Object, ColPos As Integer
        For Each dsRow In dsValue.Tables(0).Rows
            tdsRow = dsTable.NewRow
            ColPos = 0
            For Each tObject In dsRow.ItemArray
                tdsRow(ColPos) = tObject
                ColPos += 1
            Next
            dsTable.Rows.Add(tdsRow)
        Next
        dsReport.Tables.Add(dsTable)

Return dsReport

End Function
End Class