StandardPrintController.OnStartPage(PrintDocument, PrintPageEventArgs) Method

Definition

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

public:
 override System::Drawing::Graphics ^ OnStartPage(System::Drawing::Printing::PrintDocument ^ document, System::Drawing::Printing::PrintPageEventArgs ^ e);
public override System.Drawing.Graphics OnStartPage (System.Drawing.Printing.PrintDocument document, System.Drawing.Printing.PrintPageEventArgs e);
override this.OnStartPage : System.Drawing.Printing.PrintDocument * System.Drawing.Printing.PrintPageEventArgs -> System.Drawing.Graphics
Public Overrides Function OnStartPage (document As PrintDocument, e As PrintPageEventArgs) As Graphics

Parameters

document
PrintDocument

A PrintDocument that represents the document being printed.

e
PrintPageEventArgs

A PrintPageEventArgs that contains data about how to print a page in the document. Initially, the Graphics property of this parameter will be null. The value returned from the OnStartPage(PrintDocument, PrintPageEventArgs) method will be used to set this property.

Returns

A Graphics object that represents a page from a PrintDocument.

Exceptions

The native Win32 Application Programming Interface (API) could not prepare the printer driver to accept data.

-or-

The native Windows API could not update the specified printer or plotter device context (DC) using the specified information.

Remarks

OnStartPage is called immediately before PrintDocument raises the PrintPage event.

OnStartPrint creates the Graphics object used in printing. 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.

Security

PrintingPermission
for controlling access to printers. Related enumeration: PrintingPermissionLevel.

Applies to

See also