PrintControllerWithStatusDialog::OnStartPrint Method (PrintDocument^, PrintEventArgs^)

 

This API supports the product infrastructure and is not intended to be used directly from your code.

Begins the control sequence that determines when and how to print a document.

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

public:
virtual void OnStartPrint(
	PrintDocument^ document,
	PrintEventArgs^ e
) override

Parameters

document
Type: System.Drawing.Printing::PrintDocument^

A PrintDocument that represents the document currently being printed.

e
Type: System.Drawing.Printing::PrintEventArgs^

A PrintEventArgs that contains the event data.

The PrintControllerWithStatusDialog class calls the PrintController::OnStartPrint method on the encapsulated PrintController.

The OnStartPrint method is called immediately after the PrintDocument raises the BeginPrint event.

Use OnStartPrint to determine when and how to print a document. For example, you can delay printing for 30 minutes or adjust the printer settings for the document. OnStartPrint creates the Graphics object that is sent to the printer. After OnStartPrint is called, the OnStartPage method sets the Graphics object to a graphic of a single page. The OnEndPage method clears the Graphics object, while the OnEndPrint method deallocates the object.

OnStartPrint is a good place to verify that PrinterSettings are valid.

.NET Framework
Available since 1.1
Return to top
Show: