Click here to Skip to main content
15,936,989 members
Articles / Programming Languages / C#

A component that prints any control, including ListViews, TreeViews, DataGridViews, and Forms

Rate me:
Please Sign up or sign in to vote.
4.81/5 (70 votes)
29 Jun 2006CPOL8 min read 253.3K   10.3K   204   98
The ultimate printing component. Use it to print ListBoxes, ListViews, TreeViews, DataGridViews, Forms, TabPages, or even your own UserControls.

Sample Image - DemoPic.jpg


In this article, the following words are mentioned to refer to a specific meaning unless mentioned otherwise.

  • Control: The control you wish to print.
  • Component: The PrintControl component this article is talking about.


This component requires .NET Framework 2.0 or later.


Well, I think the title is clear. It’s all about printing. While I was developing some enterprise applications before, I used many lists in my application, and I needed to print them all, but they were on different forms, so in each form, I had to make a PrintDocument component and add a PrintPage event handler to draw its contents manually each time, spending hours to calculate each table’s height and width, then fitting this into the size of the page. Well, I actually didn’t do it. Instead, I thought of a component that will do this for me automatically, and here we are. The ControlPrint component will do the job.

Also, I had some information input forms for inputting name, age, gender, address, etc. I wanted to print these information too, but I had to customize another printing form by drawing it in printing!! The ControlPrint component will also get it on paper. See the picture on top of this article.

I inherited my component from the PrintDocument component, and did all the printing work in the PrintPage event handler. So to use it, follow these steps:

  1. Make an instance of the component.
  2. Supply it with your control, you will know how shortly.
  3. Call the Print() method, or use it with a PrintPreviewDialog.

You can deal with it just like any PrintDocument component, using this code:

PrintControl m_print = new PrintControl();
prinPreviewDialog1.Document = (PrintDocument)m_print;


The component’s main idea is drawing the control you wish to print, whether it is a ListView, ListBox, TreeView, or whatever, to the printer as it’s drawn on the screen. Something like WYSIWYG, or What You See Is What You Get! So, the main steps here are:

  1. Obtaining the control.
  2. Calculating the best size to display all the elements inside the control. There is no scrolling on the paper, is there?
  3. Drawing the control on the page as it would on the screen.

Of course, it’s not that simple, but we will walk through it.

How does it work?

The ControlPrint component supports any control, including User Controls, that are inherited from the Control class. It actually calls the GetPreferredSize() method of the control to obtain the best size of the control to display all its elements. Some controls don’t support that method and return wrong values of the preferred size. That’s why I added the CalculateSize() and ApplyBestSize() methods in my component to add more special support to these controls. Currently, the specially supported controls are:

  1. ListViews
  2. TreeViews
  3. Forms and other controls that contain more controls in them, like TabPages, GroupBoxes, etc…

Other controls should work fine using the ordinary GetPreferredSize() method, including DataGridViews, ListBoxes, etc. Also, forms usually work fine with GetPreferredSize(), and seldom need to use the CalculateSize() method

The component prints it to a bitmap using the Control.DrawToBitmap() method, and prints it.

You can also get that bitmap using the PrintControl.GetBitmap() method, and use it the way you like, like save it to a file, or print it inside other text, etc.

So after all that, the steps for printing are:

  1. Get the old values of the control’s size, dock status, and parent.
  2. Set the docking to none, and all the parents' sizes to larger than the desired size, you will know why shortly.
  3. Change the control’s size to the preferred size that will remove the need to scroll.
  4. Draw it to a bitmap.
  5. Restore the control’s status, including the parents' statuses.
  6. Print it, or return the bitmap, according to your choice.

I had to remove the docking status because it forbids resizing the control. Also, the parents had to be resized to fit the control’s new size. Only then drawing it to a bitmap would be successful. Refer to the interesting points for details.

