Как: Печать в Windows Forms с помощью предварительного просмотра

Очень часто в программировании Windows Forms, помимо услуг печати, предлагается предварительный просмотр печати. Простой способ добавления служб предварительной версии печати в приложение заключается в использовании элемента управления PrintPreviewDialog в сочетании с логикой обработки событий PrintPage для печати файла.

Предварительный просмотр текстового документа с помощью элемента управления PrintPreviewDialog

1. Добавьте в форму PrintPreviewDialog, PrintDocumentи две строки.

   private PrintPreviewDialog printPreviewDialog1 = new PrintPreviewDialog();
   private PrintDocument printDocument1 = new PrintDocument();
   
   // Declare a string to hold the entire document contents.
   private string documentContents;
   
   // Declare a variable to hold the portion of the document that
   // is not printed.
   private string stringToPrint;
   

   Private printPreviewDialog1 As New PrintPreviewDialog()
   Private WithEvents printDocument1 As New PrintDocument()
   
   ' Declare a string to hold the entire document contents.
   Private documentContents As String
   
   ' Declare a variable to hold the portion of the document that
   ' is not printed.
   Private stringToPrint As String
   

2. Задайте свойству DocumentName документ, который вы хотите распечатать, и откройте и считайте содержимое документа в строку, добавленную вами ранее.

   private void ReadDocument()
   {
       string docName = "testPage.txt";
       string docPath = @"c:\";
       printDocument1.DocumentName = docName;
       using (FileStream stream = new FileStream(docPath + docName, FileMode.Open))
       using (StreamReader reader = new StreamReader(stream))
       {
           documentContents = reader.ReadToEnd();
       }
       stringToPrint = documentContents;
   }
   

   Private Sub ReadDocument() 
       Dim docName As String = "testPage.txt"
       Dim docPath As String = "c:\"
       printDocument1.DocumentName = docName
       Dim stream As New FileStream(docPath + docName, FileMode.Open)
       Try
           Dim reader As New StreamReader(stream)
           Try
               documentContents = reader.ReadToEnd()
           Finally
               reader.Dispose()
           End Try
       Finally
           stream.Dispose()
       End Try
       stringToPrint = documentContents
   
   End Sub
   

3. Как и для печати документа, в обработчике событий PrintPage используйте свойство Graphics класса PrintPageEventArgs и содержимое файла для вычисления строк на страницу и отрисовки содержимого документа. После отрисовки каждой страницы проверьте, является ли она последней, и задайте свойство HasMorePages элемента PrintPageEventArgs соответствующим образом. Событие PrintPage вызывается до тех пор, пока HasMorePages не будет false. После завершения отрисовки документа сбросить строку для отрисовки. Кроме того, убедитесь, что событие PrintPage связано с его методом обработки событий.

   Заметка

   Возможно, вы уже выполнили шаги 2 и 3, если вы реализовали печать в приложении.

   В следующем примере кода обработчик событий используется для печати файла "testPage.txt" в том же шрифте, который используется в форме.

   void printDocument1_PrintPage(object sender, PrintPageEventArgs e)
   {
       int charactersOnPage = 0;
       int linesPerPage = 0;
   
       // Sets the value of charactersOnPage to the number of characters
       // of stringToPrint that will fit within the bounds of the page.
       e.Graphics.MeasureString(stringToPrint, this.Font,
           e.MarginBounds.Size, StringFormat.GenericTypographic,
           out charactersOnPage, out linesPerPage);
   
       // Draws the string within the bounds of the page.
       e.Graphics.DrawString(stringToPrint, this.Font, Brushes.Black,
       e.MarginBounds, StringFormat.GenericTypographic);
   
       // Remove the portion of the string that has been printed.
       stringToPrint = stringToPrint.Substring(charactersOnPage);
   
       // Check to see if more pages are to be printed.
       e.HasMorePages = (stringToPrint.Length > 0);
   
       // If there are no more pages, reset the string to be printed.
       if (!e.HasMorePages)
           stringToPrint = documentContents;
   }
   

   Sub printDocument1_PrintPage(ByVal sender As Object, _
       ByVal e As PrintPageEventArgs) Handles printDocument1.PrintPage
   
       Dim charactersOnPage As Integer = 0
       Dim linesPerPage As Integer = 0
   
       ' Sets the value of charactersOnPage to the number of characters 
       ' of stringToPrint that will fit within the bounds of the page.
       e.Graphics.MeasureString(stringToPrint, Me.Font, e.MarginBounds.Size, _
           StringFormat.GenericTypographic, charactersOnPage, linesPerPage)
   
       ' Draws the string within the bounds of the page.
       e.Graphics.DrawString(stringToPrint, Me.Font, Brushes.Black, _
           e.MarginBounds, StringFormat.GenericTypographic)
   
       ' Remove the portion of the string that has been printed.
       stringToPrint = stringToPrint.Substring(charactersOnPage)
   
       ' Check to see if more pages are to be printed.
       e.HasMorePages = stringToPrint.Length > 0
   
       ' If there are no more pages, reset the string to be printed.
       If Not e.HasMorePages Then
           stringToPrint = documentContents
       End If
   
   End Sub
   

4. Настройте свойство Document элемента управления PrintPreviewDialog на компонент PrintDocument на форме.

   printPreviewDialog1.Document = printDocument1;
   

   printPreviewDialog1.Document = printDocument1
   

5. Вызовите метод ShowDialog в элементе управления PrintPreviewDialog. Обычно вы вызываете ShowDialog из метода обработки событий Click для кнопки. Вызов ShowDialog инициирует событие PrintPage и передает выходные данные в элемент управления PrintPreviewDialog. Когда пользователь щелкает значок печати в диалоговом окне, событие PrintPage возникает снова, отправляя выходные данные на принтер вместо диалогового окна предварительного просмотра. Поэтому строка сбрасывается в конце процесса рендеринга на этапе 3.

   В следующем примере кода показан метод обработки событий Click для кнопки в форме. Этот метод обработки событий вызывает методы для чтения документа и отображения диалогового окна предварительного просмотра печати.

   private void printPreviewButton_Click(object sender, EventArgs e)
   {
       ReadDocument();
       printPreviewDialog1.Document = printDocument1;
   printPreviewDialog1.ShowDialog();
   }
   

   Private Sub printPreviewButton_Click(ByVal sender As Object, _
       ByVal e As EventArgs) Handles printPreviewButton.Click
   
       ReadDocument()
       printPreviewDialog1.Document = printDocument1
       printPreviewDialog1.ShowDialog()
   End Sub
   

Пример

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

namespace PrintPreviewApp
{
    public partial class Form1 : Form
    {
        private Button printPreviewButton;

        private PrintPreviewDialog printPreviewDialog1 = new PrintPreviewDialog();
        private PrintDocument printDocument1 = new PrintDocument();

        // Declare a string to hold the entire document contents.
        private string documentContents;

        // Declare a variable to hold the portion of the document that
        // is not printed.
        private string stringToPrint;

        public Form1()
        {
            this.printPreviewButton = new System.Windows.Forms.Button();
            this.printPreviewButton.Location = new System.Drawing.Point(12, 12);
            this.printPreviewButton.Size = new System.Drawing.Size(125, 23);
            this.printPreviewButton.Text = "Print Preview";
            this.printPreviewButton.Click += new System.EventHandler(this.printPreviewButton_Click);
            this.ClientSize = new System.Drawing.Size(292, 266);
            this.Controls.Add(this.printPreviewButton);
            printDocument1.PrintPage +=
                new PrintPageEventHandler(printDocument1_PrintPage);
        }
        private void ReadDocument()
        {
            string docName = "testPage.txt";
            string docPath = @"c:\";
            printDocument1.DocumentName = docName;
            using (FileStream stream = new FileStream(docPath + docName, FileMode.Open))
            using (StreamReader reader = new StreamReader(stream))
            {
                documentContents = reader.ReadToEnd();
            }
            stringToPrint = documentContents;
        }

