Click here to Skip to main content
15,301,414 members
Articles / Programming Languages / Visual Basic
Posted 6 Mar 2005


118 bookmarked

How to Load and Display Crystal Reports in VB.NET

Rate me:
Please Sign up or sign in to vote.
4.49/5 (48 votes)
6 Mar 20051 min read
An article about how to load and display Crystal Reports and handle the parameters and logon information.


The following code shows how to load Crystal Reports in VB.NET, solving all the issues of logon, including sub reports and parameter passing. You can view your reports by simply calling the required functions with its parameters.

Using the Code

Using this code in your application is very simple. In the first step you need to add a form, and name it frmViewReport, then place the Crystal Report Viewer control on the form and name it rptViewer. In the code section, simply paste the following function. You can call this function from anywhere in your application with reference to the frmViewReport form. The sample code for calling the function is given below:

Dim objForm As New frmViewReport
objForm.ViewReport("C:\test.rtp", , "@parameter1=test¶mter2=10")

Now let me explain you in detail what is going on in the code and what the format of the parameter string is. If there are parameters in the Crystal Reports then they should be passed with their values to the param of the function. The parameter string should be in the following format:

<First Parameter Name>=<First Paramter Value>&
<Second Parameter Name>=<Second Paramter Value>..

Note the parameter name and its value pairs are separated by an '&'. The report name with its full path should be passed to sReportName function.

Following is the function code with comments. I hope there will be no problem in understanding the code. Even if there is anything bothering you then drop me a message I'll explain that:

