PrintDocument.PrintPage Event (System.Drawing.Printing)

PrintPage Event

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

PrintDocument..::.PrintPage Event

Updated: November 2007

Occurs when the output to print for the current page is needed.

Namespace: System.Drawing.Printing
Assembly: System.Drawing (in System.Drawing.dll)

Syntax

Visual Basic (Declaration)

Public Event PrintPage As PrintPageEventHandler

Visual Basic (Usage)

Dim instance As PrintDocument
Dim handler As PrintPageEventHandler

AddHandler instance.PrintPage, handler

public event PrintPageEventHandler PrintPage

Visual C++

public:
 event PrintPageEventHandler^ PrintPage {
    void add (PrintPageEventHandler^ value);
    void remove (PrintPageEventHandler^ value);
}

/** @event */
public void add_PrintPage (PrintPageEventHandler value)
/** @event */
public void remove_PrintPage (PrintPageEventHandler value)

JScript

JScript does not support events.

Remarks

To specify the output to print, use the Graphics included in the PrintPageEventArgs. For example, to specify a line of text that should be printed, draw the text using the Graphics..::.DrawString method.

In addition to specifying the output, you can indicate if there are additional pages to print by setting the PrintPageEventArgs..::.HasMorePages property to true. The default is false, which indicates that there are no more pages to print. Individual page settings can also be modified through the PageSettings and the print job can be canceled by setting the PrintPageEventArgs..::.Cancel property to true. To print each page of a document using different page settings, handle the QueryPageSettings event.

To associate the event with your event handler, add an instance of the PrintPageEventHandler delegate to the event. The event handler is called whenever the event occurs. For more information about handling events with delegates, see Events and Delegates.

Examples

The following code example demonstrates handling the PrintPage event.

Use the System.Drawing, System.Drawing.Printing, and System.IO namespaces for this example.

Visual Basic

Imports System
Imports System.IO
Imports System.Drawing
Imports System.Drawing.Printing
Imports System.Windows.Forms

Public Class PrintingExample
    Inherits System.Windows.Forms.Form
    Private components As System.ComponentModel.Container
    Private printButton As System.Windows.Forms.Button
    Private printFont As Font
    Private streamToPrint As StreamReader

    Public Sub New()
        ' The Windows Forms Designer requires the following call.
        InitializeComponent()
    End Sub    

    ' The Click event is raised when the user clicks the Print button.
    Private Sub printButton_Click(sender As Object, e As EventArgs)
        Try
            streamToPrint = New StreamReader("C:\My Documents\MyFile.txt")
            Try
                printFont = New Font("Arial", 10)
                Dim pd As New PrintDocument()
                AddHandler pd.PrintPage, AddressOf Me.pd_PrintPage
                pd.Print()
            Finally
                streamToPrint.Close()
            End Try
        Catch ex As Exception
            MessageBox.Show(ex.Message)
        End Try
    End Sub    

    ' The PrintPage event is raised for each page to be printed.
    Private Sub pd_PrintPage(sender As Object, ev As PrintPageEventArgs)
        Dim linesPerPage As Single = 0
        Dim yPos As Single = 0
        Dim count As Integer = 0
        Dim leftMargin As Single = ev.MarginBounds.Left
        Dim topMargin As Single = ev.MarginBounds.Top
        Dim line As String = Nothing

        ' Calculate the number of lines per page.
        linesPerPage = ev.MarginBounds.Height / printFont.GetHeight(ev.Graphics)

        ' Print each line of the file.
        While count < linesPerPage
            line = streamToPrint.ReadLine()
            If line Is Nothing Then
                Exit While
            End If      
            yPos = topMargin + count * printFont.GetHeight(ev.Graphics)
            ev.Graphics.DrawString(line, printFont, Brushes.Black, leftMargin, yPos, New StringFormat())
            count += 1
        End While

        ' If more lines exist, print another page.
        If (line IsNot Nothing) Then
            ev.HasMorePages = True
        Else
            ev.HasMorePages = False
        End If
    End Sub


    ' The Windows Forms Designer requires the following procedure.
    Private Sub InitializeComponent()
        Me.components = New System.ComponentModel.Container()
        Me.printButton = New System.Windows.Forms.Button()

        Me.ClientSize = New System.Drawing.Size(504, 381)
        Me.Text = "Print Example"

        printButton.ImageAlign = System.Drawing.ContentAlignment.MiddleLeft
        printButton.Location = New System.Drawing.Point(32, 110)
        printButton.FlatStyle = System.Windows.Forms.FlatStyle.Flat
        printButton.TabIndex = 0
        printButton.Text = "Print the file."
        printButton.Size = New System.Drawing.Size(136, 40)
        AddHandler printButton.Click, AddressOf printButton_Click

        Me.Controls.Add(printButton)
    End Sub 

    ' This is the main entry point for the application.    
    Public Shared Sub Main()
        Application.Run(New PrintingExample())
    End Sub

