PrintDialog.Document Property

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets a value indicating the PrintDocument used to obtain PrinterSettings.

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

public PrintDocument Document { get; set; }

Property Value

Type: System.Drawing.Printing.PrintDocument

The PrintDocument used to obtain PrinterSettings. The default is null.

The following code example demonstrates how to use the PrintDialog control to set the AllowSomePages, ShowHelp, and Document properties. To run this example, paste the following code into a form that contains a PrintDialog control named PrintDialog1 and a button named Button1. This example requires that the button's Click event and the PrintPage event of docToPrint have been connected to the event-handling methods defined in this example.


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

// This method will set properties on the PrintDialog object and
// then display the dialog.
private void Button1_Click(System.Object sender, 
	System.EventArgs e)
{

	// Allow the user to choose the page range he or she would
	// like to print.
	PrintDialog1.AllowSomePages = true;

	// Show the help button.
	PrintDialog1.ShowHelp = true;

	// Set the Document property to the PrintDocument for 
	// which the PrintPage Event has been handled. To display the
	// dialog, either this property or the PrinterSettings property 
	// must be set 
	PrintDialog1.Document = docToPrint;

	DialogResult result = PrintDialog1.ShowDialog();

	// If the result is OK then print the document.
	if (result==DialogResult.OK)
	{
		docToPrint.Print();
	}

}

// The PrintDialog will print the document
// by handling the document's PrintPage event.
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 control is drawn.

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

	// Draw the content.
	e.Graphics.DrawString(text, printFont, 
		System.Drawing.Brushes.Black, 10, 10);
}

.NET Framework
Available since 1.1
Return to top
Show: