PrintDocument::PrintPage Event


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

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

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

To specify the output to print, use the Graphics property of 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 Handling and Raising Events.

The following code example demonstrates handling the PrintPage event.

For another example, see How to: Print a Multi-Page Text File in Windows Forms.

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

#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
   System::ComponentModel::Container^ components;
   System::Windows::Forms::Button^ printButton;
   System::Drawing::Font^ printFont;
   StreamReader^ streamToPrint;

      : Form()

      // The Windows Forms Designer requires the following call.


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

      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 );

      // If more lines exist, print another page.
      if ( line != nullptr )
            ev->HasMorePages = true;
            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 );

.NET Framework
Available since 1.1
Return to top