End Class

using System;
using System.IO;
using System.Drawing;
using System.Drawing.Printing;
using System.Windows.Forms;


 public class PrintingExample : System.Windows.Forms.Form 
 {
     private System.ComponentModel.Container components;
     private System.Windows.Forms.Button printButton;
     private Font printFont;
     private StreamReader streamToPrint;

    public PrintingExample() : base() 
    {
       // The Windows Forms Designer requires the following call.
       InitializeComponent();
    }

    // The Click event is raised when the user clicks the Print button.
    private void printButton_Click(object sender, EventArgs e) 
    {
       try 
       {
           streamToPrint = new StreamReader
              ("C:\\My Documents\\MyFile.txt");
           try 
           {
              printFont = new Font("Arial", 10);
              PrintDocument pd = new PrintDocument();
              pd.PrintPage += new PrintPageEventHandler
                 (this.pd_PrintPage);
              pd.Print();
           }  
           finally 
           {
              streamToPrint.Close();
           }
       }  
       catch(Exception ex) 
       {
           MessageBox.Show(ex.Message);
       }
    }

    // The PrintPage event is raised for each page to be printed.
    private void pd_PrintPage(object sender, PrintPageEventArgs ev) 
    {
       float linesPerPage = 0;
       float yPos = 0;
       int count = 0;
       float leftMargin = ev.MarginBounds.Left;
       float topMargin = ev.MarginBounds.Top;
       string line = null;

       // Calculate the number of lines per page.
       linesPerPage = ev.MarginBounds.Height / 
          printFont.GetHeight(ev.Graphics);

       // Print each line of the file.
       while(count < linesPerPage && 
          ((line=streamToPrint.ReadLine()) != null)) 
       {
          yPos = topMargin + (count * 
             printFont.GetHeight(ev.Graphics));
          ev.Graphics.DrawString(line, printFont, Brushes.Black, 
             leftMargin, yPos, new StringFormat());
          count++;
       }

       // If more lines exist, print another page.
       if(line != null)
          ev.HasMorePages = true;
       else
          ev.HasMorePages = false;
    }


    // The Windows Forms Designer requires the following procedure.
    private void InitializeComponent() 
    {
       this.components = new System.ComponentModel.Container();
       this.printButton = new System.Windows.Forms.Button();

       this.ClientSize = new System.Drawing.Size(504, 381);
       this.Text = "Print Example";

       printButton.ImageAlign = 
          System.Drawing.ContentAlignment.MiddleLeft;
       printButton.Location = new System.Drawing.Point(32, 110);
       printButton.FlatStyle = System.Windows.Forms.FlatStyle.Flat;
       printButton.TabIndex = 0;
       printButton.Text = "Print the file.";
       printButton.Size = new System.Drawing.Size(136, 40);
       printButton.Click += new System.EventHandler(printButton_Click);

       this.Controls.Add(printButton);
    }

    // This is the main entry point for the application.
    public static void Main(string[] args) 
    {
       Application.Run(new PrintingExample());
    }
 }

Visual C++

#using <System.dll>
#using <System.Windows.Forms.dll>
#using <System.Drawing.dll>

using namespace System;
using namespace System::IO;
using namespace System::Drawing;
using namespace System::Drawing::Printing;
using namespace System::Windows::Forms;

