DataGridPrinter - A class to print data grid in a nicely formatted way

[Merrion]

The DataGridPrinter is a class that you can add to your applications to print (or preview) a data grid (or DataGridView) in a nciely formatted way.

The class allows you to control settings such as the header height, footer height, header font, grid font, footer font, grid line colour, header border colour, inter section spacing and so on.

The class takes care of putting the grid headings at the top of each page and generating a new page if the grid rows exceed one page etc.

Any comments or suggestions?

[Merrion]

I have submitted an article explaining the what and how of this class here

[dinosaur_uk]

I have used this, and this is fantastic....

but can we print in landscape?

[Merrion]

Yes - if you change the page layout (in print preview) then the columns and rows get recalculated to fit the page 'automatically'...

New version (updated with the article) supports background colours for the grid elements.

Am working on some more defect fixes and enhancements and will post the next release on this thread.

[Merrion]

New version - now has a property "PagesAcross" which allows you to overflow the grid across more than one page across...(users of excel know all about this functionality)

[Merrion]

Option Strict version attached.

(and it also prints all columns on the one page.... )

[skea]

Nice Sample Merrion.
How could this work under Datagridview. I have tried to convert everything named datagrid to datagridview.The page setup works fine, but the print gives me errors in the functions
getColumnHeadingText(),MappedColumnToBaseColumn
Over datagrid's tablestyles and gridcolumnstyles

[Merrion]

It will need to be rewritten to work for DataGridView which I will add to the list to do - I find it difficult to keep up with all the new tricks

[skea]

Here is a link to print a datagridview, but i have so far failed to convert it into vb.net.
Will some one try it out!
http://www.codeproject.com/csharp/da...iewprinter.asp

[skea]

Thanks to Berthold Simon, who converted the C# code.

[am_binu]

Thank You Merrion for the DataGridPrinter Class. How can we hide the GridLines.

Regards,
Binu

[Merrion]

To hide the grid lines set .Gridpen = New Pen(Color.Transparent)

[am_binu]

Sir,

Thank you for replying me. I am a beginner for vb.net. Pls tell me how to set the column width in DatagridPrinter.

Regards,
Binu

[Merrion]

Column width is proportional to the column widths on the source datagrid control...

[am_binu]

Sir,

The DataGridPrinter Very much helped me in my work.

In DataGridPrinter the Column width is adjusting with the Page width. So the Column Data is Printing like 'Customer N...'. Pls help me to avoid this.

[Merrion]

Column width is in the same proportions as the source data grid - if you make the column wider on the source grid it becomes wider on the print/preview grid.

Column width is proportional to the .pagesAcross number - the more pages across your grid is set to, the wider each column can be made.

So - increase your pages across setting and/or alter the column widths in the source data grid.

[simonalexander2005]

I downloaded the file from the post with:

Thanks to Berthold Simon, who converted the C# code.

.

how do i use this in my project? i have a datagridview and a button. What do i need to do so that when the button is pressed the datagridview is printed? i.e how do i use what i just downloaded?

[am_binu]

See the below article for a clear idea.

http://www.thecodeproject.com/userit...ridPrinter.asp

[simonalexander2005]

broken link...

[simonalexander2005]

am i doing this right?:

1. download the zip file
2. add the .vb file to my project
3. use code

Imports PRECIS.DataGridViewPrinter

to import the class to the form im using it in
4. put source code from readme into project:

