This documentation is archived and is not being maintained.

PreviewPrintController Class

Specifies a print controller that displays a document on a screen as a series of images.


Namespace:  System.Drawing.Printing
Assembly:  System.Drawing (in System.Drawing.dll)

public class PreviewPrintController : PrintController

The PreviewPrintController type exposes the following members.

Public methodPreviewPrintControllerInitializes a new instance of the PreviewPrintController class.

Public propertyIsPreviewGets a value indicating whether this controller is used for print preview. (Overrides PrintController.IsPreview.)
Public propertyUseAntiAliasGets or sets a value indicating whether to use anti-aliasing when displaying the print preview.

Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetPreviewPageInfoCaptures the pages of a document as a series of images.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOnEndPageCompletes the control sequence that determines when and how to preview a page in a print document. (Overrides PrintController.OnEndPage(PrintDocument, PrintPageEventArgs).)
Public methodOnEndPrintCompletes the control sequence that determines when and how to preview a print document. (Overrides PrintController.OnEndPrint(PrintDocument, PrintEventArgs).)
Public methodOnStartPageBegins the control sequence that determines when and how to preview a page in a print document. (Overrides PrintController.OnStartPage(PrintDocument, PrintPageEventArgs).)
Public methodOnStartPrintBegins the control sequence that determines when and how to preview a print document. (Overrides PrintController.OnStartPrint(PrintDocument, PrintEventArgs).)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

Typically, to use the print preview feature, you create an instance of a PrintPreviewControl or PrintPreviewDialog class and set its Document property. The PreviewPrintController is used by the PrintPreviewControl and PrintPreviewDialog classes, though you can use the PreviewPrintController when managing the display of your own print preview window.

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.

For more information about printing, see the System.Drawing.Printing namespace overview.

.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.