DocumentPaginator.GetPageAsync Method (Int32, Object)

Asynchronously returns (through the GetPageCompleted event) the DocumentPage for the specifed page number and assigns the specified ID to the asynchronous task.

Namespace: System.Windows.Documents
Assembly: PresentationCore (in presentationcore.dll)

public virtual void GetPageAsync (
	int pageNumber,
	Object userState
public void GetPageAsync (
	int pageNumber, 
	Object userState
public function GetPageAsync (
	pageNumber : int, 
	userState : Object
You cannot use methods in XAML.



The zero-based page number of the DocumentPage to get.


A unique identifier for the asynchronous task.

Exception typeCondition


pageNumber is negative.

This overload of the method makes it possible to cancel this asynchronous operation without cancelling all asynchronous operations.

This method raises the GetPageCompleted event. The DocumentPage is passed to the event as one of the event arguments.

The following steps illustrate how to retrieve a DocumentPage asynchronously:

  1. Create a GetPageCompletedEventHandler delegate and add it to be notified of GetPageCompleted events.

  2. Call GetPageAsync(Int32,Object) specifying the pageNumber desired and a unique userState, which will be used to identify the completion of the asynchronous event.

  3. When the event occurs and the delegate is called, compare the event's GetPageCompletedEventArgs.UserState property with the original GetPageAsync(Int32,Object) userState parameter. (The GetPageCompletedEventArgs.PageNumber property will also match the pageNumber specified in the GetPageAsync(Int32,Object) call.)

  4. When the GetPageCompletedEventArgs.UserState property matches the original GetPageAsync(Int32,Object) userState, the operation is complete and the page is ready.

  5. Call GetPage to retrieve the formatted DocumentPage.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0

Community Additions