PrintPreviewControl.Document Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Gets or sets a value indicating the document to preview.

public:
 property System::Drawing::Printing::PrintDocument ^ Document { System::Drawing::Printing::PrintDocument ^ get(); void set(System::Drawing::Printing::PrintDocument ^ value); };

public System.Drawing.Printing.PrintDocument? Document { get; set; }

member this.Document : System.Drawing.Printing.PrintDocument with get, set

Public Property Document As PrintDocument

Property Value

PrintDocument

The PrintDocument representing the document to preview.

Examples

The following code example demonstrates the Document, UseAntiAlias, and Zoom properties of the PrintPreviewControl. To run this example, place the following code in a form and call the InitializePrintPreviewControl method from the form's constructor or Load event-handling method.

internal:
   // Declare the PrintPreviewControl object and the 
   // PrintDocument object.
   PrintPreviewControl^ PrintPreviewControl1;

private:
   System::Drawing::Printing::PrintDocument^ docToPrint;
   void InitializePrintPreviewControl()
   {
      // Construct the PrintPreviewControl.
      this->PrintPreviewControl1 = gcnew PrintPreviewControl;
      
      // Set location, name, and dock style for PrintPreviewControl1.
      this->PrintPreviewControl1->Location = Point(88,80);
      this->PrintPreviewControl1->Name = "PrintPreviewControl1";
      this->PrintPreviewControl1->Dock = DockStyle::Fill;
      
      // Set the Document property to the PrintDocument 
      // for which the PrintPage event has been handled.
      this->PrintPreviewControl1->Document = docToPrint;
      
      // Set the zoom to 25 percent.
      this->PrintPreviewControl1->Zoom = 0.25;
      
      // Set the document name. This will show be displayed when 
      // the document is loading into the control.
      this->PrintPreviewControl1->Document->DocumentName = "c:\\someFile";
      
      // Set the UseAntiAlias property to true so fonts are smoothed
      // by the operating system.
      this->PrintPreviewControl1->UseAntiAlias = true;
      
      // Add the control to the form.
      this->Controls->Add( this->PrintPreviewControl1 );
      
      // Associate the event-handling method with the
      // document's PrintPage event.
      this->docToPrint->PrintPage += gcnew System::Drawing::Printing::PrintPageEventHandler( this, &Form1::docToPrint_PrintPage );
   }

   // The PrintPreviewControl will display the document
   // by handling the documents PrintPage event
   void docToPrint_PrintPage( Object^ /*sender*/, System::Drawing::Printing::PrintPageEventArgs^ e )
   {
      // Insert code to render the page here.
      // This code will be called when the control is drawn.
      // The following code will render a simple
      // message on the document in the control.
      String^ text = "In docToPrint_PrintPage method.";
      System::Drawing::Font^ printFont = gcnew System::Drawing::Font( "Arial",35,FontStyle::Regular );
      e->Graphics->DrawString( text, printFont, Brushes::Black, 10, 10 );
   }

// Declare the PrintPreviewControl object and the 
// PrintDocument object.
internal PrintPreviewControl PrintPreviewControl1;
private System.Drawing.Printing.PrintDocument docToPrint = 
    new System.Drawing.Printing.PrintDocument();

private void InitializePrintPreviewControl()
{

    // Construct the PrintPreviewControl.
    this.PrintPreviewControl1 = new PrintPreviewControl();

    // Set location, name, and dock style for PrintPreviewControl1.
    this.PrintPreviewControl1.Location = new Point(88, 80);
    this.PrintPreviewControl1.Name = "PrintPreviewControl1";
    this.PrintPreviewControl1.Dock = DockStyle.Fill;

    // Set the Document property to the PrintDocument 
    // for which the PrintPage event has been handled.
    this.PrintPreviewControl1.Document = docToPrint;

    // Set the zoom to 25 percent.
    this.PrintPreviewControl1.Zoom = 0.25;

    // Set the document name. This will show be displayed when 
    // the document is loading into the control.
    this.PrintPreviewControl1.Document.DocumentName = "c:\\someFile";

    // Set the UseAntiAlias property to true so fonts are smoothed
    // by the operating system.
    this.PrintPreviewControl1.UseAntiAlias = true;

    // Add the control to the form.
    this.Controls.Add(this.PrintPreviewControl1);
    
    // Associate the event-handling method with the
    // document's PrintPage event.
    this.docToPrint.PrintPage += 
        new System.Drawing.Printing.PrintPageEventHandler(
        docToPrint_PrintPage);
}

// The PrintPreviewControl will display the document
// by handling the documents PrintPage event
private void docToPrint_PrintPage(
    object sender, System.Drawing.Printing.PrintPageEventArgs e)
{

    // Insert code to render the page here.
    // This code will be called when the control is drawn.

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

    e.Graphics.DrawString(text, printFont,
        Brushes.Black, 10, 10);
}

'Declare the PrintPreviewControl object and the PrintDocument object.
Friend WithEvents PrintPreviewControl1 As PrintPreviewControl
Private WithEvents docToPrint As New Printing.PrintDocument

Private Sub InitializePrintPreviewControl()

    ' Construct the PrintPreviewControl.
    Me.PrintPreviewControl1 = New PrintPreviewControl

    ' Set location, name, and dock style for PrintPreviewControl1.
    Me.PrintPreviewControl1.Location = New Point(88, 80)
    Me.PrintPreviewControl1.Name = "PrintPreviewControl1"
    Me.PrintPreviewControl1.Dock = DockStyle.Fill

    ' Set the Document property to the PrintDocument 
    ' for which the PrintPage event has been handled.
    Me.PrintPreviewControl1.Document = docToPrint

    ' Set the zoom to 25 percent.
    Me.PrintPreviewControl1.Zoom = 0.25

    ' Set the document name. This will show be displayed when 
    ' the document is loading into the control.
    Me.PrintPreviewControl1.Document.DocumentName = "c:\someFile"

    ' Set the UseAntiAlias property to true so fonts are smoothed
    ' by the operating system.
    Me.PrintPreviewControl1.UseAntiAlias = True

    ' Add the control to the form.
    Me.Controls.Add(Me.PrintPreviewControl1)
End Sub

' The PrintPreviewControl will display the document
' by handling the documents PrintPage event
Private Sub docToPrint_PrintPage(ByVal sender As Object, _
   ByVal e As System.Drawing.Printing.PrintPageEventArgs) _
       Handles docToPrint.PrintPage

    ' Insert code to render the page here.
    ' This code will be called when the control is drawn.

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

    e.Graphics.DrawString(text, printFont, _
        System.Drawing.Brushes.Black, 10, 10)
End Sub

See also

• PrintDocument