DocumentPaginator.GetPageAsync 方法

定义

命名空间:

System.Windows.Documents

程序集:

PresentationCore.dll

异步返回指定页码的 DocumentPage。

重载

GetPageAsync(Int32, Object)	异步返回指定页码的 DocumentPage，并将指定的 ID 分配给异步任务（通过 GetPageCompleted 事件）。
GetPageAsync(Int32)	异步返回指定页码的 DocumentPage（通过 GetPageCompleted 事件）。

GetPageAsync(Int32, Object)

异步返回指定页码的 DocumentPage，并将指定的 ID 分配给异步任务（通过 GetPageCompleted 事件）。

public:
 virtual void GetPageAsync(int pageNumber, System::Object ^ userState);

public virtual void GetPageAsync (int pageNumber, object userState);

abstract member GetPageAsync : int * obj -> unit
override this.GetPageAsync : int * obj -> unit

Public Overridable Sub GetPageAsync (pageNumber As Integer, userState As Object)

参数

pageNumber

Int32

要获取的 DocumentPage 的从零开始的页码。

userState

Object

异步任务的唯一标识符。

例外

ArgumentOutOfRangeException

pageNumber 为负数。

注解

此方法的此重载使得可以取消此异步操作，而无需取消所有异步操作。

此方法引发 GetPageCompleted 事件。 DocumentPage 作为事件参数之一传递给事件。

以下步骤演示如何异步检索 DocumentPage：

1. 创建 GetPageCompletedEventHandler 委托并将其添加到通知 GetPageCompleted 事件。

2. 调用 GetPageAsync(Int32, Object) 指定所需的 pageNumber 和唯一 userState，该 userState将用于标识异步事件的完成。

3. 事件发生并调用委托时，比较事件的 GetPageCompletedEventArgs。使用原始 GetPageAsync(Int32, Object)userState 参数UserState 属性。 （GetPageCompletedEventArgs.PageNumber 属性也将与 GetPageAsync(Int32, Object) 调用中指定的 pageNumber 匹配。

4. 当 GetPageCompletedEventArgs时。UserState 属性与原始 GetPageAsync(Int32, Object)userState匹配，操作已完成，页面已准备就绪。

5. 调用 GetPage 以检索格式化 DocumentPage。

GetPageAsync(Int32)

异步返回指定页码的 DocumentPage（通过 GetPageCompleted 事件）。

public:
 virtual void GetPageAsync(int pageNumber);

public virtual void GetPageAsync (int pageNumber);

abstract member GetPageAsync : int -> unit
override this.GetPageAsync : int -> unit

Public Overridable Sub GetPageAsync (pageNumber As Integer)

参数

pageNumber

Int32

所需文档页的从零开始的页码。

例外

ArgumentOutOfRangeException

pageNumber 为负数。

注解

取消此方法的异步操作的唯一方法是取消所有异步操作。 将此与此方法的其他重载形成鲜明对比：GetPageAsync(Int32, Object)。

此方法引发 GetPageCompleted 事件。 DocumentPage 作为事件参数之一传递给事件。 有关如何使用此方法获取页面，请参阅 GetPageAsync(Int32, Object)。

此方法存储在任务中，它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中，则等待任务时将引发该异常。 使用异常（如 ArgumentException）仍同步引发。 有关存储的异常，请参阅 GetPage(Int32)引发的异常。