PrintDocument.OnBeginPrint Method (System.Drawing.Printing)

OnBeginPrint Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

PrintDocument..::.OnBeginPrint Method

Raises the BeginPrint event. It is called after the Print method is called and before the first page of the document prints.

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

Syntax

Visual Basic (Declaration)

Protected Overridable Sub OnBeginPrint ( _
    e As PrintEventArgs _
)

Visual Basic (Usage)

Dim e As PrintEventArgs

Me.OnBeginPrint(e)

protected virtual void OnBeginPrint(
    PrintEventArgs e
)

Visual C++

protected:
virtual void OnBeginPrint(
    PrintEventArgs^ e
)

JScript

protected function OnBeginPrint(
    e : PrintEventArgs
)

Parameters

e: Type: System.Drawing.Printing..::.PrintEventArgs
A PrintEventArgs that contains the event data.

Remarks

The OnBeginPrint method allows derived classes to handle the event without attaching a delegate. This is the preferred technique for handling the event in a derived class.

When a derived class calls the OnBeginPrint method, it raises the BeginPrint event by invoking the event handler through a delegate. For more information, see Raising an Event.

Notes to Inheritors:

When overriding OnBeginPrint in a derived class, be sure to call the base class's OnBeginPrint method so that registered delegates receive the event. This method is a good place for initialization.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information

.NET Framework

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

Reference

PrintDocument Class

PrintDocument Members

System.Drawing.Printing Namespace

BeginPrint

PrintEventArgs