public ref class PrintingExample: public System::Windows::Forms::Form
{
private:
   System::ComponentModel::Container^ components;
   System::Windows::Forms::Button^ printButton;
   System::Drawing::Font^ printFont;
   StreamReader^ streamToPrint;

public:
   PrintingExample()
      : Form()
   {

      // The Windows Forms Designer requires the following call.
      InitializeComponent();
   }


private:

   // The Click event is raised when the user clicks the Print button.
   void printButton_Click( Object^ /*sender*/, EventArgs^ /*e*/ )
   {
      try
      {
         streamToPrint = gcnew StreamReader( "C:\\My Documents\\MyFile.txt" );
         try
         {
            printFont = gcnew System::Drawing::Font( "Arial",10 );
            PrintDocument^ pd = gcnew PrintDocument;
            pd->PrintPage += gcnew PrintPageEventHandler( this, &PrintingExample::pd_PrintPage );
            pd->Print();
         }
         finally
         {
            streamToPrint->Close();
         }

      }
      catch ( Exception^ ex ) 
      {
         MessageBox::Show( ex->Message );
      }

   }


   // The PrintPage event is raised for each page to be printed.
   void pd_PrintPage( Object^ /*sender*/, PrintPageEventArgs^ ev )
   {
      float linesPerPage = 0;
      float yPos = 0;
      int count = 0;
      float leftMargin = (float)ev->MarginBounds.Left;
      float topMargin = (float)ev->MarginBounds.Top;
      String^ line = nullptr;

      // Calculate the number of lines per page.
      linesPerPage = ev->MarginBounds.Height / printFont->GetHeight( ev->Graphics );

      // Print each line of the file.
      while ( count < linesPerPage && ((line = streamToPrint->ReadLine()) != nullptr) )
      {
         yPos = topMargin + (count * printFont->GetHeight( ev->Graphics ));
         ev->Graphics->DrawString( line, printFont, Brushes::Black, leftMargin, yPos, gcnew StringFormat );
         count++;
      }


      // If more lines exist, print another page.
      if ( line != nullptr )
            ev->HasMorePages = true;
      else
            ev->HasMorePages = false;
   }


   // The Windows Forms Designer requires the following procedure.
   void InitializeComponent()
   {
      this->components = gcnew System::ComponentModel::Container;
      this->printButton = gcnew System::Windows::Forms::Button;
      this->ClientSize = System::Drawing::Size( 504, 381 );
      this->Text = "Print Example";
      printButton->ImageAlign = System::Drawing::ContentAlignment::MiddleLeft;
      printButton->Location = System::Drawing::Point( 32, 110 );
      printButton->FlatStyle = System::Windows::Forms::FlatStyle::Flat;
      printButton->TabIndex = 0;
      printButton->Text = "Print the file.";
      printButton->Size = System::Drawing::Size( 136, 40 );
      printButton->Click += gcnew System::EventHandler( this, &PrintingExample::printButton_Click );
      this->Controls->Add( printButton );
   }

};


// This is the main entry point for the application.
int main()
{
   Application::Run( gcnew PrintingExample );
}

import System.*;
import System.IO.*;
import System.Drawing.*;
import System.Drawing.Printing.*;
import System.Windows.Forms.*;


public class PrintingExample extends System.Windows.Forms.Form
{
    private System.ComponentModel.Container components;
    private System.Windows.Forms.Button printButton;
    private Font printFont;
    private StreamReader streamToPrint;

    public PrintingExample()
    {
        // The Windows Forms Designer requires the following call.
        InitializeComponent();
    } //PrintingExample

    // The Click event is raised when the user clicks the Print button.
    private void printButton_Click(Object sender, EventArgs e)
    {
        try {
            streamToPrint = new StreamReader("C:\\My Documents\\MyFile.txt");
            try {
                printFont = new Font("Arial", 10);
                PrintDocument pd = new PrintDocument();
                pd.add_PrintPage(new PrintPageEventHandler(this.pd_PrintPage));
                pd.Print();
            }
            finally {
                streamToPrint.Close();
            }
        }
        catch (System.Exception ex) {
            MessageBox.Show(ex.get_Message());
        }
    } //printButton_Click

    // The PrintPage event is raised for each page to be printed.
    private void pd_PrintPage(Object sender, PrintPageEventArgs ev)
    {
        float linesPerPage = 0;
        float yPos = 0;
        int count = 0;
        float leftMargin = ev.get_MarginBounds().get_Left();
        float topMargin = ev.get_MarginBounds().get_Top();
        String line = null;

        // Calculate the number of lines per page.
        linesPerPage = ev.get_MarginBounds().get_Height() / 
            printFont.GetHeight(ev.get_Graphics());

        // Print each line of the file.
        while ((count < linesPerPage && 
            (line = streamToPrint.ReadLine()) != null)) {
            yPos = topMargin + count * printFont.GetHeight(ev.get_Graphics());
            ev.get_Graphics().DrawString(line, printFont, Brushes.get_Black(),
                leftMargin, yPos, new StringFormat());
            count++;
        }

        // If more lines exist, print another page.
        if (line != null) {
            ev.set_HasMorePages(true);
        }
        else {
            ev.set_HasMorePages(false);
        }
    } //pd_PrintPage

    // The Windows Forms Designer requires the following procedure.
    private void InitializeComponent()
    {
        this.components = new System.ComponentModel.Container();
        this.printButton = new System.Windows.Forms.Button();
        this.set_ClientSize(new System.Drawing.Size(504, 381));
        this.set_Text("Print Example");
        printButton.set_ImageAlign(System.Drawing.ContentAlignment.MiddleLeft);
        printButton.set_Location(new System.Drawing.Point(32, 110));
        printButton.set_FlatStyle(System.Windows.Forms.FlatStyle.Flat);
        printButton.set_TabIndex(0);
        printButton.set_Text("Print the file.");
        printButton.set_Size(new System.Drawing.Size(136, 40));
        printButton.add_Click(new System.EventHandler(printButton_Click));
        this.get_Controls().Add(printButton);
    } //InitializeComponent

    // This is the main entry point for the application.
    public static void main(String[] args)
    {
        Application.Run(new PrintingExample());
    } //main
} //PrintingExample

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information