DocumentPaginator.GetPageAsync 方法

定义

命名空间:

System.Windows.Documents

程序集:

PresentationCore.dll

异步返回指定页码的 DocumentPage。

重载

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

GetPageAsync(Int32, Object)

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

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一 的 ，这将用于标识异步事件的完成。

3. 当事件发生并调用委托时，将事件的 GetPageCompletedEventArgs.UserState 属性与原始 GetPageAsync(Int32, Object)userState 参数进行比较。 (. GetPageCompletedEventArgsPageNumber 属性还将匹配 pageNumberGetPageAsync(Int32, Object) call.)

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

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

GetPageAsync(Int32)

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

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)异常。