Private Function SetupThePrinting() As Boolean
        Dim MyPrintDialog As PrintDialog = New PrintDialog()
 
        MyPrintDialog.AllowCurrentPage = False
        MyPrintDialog.AllowPrintToFile = False
        MyPrintDialog.AllowSelection = False
        MyPrintDialog.AllowSomePages = True
        MyPrintDialog.PrintToFile = False
        MyPrintDialog.ShowHelp = False
        MyPrintDialog.ShowNetwork = False
 
        If MyPrintDialog.ShowDialog() <> System.Windows.Forms.DialogResult.OK Then Return False
 
        MyPrintDocument.DocumentName = "Customers Report"
        MyPrintDocument.PrinterSettings = MyPrintDialog.PrinterSettings
        MyPrintDocument.DefaultPageSettings = MyPrintDialog.PrinterSettings.DefaultPageSettings
        MyPrintDocument.DefaultPageSettings.Margins = New Margins(40, 40, 40, 40)
 
       if MessageBox.Show("Do you want the report to be centered on the page", "InvoiceManager - Center on Page", MessageBoxButtons.YesNo, MessageBoxIcon.Question) == DialogResult.Yes then
           MyDataGridViewPrinter = new DataGridViewPrinter(MyDataGridView, MyPrintDocument, true, true, "Customers", new Font("Tahoma", 18, FontStyle.Bold, GraphicsUnit.Point), Color.Black, true)
       else
           MyDataGridViewPrinter = new DataGridViewPrinter(MyDataGridView, MyPrintDocument, false, true, "Customers", new Font("Tahoma", 18, FontStyle.Bold, GraphicsUnit.Point), Color.Black, true)
       end if
 
       Return True
    End Function
 
    Private Sub MyPrintDocument_PrintPage(ByVal sender As Object, ByVal e As System.Drawing.Printing.PrintPageEventArgs) Handles MyPrintDocument.PrintPage
        Dim more As Boolean
 
        Try
            more = MyDataGridViewPrinter.DrawDataGridView(e.Graphics)
            If more Then e.HasMorePages = True
        Catch Ex As Exception
            MessageBox.Show(Ex.Message & vbCrLf & Ex.StackTrace, MyConstants.CaptionFehler, MessageBoxButtons.OK, MessageBoxIcon.Error)
        End Try
    End Sub
 
    ' The Print Preview Button
    Private Sub btnPrintPreview_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles btnPrintPreview.Click
        If SetupThePrinting() Then
            Dim MyPrintPreviewDialog As PrintPreviewDialog = New PrintPreviewDialog()
            MyPrintPreviewDialog.Document = MyPrintDocument
            MyPrintPreviewDialog.ShowDialog()
        End If
    End Sub
 
    ' The Print Button
    Private Sub btnPrint_Click(ByVal sender As Object, ByVal e As System.EventArgs) Handles btnPrint.Click
    if SetupThePrinting() then MyPrintDocument.Print
    end SUb

If this is right, i am getting several errors.
most say that MyPrintDocument and MyDataGridViewPrinter are not declared, so i have put

Dim MyPrintDocument As PrintDocument
    Dim MyDataGridViewPrinter As DataGridViewPrinter

at the top of the form. is this correct?

also, in the line

MessageBox.Show(Ex.Message & vbCrLf & Ex.StackTrace, MyConstants.CaptionFehler, MessageBoxButtons.OK, MessageBoxIcon.Error)

, i am getting the error that MyConstants is not declared...

I am also getting Error 1 Handles clause requires a WithEvents variable defined in the containing type or one of its base types., relating to the line

Private Sub MyPrintDocument_PrintPage(ByVal sender As Object, ByVal e As System.Drawing.Printing.PrintPageEventArgs) Handles MyPrintDocument.PrintPage

, and the MyPrintDocument from MyPrintDocument.PrintPage is underlined...

any help on these would be greatfully recieved, or, if i am not doing this right, the correct way would also be helpful. ta.

[am_binu]

http://www.codeproject.com/vb/net/datagridprinter.asp

[simonalexander2005]

thats a totally different piece of coding, and it's for datagrids, not datagridviews - i'm using vb 2005...

[maged]

very powerful

thank you , i will sure rate u for it

[am_binu]

If GridPrinter Is Nothing Then
GridPrinter = New DataGridPrinter(Me.dgReport)
End If
With (GridPrinter)
.HeaderText = "Stock Report"
.HeaderHeightPercent = 5
.FooterHeightPercent = 0
.HeaderPen = New Pen(Color.Transparent)
.GridPen = New Pen(Color.Black)
End With

With Me.PrintPreviewDialog1
.Document = GridPrinter.PrintDocument
If .ShowDialog = DialogResult.OK Then
GridPrinter.Print()
End If
End With


It Shows Following Exception in the Line "If .ShowDialog = DialogResult.OK Then"

************** Exception Text **************
System.InvalidCastException: Specified cast is not valid.
at System.Windows.Forms.PrintPreviewControl.CalculatePageInfo()
at System.Windows.Forms.Control.InvokeMarshaledCallbacks()

Pls tell me how to solve this Problem.

[maged]

i had also issues when i try to print datagird with custom column styles.

it doesnt print and raises an exception , i dont have time to study well though

[Merrion]

You need to put a breakpoint in the control's PrintPage event and step through what it is doing as the error is occuring there somewhere....let me know when you find the line that is the underlying cause of the error.

[am_binu]

Sir,
Its not showing the print preview also. but it works in my last finished project.
Pls help me

[frosty16]

is the datagridprinter compatable with VS 2005 Express edition?
its just i am tryin to use it in my project adn i have having difficulty as it is saying that datagrid isnt defined and so when i look at the code provided it isnt but if you hover over the text it says it is defined as 'DataGridPrinter.DataGridPrinter' so if i declare this manually it says in the decleratioin that 'DataGridPrinter.DataGridPrinter' isnt defined.
Can someone tell me where i am going wrong

[Merrion]

It was written using VB2005 and it does not use anything that is not present in the express edition. Make sure you are opening the solution file (*.sln) not one of the projects (*.vbp) as in the latter case the references might not be loaded...

