Export (0) Print
Expand All

PrintDocument Class

Defines a reusable object that sends output to a printer, when printing from a Windows Forms application.

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

public ref class PrintDocument : public Component
public class PrintDocument extends Component
public class PrintDocument extends Component
Not applicable.

Typically, you create an instance of the PrintDocument class, set the properties that describe how to print, and call the Print method to start the printing process. Handle the PrintPage event where you specify the output to print, by using the Graphics included in the PrintPageEventArgs.

For more information about printing from a Windows Form application, see the System.Drawing.Printing namespace overview. If you wish to print from a Windows Presentation Foundation application, see the System.Printing namespace.

The following code example prints the file named C:\My Documents\MyFile.txt on the default printer. To run the example, change the path to the file you want to print. You can also modify the InitializeComponent procedure through the Windows Forms Designer.

NoteNote:

The example requires that each line fits within the page width.

Use the System.ComponentModel, System.Windows.Forms, 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
{
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

System.Object
   System.MarshalByRefObject
     System.ComponentModel.Component
      System.Drawing.Printing.PrintDocument

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

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

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

Community Additions

ADD
Show:
© 2014 Microsoft