Important notes

  1. If you make your own control, and would like to print it with PrintControl component, override the GetPreferredSize() method, and return the best size that fits your control according to its content, if the Control.GetPreferredSize() method returns wrong values for your control.
  2. You can print the control in the size you specify, by calling the appropriate size specifying methods in my component (see below). This may help when there are errors in calculating the controls size for some reason or the other, or if you prefer this for your own reasons.
  3. When printing a TreeView, only the expanded nodes will be printed, those that can be visible by scrolling to them. Other nodes that are hidden will not be printed. So if you want to make sure that you print all nodes in the TreeView, use the TreeView.ExpandAll() method.
  4. When you change the visual style of your control, it will also be printed as it is on screen, nice, isn’t it?
  5. Visual styles may be beautiful, but they will consume more ink and time in printing. So think about it.
  6. When printing forms, you might want to remove the background colors or images to make the text more clear.
  7. You can stretch the printed bitmap to fit exactly in one page by setting the StretchControl property to true. But be careful as this disrupts the width/height ratio and may distort the image.


I think now would be an appropriate time to talk about the component’s members.


  • ControlPrint()

    The default constructor that initializes the component with no actual values.

  • ControlPrint(Control print)

    Initialize the component with the selected control.

  • ControlPrint(Control print, bool Str)

    Initialize the component with the selected control, specifying whether to stretch or not.

  • ControlPrint(Control print, int Width, int Height)

    Initialize the component with the selected control, specifying the specific width and height.


  • StretchControl

    Set true to stretch the control to fill a single printed page.

  • PrintWidth

    The width of the control to print. You can change this value if the automatically calculated width does not fit all the elements of the control.

  • PrintHeight

    The height of the control to print. You can change this value if the automatically calculated height does not fit all the elements of the control.

  • ReapeatArea

    The area to be reprinted between pages if there is more than one page to be printed, to prevent data loss.


  • void SetControl(Control print)

    Set the control to be printed.

  • void SetControl(Control print, int Width, int Height)

    Set the control with a specified height and width.

  • Bitmap GetBitmap()

    Draw the control fully to a bitmap and return it.

  • Size CalculateSize()

    Return the best size that fits the control.

  • void ApplyBestSize()

    Apply the best size that fits the control.

Interesting points

These are some points that I saw interesting as it stood in front of me while developing the component.

  1. I had to resize the control in the first place because otherwise it would only print the visible part and it would print the scrollbars also. I think that won’t be much of a help.
  2. Trying to resize the control while it is docked was a failure so I had to undock it first.
  3. Also, the parents of the control had to be larger than it. Otherwise, the control would only draw the visible part. I first tried to make the parent to null and then restore it, but that didn’t work with forms that contained controls. The text fields’ values were lost, I don’t know why!! Any ideas? So I decided to resize the parents too and then restore them.
  4. When the control's length is longer than the page’s length, there will be more than one page to print. So I store the printed length in a private field, and when there will be more than one page, I put the area to be printed on the current page in another bitmap, then print the second one. Refer to the PrintPage event handler in the code.
  5. Also, when printing long tables, lists or DataGrids over more than one page, it’s quite likely that a row may be separated on two pages making its data unreadable. So as a simple solution, I added a RepeatArea property, which is an area to be reprinted on the next page. So if half of the row is printed on the end of a page, it will be reprinted fully on the next. The RepeatArea is modifiable. If you have brighter ideas to solve this problem, I’d be happy to add them to the component.
  6. If you revise the source code, you will notice that I used a recursive method to access all the nodes of a TreeView. You call the method from a foreach loop, and apply another foreach loop inside the method to recall itself. My method is named EnumNodes.

  7. I used the GetType().AssemblyQualifiedName to identify the control’s type. Also, this will identify controls inherited from it as it will also contain its base control name. For example:
    if (m_ctrl.GetType().AssemblyQualifiedName.IndexOf("TreeView") >= 0)

    The if statement will be true if the control is or inherited from the TreeView control.

  8. When trying to calculate the size of special controls, currently TreeViews, ListViews, and Forms, I enumerate their elements, Nodes, Items, and Controls respectively, get their bounds, and get the maximum Bounds.Right and Bounds.Bottom as the desired width and height, after assigning a margin, of course.


I hope that I explained how to use the component well, and that it will help you. I wanted to go through the code in the article, but I believe it’s a bit large ad unnecessary. I added comments to the code, maybe it’ll help. If anybody has any ideas, suggestions, or has discovered any bugs, I’ll be eagerly waiting for your posts.