[funch]

Hi,

Thank you for the DataGridView Printer, awesome work!!!

I too had some problems getting it to work, but it was minor stuff so I posted the code below (You still need to add the Class to your project):

Thank you!
Funch

Public Class Form1

Dim cnStr As String = "Provider=SQLOLEDB;Initial Catalog=Reporting;Data Source=ncso-exch;"
Dim myDataGridViewPrinter

Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
End Sub

Private Sub Button1_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
'DG.Rows.Clear()
Dim rs As New ADODB.Recordset
Dim strSQL As String = "select * from Userdata order by username"
rs.Open(strSQL, cnStr)

While Not rs.EOF
DG.Rows.Add()
DG.Rows(DG.Rows.Count - 1).Cells(0).Value = rs.Fields.Item("Username").Value.ToString.Replace("NCSO\", "")
DG.Rows(DG.Rows.Count - 1).Cells(1).Value = rs.Fields.Item("MachineName").Value.ToString
DG.Rows(DG.Rows.Count - 1).Cells(2).Value = rs.Fields.Item("IPAddress").Value.ToString
DG.Rows(DG.Rows.Count - 1).Cells(3).Value = rs.Fields.Item("LastRun").Value.ToString
DG.Rows(DG.Rows.Count - 1).Cells(4).Value = rs.Fields.Item("Version").Value.ToString
DG.Rows(DG.Rows.Count - 1).Cells(5).Value = rs.Fields.Item("CMVersion").Value.ToString
DG.Rows(DG.Rows.Count - 1).Cells(6).Value = rs.Fields.Item("DBServer").Value.ToString
rs.MoveNext()
End While
rs.Close()
End Sub

Private Sub Button3_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button3.Click
End
End Sub

Private Sub Button2_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button2.Click
If SetupThePrinting() Then MyPrintDocument.Print()
End Sub

Private Function SetupThePrinting() As Boolean
Dim MyPrintDialog As PrintDialog = New PrintDialog()

MyPrintDialog.AllowCurrentPage = False
MyPrintDialog.AllowPrintToFile = False
MyPrintDialog.AllowSelection = False
MyPrintDialog.AllowSomePages = True
MyPrintDialog.PrintToFile = False
MyPrintDialog.ShowHelp = False
MyPrintDialog.ShowNetwork = False

If MyPrintDialog.ShowDialog() <> System.Windows.Forms.DialogResult.OK Then Return False

MyPrintDocument.DocumentName = "Customers Report"
MyPrintDocument.PrinterSettings = MyPrintDialog.PrinterSettings
MyPrintDocument.DefaultPageSettings = MyPrintDialog.PrinterSettings.DefaultPageSettings
'MyPrintDocument.DefaultPageSettings.Margins = New Margins(40, 40, 40, 40)

If MessageBox.Show("Do you want the report to be centered on the page", "InvoiceManager - Center on Page", MessageBoxButtons.YesNo, MessageBoxIcon.Question) = DialogResult.Yes Then
MyDataGridViewPrinter = New DataGridViewPrinter(DG, MyPrintDocument, True, True, "Customers", New Font("Tahoma", 18, FontStyle.Bold, GraphicsUnit.Point), Color.Black, True)
Else
myDataGridViewPrinter = New DataGridViewPrinter(DG, MyPrintDocument, False, True, "Customers", New Font("Tahoma", 18, FontStyle.Bold, GraphicsUnit.Point), Color.Black, True)
End If

Return True
End Function

Private Sub MyPrintDocument_PrintPage(ByVal sender As Object, ByVal e As System.Drawing.Printing.PrintPageEventArgs) Handles MyPrintDocument.PrintPage
Dim more As Boolean

Try
more = MyDataGridViewPrinter.DrawDataGridView(e.Graphics)
If more Then e.HasMorePages = True
Catch Ex As Exception
MessageBox.Show(Ex.Message & vbCrLf & Ex.StackTrace, "caption", MessageBoxButtons.OK, MessageBoxIcon.Error)
End Try
End Sub

Private Sub btnPrintPreview_Click_1(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnPrintPreview.Click
If SetupThePrinting() Then
Dim MyPrintPreviewDialog As PrintPreviewDialog = New PrintPreviewDialog()
MyPrintPreviewDialog.Document = MyPrintDocument
MyPrintPreviewDialog.ShowDialog()
End If
End Sub
End Class

[kryles]

I tried using the files from the original post in order to print the output of my datagrid, but I get:

System.InvalidCastException: Specified cast is not valid

This is the line specified in the DataGrid class

For nextLine = _CurrentPrintGridLine To Min((_CurrentPrintGridLine + RowsPerPage(_PrintFont, e.Graphics)), CType(_DataGrid.DataSource, System.Data.DataTable).DefaultView.Count)

This is the code I am using:

Private Sub btnPrint_Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles btnPrint.Click

'Button that prints the datagrid
        If GridPrinter Is Nothing Then
            GridPrinter = New DataGridPrinter(Me.dgInventory)
        End If

        Try
            With Me.printDia  'printDia is PrintPreviewDialogue added manually
                .Document = GridPrinter.PrintDocument
                If .ShowDialog = DialogResult.OK Then
                    GridPrinter.Print()
                End If
            End With
        Catch ex As System.InvalidCastException
            MsgBox(Convert.ToString(ex))
        End Try

    End Sub

 Private Sub frmInvReport_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load

        'Create connection to Database
        Dim connStr As String
        Dim dbObjConn As New OleDb.OleDbConnection
        connStr = "Provider=Microsoft.Jet.OLEDB.4.0;" & _
            "Data Source=InventoryManagement.mdb;"
        dbObjConn.ConnectionString = connStr

        'create SQL statement
        Dim selectString As String = "Select * from Products"

        'create DataAdapter
        Dim sqlDA As New OleDb.OleDbDataAdapter(selectString, connStr)

        'Fill dataset
        Try
            dbObjConn.Open()

            Dim ds As New Data.DataSet
            sqlDA.Fill(ds, "Products")
            dgInventory.CaptionText = "Inventory Report"
            dgInventory.DataSource = ds.DefaultViewManager
        Catch ex As OleDb.OleDbException
            MsgBox(Convert.ToString(ex))
        Finally
            dbObjConn.Close()
        End Try
    End Sub

So the datagrid is filled in properly, but when I try printing I get the cast error. If you need the whole project or more information please let me know.
Thanks

[Merrion]

Yup - it is because the data source of your grid is a DataSet rather than a DataTable --- the code needs to be altered to cater for this possibility...

[kryles]

Well, I started using a dataTable but the examples I was lookign at all end up binding using a dataSet in the end. I'll show you the example I was following to do a dataTable instead.

 Dim Table1 As DataTable
            Table1 = New DataTable("Products")
            Dim Row1 As DataRow
            Dim description As DataColumn = New DataColumn("description")
            description.DataType = System.Type.GetType("System.String")
            Table1.Columns.Add("description")

            Row1 = Table1.NewRow()
            'declaring a new row
            Row1.Item("description") = "blah blah blah"
            Table1.Rows.Add(Row1)

so far so good it seems. Then the example finishes off by doing this

           Dim ds As New Data.DataSet
            ds.Tables.Add(Table1)
            dgInventory.SetDataBinding(ds, "Products")

which basically brings me to the exact same problem lol. Can someone kinda guide me in the right direction? *blushes*

[kryles]

Gah nvm, I just did

dgInventory.DataSource = Table1

and voila, works. Thanks a lot Merrion

[goingcrazy]

Is it possible to use the zipped code in vb.net 2003 for datagrids?

[jeric_mandrake]

How can i set the paper size?
I mean, make the paper half of its height?


Im using the datagridview printer class
thanks.

[Merrion]

Yet another version.

New in this release:
(1) Can work with the DataGrid or DataGridView control
(2) Raises an event to allow custom colouring of a data grid cell e.g.:-

    Private Sub GridPrinter_QueryCellFormat(ByVal sender As Object, ByVal e As QueryCellFormatEventArgs) Handles GridPrinter.QueryCellFormat

        '\\ Top 2 clubs go up
        If e.RowNumber <= 2 Then
            e.BackgroundColour = Brushes.AliceBlue
        End If

        If e.ColumnNumber = 0 Then
            If e.CellData.ToString = "Grimsby" Then
                e.TextColour = Brushes.RoyalBlue
            End If
        End If

        '\\ Bottom 2 columns relegation
        If e.RowNumber >= 23 Then
            e.BackgroundColour = Brushes.LightGray
        End If
    End Sub

(3) Raises an event to allow you to change the actual text in a cell:

    Private Sub GridPrinter_QueryCellData(ByVal sender As Object, ByVal e As QueryCellDataEventArgs) Handles GridPrinter.QueryCellData

        If e.ColumnNumber > 0 And e.CellText = "0" Then
            e.CellText = "Zero"
        End If
    End Sub

[adam.syd]

My mistake, sample can be run from the project file in VS 2005.

Thanks,
Adam.

Hi Merrion,

Latest version appears to be in VS 2008, any chance of getting it in VS 2005?

Cheers,
Adam.

[Merrion]

Oops - because VS2008 is so much nicer a development environment I have been using it for all my code - guess i forgot to roll this one back for "publication"...

[GSIV]

Thanks a lot for sharing this great work, Merrion!

I d/l'd your latest version and got it to work right off!