        void printDocument1_PrintPage(object sender, PrintPageEventArgs e)
        {
            int charactersOnPage = 0;
            int linesPerPage = 0;

            // Sets the value of charactersOnPage to the number of characters
            // of stringToPrint that will fit within the bounds of the page.
            e.Graphics.MeasureString(stringToPrint, this.Font,
                e.MarginBounds.Size, StringFormat.GenericTypographic,
                out charactersOnPage, out linesPerPage);

            // Draws the string within the bounds of the page.
            e.Graphics.DrawString(stringToPrint, this.Font, Brushes.Black,
            e.MarginBounds, StringFormat.GenericTypographic);

            // Remove the portion of the string that has been printed.
            stringToPrint = stringToPrint.Substring(charactersOnPage);

            // Check to see if more pages are to be printed.
            e.HasMorePages = (stringToPrint.Length > 0);

            // If there are no more pages, reset the string to be printed.
            if (!e.HasMorePages)
                stringToPrint = documentContents;
        }
        private void printPreviewButton_Click(object sender, EventArgs e)
        {
            ReadDocument();
            printPreviewDialog1.Document = printDocument1;
        printPreviewDialog1.ShowDialog();
        }

        [STAThread]
        static void Main()
        {
            Application.EnableVisualStyles();
            Application.SetCompatibleTextRenderingDefault(false);
            Application.Run(new Form1());
        }
    }
}

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



Class Form1
    Inherits Form

    Private WithEvents printPreviewButton As Button
    
    Private printPreviewDialog1 As New PrintPreviewDialog()
    Private WithEvents printDocument1 As New PrintDocument()
    
    ' Declare a string to hold the entire document contents.
    Private documentContents As String
    
    ' Declare a variable to hold the portion of the document that
    ' is not printed.
    Private stringToPrint As String

    Public Sub New() 
        Me.printPreviewButton = New System.Windows.Forms.Button()
        Me.printPreviewButton.Location = New System.Drawing.Point(12, 12)
        Me.printPreviewButton.Size = New System.Drawing.Size(125, 23)
        Me.printPreviewButton.Text = "Print Preview"
        Me.ClientSize = New System.Drawing.Size(292, 266)
        Me.Controls.Add(Me.printPreviewButton)

    End Sub
    
    Private Sub ReadDocument() 
        Dim docName As String = "testPage.txt"
        Dim docPath As String = "c:\"
        printDocument1.DocumentName = docName
        Dim stream As New FileStream(docPath + docName, FileMode.Open)
        Try
            Dim reader As New StreamReader(stream)
            Try
                documentContents = reader.ReadToEnd()
            Finally
                reader.Dispose()
            End Try
        Finally
            stream.Dispose()
        End Try
        stringToPrint = documentContents
    
    End Sub

    Sub printDocument1_PrintPage(ByVal sender As Object, _
        ByVal e As PrintPageEventArgs) Handles printDocument1.PrintPage

        Dim charactersOnPage As Integer = 0
        Dim linesPerPage As Integer = 0

        ' Sets the value of charactersOnPage to the number of characters 
        ' of stringToPrint that will fit within the bounds of the page.
        e.Graphics.MeasureString(stringToPrint, Me.Font, e.MarginBounds.Size, _
            StringFormat.GenericTypographic, charactersOnPage, linesPerPage)

        ' Draws the string within the bounds of the page.
        e.Graphics.DrawString(stringToPrint, Me.Font, Brushes.Black, _
            e.MarginBounds, StringFormat.GenericTypographic)

        ' Remove the portion of the string that has been printed.
        stringToPrint = stringToPrint.Substring(charactersOnPage)

        ' Check to see if more pages are to be printed.
        e.HasMorePages = stringToPrint.Length > 0

        ' If there are no more pages, reset the string to be printed.
        If Not e.HasMorePages Then
            stringToPrint = documentContents
        End If

    End Sub

    Private Sub printPreviewButton_Click(ByVal sender As Object, _
        ByVal e As EventArgs) Handles printPreviewButton.Click

        ReadDocument()
        printPreviewDialog1.Document = printDocument1
        printPreviewDialog1.ShowDialog()
    End Sub

    <STAThread()>  _
    Shared Sub Main() 
        Application.EnableVisualStyles()
        Application.SetCompatibleTextRenderingDefault(False)
        Application.Run(New Form1())
    
    End Sub
End Class 

Компиляция кода

Для этого примера требуется:

• Ссылки на сборки System, System.Windows.Forms, System.Drawing.

См. также

• Практическое руководство. Печать многостраничного текстового файла в Windows Forms
• Поддержка Windows Forms для печати
• более безопасная печать в Windows Forms