Printing a datagridview in C# .NET 2.0






4.09/5 (13 votes)
This article demonstrates the printing of a datagridview
Introduction
This article demonstrates printing of a simple datagridview
using the PrintPrintDocument
and PrintPreivew
classes.
Background
Graphics class in C# .NET 2.0.
Using the Code
The best part of .NET is the organization of classes like the PrintDocument
class which is derived from the Printing Class and Printing class is in turn derived from System.Drawing
class which has methods for drawing Shapes, Bitmaps and Text so the same methods can be used by the PrintDocument
Class.
To print a datagridview
, we require a table with rows and columns. A table is nothing but a collection of rectangles as mentioned above. PrintDocument
class supports drawing of shapes, so we can easily draw a rectangle given the parameters. The rectangle method is overloaded. The one in which we are more interested is:
DrawRectangle(Pens p,int x,int y, int width,int height)
where x
and y
are the co-ordinates on the print page in pixel units, the other two parameters specify the width
and height
of the rectangle.
We can specify the co-ordinates, say draw the first rectangle at location 20,20 but how do we get the exact width
and height
of the rectangle? Not to worry! We can get the width
parameter from:
int width=dataGridView1.Columns[0].Width; //Gives the width of first column
and height parameter from:
int height=dataGridView1.Rows[0].Height; //Gives the height of the first Row
At this point, we have gathered all the required information to draw a rectangle but when and where to Draw? PrintDocument
supports an event called PrintPage
which has 2 parameters; the one which we are interested is of type PrintPageEventArgs
which supports drawing of rectangle.
Here's a small snippet:
private void printDocument1_PrintPage
(object sender, System.Drawing.Printing.PrintPageEventArgs e)
{
//Draws a rectangle with same width and height of first column of datagridview.
e.Graphics.DrawRectangle(Pens.Black, 100, 100,
dataGridView1.Columns[0].Width, dataGridView1.Rows[0].Height);
//Fills the above drawn rectangle with a light gray colour just to distinguish the header
e.Graphics.FillRectangle(Brushes.LightGray, new Rectangle
(100, 100, dataGridView1.Columns[0].Width, dataGridView1.Rows[0].Height));
//Draws a text inside the above drawn rectangle whose value is same of the first column.
e.Graphics.DrawString(dataGridView1.Columns[0].HeaderText,
dataGridView1.Font, Brushes.Black, new RectangleF(100, 100,
dataGridView1.Columns[0].Width, dataGridView1.Rows[0].Height), str);
}
Now we are able to draw or say replicate the first column of the datagridview
on the page at location 100,100.
Now let's draw the second column which adjoins the first column horizontally. The position of y co-ordinate remains the same as columns span horizontally but the x position of the second column will change. It will now become 100 + dataGridView1.Columns[0].Width
.
So repeat the above code in the snippet by just changing the x
position of the DrawRectangle
and DrawRectangleF
method respectively. Here's the first one:
e.Graphics.DrawRectangle(Pens.Black, 100 + dataGridView1.Columns[0].Width, 100,
dataGridView1.Columns[1].Width, dataGridView1.Rows[0].Height);
To keep things simple, we will restrict our datagridview
to only 2 columns. Now quickly let us draw the rows one by one by using the same trick as discussed above.
Store the origins(x
and y
) in variables, say x=100
and y=100
.
Also:
width= x + dataGridView1.Columns[0].Width;
height=y;
Before coding, there are few more important points to be discussed.
- We can get the number of Rows in a
datagridview
view by using theRowCount
property. - We need to run a loop to draw all the rows as is in the
datagridveiw
one by one. - We need to check if your table height is exceeding the page height. If it exceeds, then the printing should continue on a new page, before directly printing the row on the new page first it should draw the column headers and continue drawing the row.
- Every time we print a new row, we need to increase the table height (nothing but
y
co-ordinate) byrowheight
and let thex
co-ordinate be at the same position, in our case it's100
, i.e.height+=rowheight;
- When we are printing the cells of a row, we only need to increase the x co-ordinate by
colwidth
each time and let the y co-ordinate(height
) remain stationary, i.e.width += colwidth;
Here's the code snippet
while (i < dataGridView1.Rows.Count)
rowheight=dataGridView1.Rows[i].Height;
colwidth= dataGridView1.Columns[0].Width ; /*the columns width is same for all columns
in our case */
if (height > e.MarginBounds.Height)
{
height = x; //maintains the y co-ordinate
width = y; //maintains the x co-ordinate
e.HasMorePages = true; /*start printing on a new page,setting this property to true
fires PagePrint event */
return;
}
height += rowheight; //increment the y co-ordinate
e.Graphics.DrawRectangle(Pens.Black, x, height,colwidth,rowheight);
e.Graphics.DrawString(dataGridView1.Rows[i].Cells[0].FormattedValue.ToString(),
dataGridView1.Font, Brushes.Black, new RectangleF(x, height, colwidth,rowheight), str);
e.Graphics.DrawRectangle(Pens.Black, y+ colwidth, height, colwidth, rowheight);
e.Graphics.DrawString(dataGridView1.Rows[i].Cells[1].Value.ToString(),
dataGridView1.Font, Brushes.Black, new RectangleF(x+ colwidth,
height, width, rowheight), str);
width += colwidth; //increment the x co- ordinate
i++;
}
Behind the print button, type:
PrintPreviewDialog1.Document=PrintDocument1;
Note: Declare the variable i
as static
or a class level variable:
Cheers!
History
- 6th November, 2009: Initial post