PreviewPrintController.OnStartPage(PrintDocument, PrintPageEventArgs) Method

Definition

Namespace:

System.Drawing.Printing

Assembly:

System.Drawing.Common.dll

Package:

System.Drawing.Common v8.0.0

Source:

PreviewPrintController.cs

Begins the control sequence that determines when and how to preview a page in a print 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 previewed.

e

PrintPageEventArgs

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

Returns

Graphics

A Graphics that represents a page from a PrintDocument.

Remarks

OnStartPage is called immediately before PrintDocument raises the PrintPage event.

OnStartPrint creates the Graphics that is displayed during the print preview. After OnStartPrint is called, the OnStartPage method sets the Graphics to a graphic of a single page. The OnEndPage method clears the Graphics, while the OnEndPrint method deallocates the object.

Note

Anti-aliasing, also known as gray scaling, makes the print preview look better. However, the use of anti-aliasing can slow down the rendering speed. For more information about anti-aliasing, see the UseAntiAlias property.

See also

• OnEndPage(PrintDocument, PrintPageEventArgs)
• OnEndPrint(PrintDocument, PrintEventArgs)
• OnStartPrint(PrintDocument, PrintEventArgs)
• PrintPageEventArgs