Export (0) Print
Expand All
0 out of 4 rated this helpful - Rate this topic

PrintPreviewDialog Class

Represents a dialog box form that contains a PrintPreviewControl.

For a list of all members of this type, see PrintPreviewDialog Members.

System.Object
   System.MarshalByRefObject
      System.ComponentModel.Component
         System.Windows.Forms.Control
            System.Windows.Forms.ScrollableControl
               System.Windows.Forms.ContainerControl
                  System.Windows.Forms.Form
                     System.Windows.Forms.PrintPreviewDialog

[Visual Basic]
Public Class PrintPreviewDialog
   Inherits Form
[C#]
public class PrintPreviewDialog : Form
[C++]
public __gc class PrintPreviewDialog : public Form
[JScript]
public class PrintPreviewDialog extends Form

Thread Safety

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

Remarks

When you create an instance of PrintPreviewDialog, some of the read/write properties are set to initial values. For a list of these, see the PrintPreviewDialog constructor.

Example

[Visual Basic, C#] The following code example assumes the form contains a TreeView object named TreeView1 that contains TreeNode objects. Each TreeNode objects Tag property must be set to a fully-qualified document name that can be accessed by the machine running the example. Set each Text property to a string that identifies the file specified by the Tag property. For example, you could set TreeNode1.Tag to c:\myDocuments\recipe.doc and TreeNode1.Text to recipe.doc. It also assumes the form contains a PrintPreviewDialog object named PrintPreviewDialog1 and a button named Button1. To run this example call the InitializePrintPreviewDialog method in the form's constructor.

[Visual Basic] 

    ' Declare the dialog.
    Friend WithEvents PrintPreviewDialog1 As PrintPreviewDialog

    ' Declare a PrintDocument object named document.
    Private WithEvents document As New System.Drawing.Printing.PrintDocument

    ' Initalize the dialog.
    Private Sub InitializePrintPreviewDialog()

        ' Create a new PrintPreviewDialog using constructor.
        Me.PrintPreviewDialog1 = New PrintPreviewDialog

        'Set the size, location, and name.
        Me.PrintPreviewDialog1.ClientSize = New System.Drawing.Size(400, 300)
        Me.PrintPreviewDialog1.Location = New System.Drawing.Point(29, 29)
        Me.PrintPreviewDialog1.Name = "PrintPreviewDialog1"

        ' Set the minimum size the dialog can be resized to.
        Me.PrintPreviewDialog1.MinimumSize = New System.Drawing.Size(375, 250)

        ' Set the UseAntiAlias property to true, which will allow the 
        ' operating system to smooth fonts.
        Me.PrintPreviewDialog1.UseAntiAlias = True
    End Sub

    Private Sub Button1_Click(ByVal sender As Object, _
        ByVal e As System.EventArgs) Handles Button1.Click

        If Not (TreeView1.SelectedNode Is Nothing) Then

            ' Set the PrintDocument object's name to the selectedNode
            ' object's  tag, which in this case contains the 
            ' fully-qualified name of the document. This value will 
            ' show when the dialog reports progress.
            document.DocumentName = TreeView1.SelectedNode.Tag
        End If

        ' Set the PrintPreviewDialog.Document property to
        ' the PrintDocument object selected by the user.
        PrintPreviewDialog1.Document = document

        ' Call the ShowDialog method. This will trigger the document's
        '  PrintPage event.
        PrintPreviewDialog1.ShowDialog()
    End Sub

    Private Sub document_PrintPage(ByVal sender As Object, _
        ByVal e As System.Drawing.Printing.PrintPageEventArgs) _
            Handles document.PrintPage

        ' Insert code to render the page here.
        ' This code will be called when the PrintPreviewDialog.Show 
        ' method is called.

        ' The following code will render a simple
        ' message on the document in the dialog.
        Dim text As String = "In document_PrintPage method."
        Dim printFont As New System.Drawing.Font _
            ("Arial", 35, System.Drawing.FontStyle.Regular)

        e.Graphics.DrawString(text, printFont, _
            System.Drawing.Brushes.Black, 0, 0)

    End Sub

[C#] 

    // Declare the dialog.
    internal PrintPreviewDialog PrintPreviewDialog1;

    // Declare a PrintDocument object named document.
    private System.Drawing.Printing.PrintDocument document =
        new System.Drawing.Printing.PrintDocument();

    // Initalize the dialog.
    private void InitializePrintPreviewDialog()
    {

        // Create a new PrintPreviewDialog using constructor.
        this.PrintPreviewDialog1 = new PrintPreviewDialog();

        //Set the size, location, and name.
        this.PrintPreviewDialog1.ClientSize = 
            new System.Drawing.Size(400, 300);
        this.PrintPreviewDialog1.Location = 
            new System.Drawing.Point(29, 29);
        this.PrintPreviewDialog1.Name = "PrintPreviewDialog1";
        
        // Associate the event-handling method with the 
        // document's PrintPage event.
        this.document.PrintPage += 
            new System.Drawing.Printing.PrintPageEventHandler
            (document_PrintPage);

        // Set the minimum size the dialog can be resized to.
        this.PrintPreviewDialog1.MinimumSize = 
            new System.Drawing.Size(375, 250);

        // Set the UseAntiAlias property to true, which will allow the 
        // operating system to smooth fonts.
        this.PrintPreviewDialog1.UseAntiAlias = true;
    }

    private void Button1_Click(object sender, System.EventArgs e)
    {

        if (TreeView1.SelectedNode != null)

            // Set the PrintDocument object's name to the selectedNode
            // object's  tag, which in this case contains the 
            // fully-qualified name of the document. This value will 
            // show when the dialog reports progress.
        {
            document.DocumentName = TreeView1.SelectedNode.Tag.ToString();
        }

        // Set the PrintPreviewDialog.Document property to
        // the PrintDocument object selected by the user.
        PrintPreviewDialog1.Document = document;

        // Call the ShowDialog method. This will trigger the document's
        //  PrintPage event.
        PrintPreviewDialog1.ShowDialog();
    }

    private void document_PrintPage(object sender, 
        System.Drawing.Printing.PrintPageEventArgs e)
    {

        // Insert code to render the page here.
        // This code will be called when the PrintPreviewDialog.Show 
        // method is called.

        // The following code will render a simple
        // message on the document in the dialog.
        string text = "In document_PrintPage method.";
        System.Drawing.Font printFont = 
            new System.Drawing.Font("Arial", 35, 
            System.Drawing.FontStyle.Regular);

        e.Graphics.DrawString(text, printFont, 
            System.Drawing.Brushes.Black, 0, 0);

    }

[C++, JScript] No example is available for C++ or JScript. To view a Visual Basic or C# example, click the Language Filter button Language Filter in the upper-left corner of the page.

Requirements

Namespace: System.Windows.Forms

Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family

Assembly: System.Windows.Forms (in System.Windows.Forms.dll)

See Also

PrintPreviewDialog Members | System.Windows.Forms Namespace | PageSetupDialog | PrintDialog | PrintPreviewControl

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.