Thank you for taking the time to read this article.


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

Written By
Egypt Egypt
This member has not yet provided a Biography. Assume it's interesting and varied, and probably something to do with programming.

Comments and Discussions

GeneralMy vote of 5 Pin
Manoj Kumar Choubey16-Feb-12 1:59
professionalManoj Kumar Choubey16-Feb-12 1:59 
QuestionCode Errors while printing / preview Pin
Mendor8114-Sep-11 22:58
professionalMendor8114-Sep-11 22:58 
GeneralMy vote of 3 Pin
shareque5-May-11 15:25
shareque5-May-11 15:25 
GeneralYou are a life saver. Pin
stephenaidoo24-Apr-11 0:22
stephenaidoo24-Apr-11 0:22 
GeneralMy vote of 5 Pin
Tim Oakeley2-Jan-11 21:10
Tim Oakeley2-Jan-11 21:10 
GeneralMy vote of 5 Pin
Md Athaulla7-Oct-10 20:30
Md Athaulla7-Oct-10 20:30 
GeneralMy vote of 5 Pin
Richard Page5-Oct-10 23:46
Richard Page5-Oct-10 23:46 
QuestionHow to Print in Landscape??? Pin
dmofo22-Mar-10 6:11
dmofo22-Mar-10 6:11 
AnswerNEVERMIND - Re: How to Print in Landscape??? Pin
dmofo22-Mar-10 7:54
dmofo22-Mar-10 7:54 
GeneralBug in ControlPrint_PrintPage Pin
BOWLINGBALL23-Feb-10 5:23
BOWLINGBALL23-Feb-10 5:23 
Questionhow can i print using C# Pin
smiley_jatin9-Aug-09 20:12
smiley_jatin9-Aug-09 20:12 
AnswerRe: how can i print using C# Pin
Nader Elshehabi10-Aug-09 2:22
Nader Elshehabi10-Aug-09 2:22 
GeneralProblem printing panel - Misaligned controls in image Pin
Jason_H18-May-09 15:30
Jason_H18-May-09 15:30 
Questionprint preview Pin
en.Mahdi21-Apr-09 2:38
en.Mahdi21-Apr-09 2:38 
AnswerRe: print preview Pin
Nader Elshehabi21-Apr-09 3:22
Nader Elshehabi21-Apr-09 3:22 

I've pointed that out in the introduction section. The class is inherited from PrintDocument class. You simply:
1- instantiate a PrintPreviewDialog object.
2- prinPreviewDialog1.Document = (PrintDocument)m_print;
In VB I think you cast using the AS keyword. like prinPreviewDialog1.Document = m_print AS PrintDocument;

Then use the PrintPreviewDialog.Show() method.

Does that solve your problem?

RegardsRose | [Rose]

AnswerRe: print preview Pin
en.Mahdi13-May-09 0:25
en.Mahdi13-May-09 0:25 
GeneralRe: print preview Pin
Nader Elshehabi13-May-09 0:31
Nader Elshehabi13-May-09 0:31 
QuestionRe: print preview Pin
bsjaffer23-Mar-10 20:44
bsjaffer23-Mar-10 20:44 
AnswerRe: print preview Pin
Nader Elshehabi25-Mar-10 5:27
Nader Elshehabi25-Mar-10 5:27 
GeneralLicensing inquiry Pin
2twotango9-Feb-09 10:15
2twotango9-Feb-09 10:15 
GeneralRe: Licensing inquiry Pin
Nader Elshehabi9-Feb-09 11:59
Nader Elshehabi9-Feb-09 11:59 
GeneralBug in source code? In GetBitMap() Pin
roncresswell12-Jan-09 13:43
roncresswell12-Jan-09 13:43 
GeneralRe: Bug in source code? In GetBitMap() Pin
BOWLINGBALL23-Feb-10 4:51
BOWLINGBALL23-Feb-10 4:51 
GeneralRe: Bug in source code? In GetBitMap() Pin
BOWLINGBALL23-Feb-10 5:22
BOWLINGBALL23-Feb-10 5:22 
GeneralRe: Bug in source code? In GetBitMap() Pin
khokon7717-Jul-12 18:47
khokon7717-Jul-12 18:47 

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.