Friend Function ViewReport(ByVal sReportName As String, _
    Optional ByVal sSelectionFormula As String = "", _
    Optional ByVal param As String = "") As Boolean

    'Declaring variablesables
    Dim intCounter As Integer
    Dim intCounter1 As Integer

    'Crystal Report's report document object
    Dim objReport As New _

    'object of table Log on info of Crystal report
    Dim ConInfo As New CrystalDecisions.Shared.TableLogOnInfo

    'Parameter value object of crystal report 
    ' parameters used for adding the value to parameter.
    Dim paraValue As New CrystalDecisions.Shared.ParameterDiscreteValue

    'Current parameter value object(collection) of crystal report parameters.
    Dim currValue As CrystalDecisions.Shared.ParameterValues

    'Sub report object of crystal report.
    Dim mySubReportObject As _

    'Sub report document of crystal report.
    Dim mySubRepDoc As New _

    Dim strParValPair() As String
    Dim strVal() As String
    Dim index As Integer


        'Load the report

        'Check if there are parameters or not in report.
        intCounter = objReport.DataDefinition.ParameterFields.Count

        'As parameter fields collection also picks the selection 
        ' formula which is not the parameter
        ' so if total parameter count is 1 then we check whether 
        ' its a parameter or selection formula.

        If intCounter = 1 Then
            If InStr(objReport.DataDefinition.ParameterFields(_
                0).ParameterFieldName, ".", CompareMethod.Text) > 0 Then
                intCounter = 0
            End If    
        End If

        'If there are parameters in report and 
        'user has passed them then split the 
        'parameter string and Apply the values 
        'to their concurrent parameters.

        If intCounter > 0 And Trim(param) <> "" Then
            strParValPair = param.Split("&")

            For index = 0 To UBound(strParValPair)
            If InStr(strParValPair(index), "=") > 0 Then
                strVal = strParValPair(index).Split("=")
                paraValue.Value = strVal(1)
                currValue = _ 
            End If
    End If

    'Set the connection information to ConInfo 
    'object so that we can apply the 
    'connection information on each table in the report
    ConInfo.ConnectionInfo.UserID = <User Name>
    ConInfo.ConnectionInfo.Password = <Password>
    ConInfo.ConnectionInfo.ServerName = <Server Name>
    ConInfo.ConnectionInfo.DatabaseName = <Database Name>

    For intCounter = 0 To objReport.Database.Tables.Count - 1

    ' Loop through each section on the report then look 
    ' through each object in the section
    ' if the object is a subreport, then apply logon info 
    ' on each table of that sub report

        For index = 0 To objReport.ReportDefinition.Sections.Count - 1
            For intCounter = 0 To _
                index).ReportObjects.Count - 1
            With objReport.ReportDefinition.Sections(index)
                If .ReportObjects(intCounter).Kind = _
                CrystalDecisions.Shared.ReportObjectKind.SubreportObject Then
                    mySubReportObject = CType(.ReportObjects(intCounter), _
                    mySubRepDoc = _ 
                 For intCounter1 = 0 To mySubRepDoc.Database.Tables.Count - 1
                 End If
             End With
    'If there is a selection formula passed to this function then use that
    If sSelectionFormula.Length > 0 Then
        objReport.RecordSelectionFormula = sSelectionFormula
    End If
    'Re setting control 
    rptViewer.ReportSource = Nothing

    'Set the current report object to report.
    rptViewer.ReportSource = objReport

    'Show the report
        Return True
    Catch ex As System.Exception
    End Try
End Function

Points of Interest

The main problems while developing the function were the sub reports and the selection formula. When there were no parameters and only the selection formula, the function failed because the parameters collection was picking the selection formula. Initially it was hard to detect, but finally I solved that problem.


This article has no explicit license attached to it but may contain usage terms in the article text or the download files themselves. If in doubt please contact the author via the discussion board below.

A list of licenses authors might use can be found here


About the Author

Danish Alam
Pakistan Pakistan
No Biography provided

Comments and Discussions

QuestionDon't know where should I put this one Pin
darylhelen29-Dec-14 15:50
Memberdarylhelen29-Dec-14 15:50 
QuestionThis Code is working fine but there is a little bit problem Pin
SHERAZ SHIEKH30-Jul-14 14:31
MemberSHERAZ SHIEKH30-Jul-14 14:31 
QuestionUnderstanding Pin
Scott J Smith21-Dec-12 8:54
MemberScott J Smith21-Dec-12 8:54 
QuestionExcellent coding and some suggestions Pin
Amila thennakoon9-Oct-11 22:56
MemberAmila thennakoon9-Oct-11 22:56 
GeneralMy vote of 5 Pin
Ken LeBlanc2-Jun-11 10:22
MemberKen LeBlanc2-Jun-11 10:22 
GeneralParameters to a SubReport Pin
ricky99022-May-11 20:49
Memberricky99022-May-11 20:49 
Generaldata not displayed in crytsal report Pin
svknair19-May-11 20:10
Membersvknair19-May-11 20:10 
GeneralUsing crystal report 8.5 in Pin
rocky cardinal11-Apr-11 18:26
Memberrocky cardinal11-Apr-11 18:26 
Generalusing similar code but still getting error values cannot be NUll Pin
svknair1-Feb-11 22:05
Membersvknair1-Feb-11 22:05 
Generalneed help with .net and crystal report Pin
AltafAli4-Dec-10 15:34
MemberAltafAli4-Dec-10 15:34 
GeneralRe: need help with .net and crystal report Pin
moses_gandhar27-Feb-11 22:27
Membermoses_gandhar27-Feb-11 22:27 
GeneralMy vote of 2 Pin
Member 44736092-Dec-10 23:22
MemberMember 44736092-Dec-10 23:22 
Questionparameter in subreport Pin
kankmonty25-Oct-10 18:19
Memberkankmonty25-Oct-10 18:19 
QuestionCR 8.5 and VB Express 2010 Pin
waseemsz28-Jun-10 9:31
Memberwaseemsz28-Jun-10 9:31 
GeneralRequest for Code Update to VB 2008/2010 Please Pin
Bilal Dadar24-May-10 3:58
MemberBilal Dadar24-May-10 3:58 
GeneralExcellent code and explanation thank you for the time and effort of providing the code Pin
cmaster8-Apr-10 3:44
Membercmaster8-Apr-10 3:44 
GeneralQuestions about your example. Pin
John Heck17-Aug-09 3:04
MemberJohn Heck17-Aug-09 3:04 
GeneralDoesn't work Pin
Nickspi12-Jun-09 7:47
MemberNickspi12-Jun-09 7:47 
QuestionMulti Table Pin
Dawit Kiros7-Apr-09 9:25
MemberDawit Kiros7-Apr-09 9:25 
Generalcr 8.5 & VB 2008 Express Pin
ananthaas19-Mar-09 1:41
Memberananthaas19-Mar-09 1:41 
QuestionHow to read Print dialog of frmviewreport Pin
bunary2k19-Feb-09 21:48
Memberbunary2k19-Feb-09 21:48 
Questionabout creating crystal report in Pin
navsar28-Jan-09 0:02
Membernavsar28-Jan-09 0:02 
GeneralAbout crystal reports Pin
Mr. Milton30-Oct-08 23:59
MemberMr. Milton30-Oct-08 23:59 
GeneralRe: About crystal reports Pin
Tareqdhk10-Mar-10 19:23
MemberTareqdhk10-Mar-10 19:23 
Generalcrystal report report Pin
Bhim Prakash Singh11-Sep-08 4:52
MemberBhim Prakash Singh11-Sep-08 4:52 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Praise Praise    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.