Click here to Skip to main content
Click here to Skip to main content

Invoke a custom method when Crystal Report Viewers’ print button is clicked / Add custom button to Crystal Report Viewer Toolbar

By , 8 Aug 2011
Rate this:
Please Sign up or sign in to vote.

If you are developing applications which includes reporting with Crystal Reports, you may have noticed that it’s not possible to invoke a custom method when the user prints the report. However this was something which was easily implemented in Crystal Reports 8/8.5 but removed from later versions.

But there’s a workaround for this. In this example, I will show you how to invoke a method in our client application when the print button of the report viewer is clicked.

In order to do that, we have to add our custom method to the report viewer’s print button’s print action.

Create a new Windows application. Add another form to the project and name it CustomReportViewer.cs.

Add a Crystal Report viewer to a newly created form. (If the Crystal Report Viewer is not available in the toolbox, please add it to the toolbox first.)

img_scr_001_a

img_scr_002

Add a new report to the project and name it SampleReport.rpt.

img_scr_003

Now add the following code to the CustomReportViewer class:

public delegate void CustomPrintDelegate();

Add the following property:

public Delegate CustomPrintMethod { get; set; }

Add this additional code to the initialization method:

foreach (Control control in crystalReportViewer1.Controls) {
    if (control is System.Windows.Forms.ToolStrip) {

        //Default Print Button
        ToolStripItem tsItem = ((ToolStrip)control).Items[1];
        tsItem.Click += new EventHandler(tsItem_Click);
        
        //Custom Button
        ToolStripItem tsNewItem = ((ToolStrip)control).Items.Add("");
        tsNewItem.ToolTipText = "Custom Print Button";
        tsNewItem.Image = Resources.CustomButton;
        tsNewItem.Tag = "99";
        ((ToolStrip)control).Items.Insert(0, tsNewItem);
        tsNewItem.Click += new EventHandler(tsNewItem_Click);
    }
}

Using the above code, we can find out the print button of the report viewer’s tool strip. And the first item is for the print button. (I found this out from its ToolTipText).

However, you can add your own button if you like or you can use the existing print button. Both options are illustrated.

Add the following methods:

void tsNewItem_Click(object sender, EventArgs e) {
    if (CustomPrintMethod != null) {
        CustomPrintMethod.DynamicInvoke(null);
    }
}

void tsItem_Click(object sender, EventArgs e) {
    if (CustomPrintMethod != null) {
        CustomPrintMethod.DynamicInvoke(null);
    }
}

Here is the complete code for the CustomReportViewer class:

using System;
using System.Drawing;
using System.Text;
using System.Windows.Forms;
using CrystalDecisions.CrystalReports.Engine;
using CrystalDecisions.Shared;

namespace PrintDelegateMethod {
    public partial class CustomReportViewer : Form {

        public delegate void CustomPrintDelegate();

        public Delegate CustomPrintMethod { get; set; }

        public CustomReportViewer() {
            InitializeComponent();

            foreach (Control control in crystalReportViewer1.Controls) {
                if (control is System.Windows.Forms.ToolStrip) {

                    //Default Print Button
                    ToolStripItem tsItem = ((ToolStrip)control).Items[1];
                    tsItem.Click += new EventHandler(tsItem_Click);
                    
                    //Custom Button
                    ToolStripItem tsNewItem = ((ToolStrip)control).Items.Add("");
                    tsNewItem.ToolTipText = "Custom Print Button";
                    tsNewItem.Image = Resources.CustomButton;
                    tsNewItem.Tag = "99";
                    ((ToolStrip)control).Items.Insert(0, tsNewItem);
                    tsNewItem.Click += new EventHandler(tsNewItem_Click);
                }
            }
        }

        void tsNewItem_Click(object sender, EventArgs e) {
            if (CustomPrintMethod != null) {
                CustomPrintMethod.DynamicInvoke(null);
            }
        }

        void tsItem_Click(object sender, EventArgs e) {
            if (CustomPrintMethod != null) {
                CustomPrintMethod.DynamicInvoke(null);
            }
        }

        private void CustomReportViewer_Load(object sender, EventArgs e) {
            SampleReport report = new SampleReport();
            crystalReportViewer1.ReportSource = report;
            crystalReportViewer1.Refresh();
        }
    }
}

Add the following delegate to your calling class:

public delegate void PrintDelegate();

Add the following method. This is the method that we want to invoke when the print button or the custom button is clicked.

private void CustomPrintMethod() {
    MessageBox.Show("Custom Print Method");
}

And a button and the following click event code:

private void button1_Click(object sender, EventArgs e) {
    CustomReportViewer viewer = new CustomReportViewer();
    PrintDelegate mymethod = new PrintDelegate(CustomPrintMethod);
    viewer.CustomPrintMethod = mymethod;
    viewer.Show();
}

The complete source of the calling form:

using System;
using System.Drawing;
using System.Text;
using System.Windows.Forms;

namespace PrintDelegateMethod {
    public partial class Form1 : Form {
        public delegate void PrintDelegate();

        public Form1() {
            InitializeComponent();
        }

        private void CustomPrintMethod() {
            MessageBox.Show("Custom Print Method");
        }

        private void button1_Click(object sender, EventArgs e) {
            CustomReportViewer viewer = new CustomReportViewer();
            PrintDelegate mymethod = new PrintDelegate(CustomPrintMethod);
            viewer.CustomPrintMethod = mymethod;
            viewer.Show();
        }
    }
}

Now if you run the project, you can get a screen similar to the one shown below. And please note that I have added a resource file named ‘Resources’ and added an image named ‘CustomButton’.

img_scr_011_a

And if you click either of the buttons, your custom method will be invoked. The default print method will be executed only when the print button is clicked.

img_scr_012

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Manjuke Fernando
Technical Lead Air Liquide Industrial Services (Singapore)
Singapore Singapore
I have been in software industry for more than 8 years. I have developed different type of software using different languages. Many of them are database related (both web & window based), SQL being as the back end most of the time. Up-to-date I have knowledge in languages such as C#, VB.Net, T-SQL, JAVA, VB6 & C++, making C# the most proficient of all. Also I have worked using different technologies like ASP.Net, SharePoint, Crystal Reports (But I really hate designing reports) & MS SQL Server and have involved in designing & developing software for major companies like FedEx, Softlogic Holdings, IronOne Technologies & Brandix. Currently I am working as a Tech Lead in Singapore.
Follow on   Twitter   LinkedIn

Comments and Discussions

 
QuestionMessage Removed PinmemberWaqasswaleh24-Jul-12 11:08 
AnswerRe: Print Report without preview PinmemberManjuke Fernando24-Jul-12 14:32 
GeneralRe: Print Report without preview PinmemberMember 92379389-Oct-12 0:07 
GeneralMy vote of 4 PinmemberMember 856396423-Feb-12 1:20 

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

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

| Advertise | Privacy | Mobile
Web04 | 2.8.140415.2 | Last Updated 8 Aug 2011
Article Copyright 2011 by Manjuke Fernando
Everything else Copyright © CodeProject, 1999-2014
Terms of Use
Layout: fixed | fluid