DocumentPaginator.GetPageAsync 方法
定义
重要
一些信息与预发行产品相关,相应产品在发行之前可能会进行重大修改。 对于此处提供的信息,Microsoft 不作任何明示或暗示的担保。
异步返回 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
异步任务的唯一标识符。
例外
pageNumber 为负数。
注解
此方法的此重载使得可以取消此异步操作,而无需取消所有异步操作。
此方法引发 GetPageCompleted 事件。 作为 DocumentPage 事件参数之一传递给事件。
以下步骤演示如何异步检索 DocumentPage :
创建一个 GetPageCompletedEventHandler 委托并将其添加到通知 GetPageCompleted 事件。
指定
pageNumber所需事件和唯userState一的调用GetPageAsync(Int32, Object),该调用将用于标识异步事件的完成。事件发生并调用委托时,将事件的 GetPageCompletedEventArgs.UserState 属性与原始 GetPageAsync(Int32, Object)
userState参数进行比较。 (.GetPageCompletedEventArgsPageNumber属性也将与调用中指定的GetPageAsync(Int32, Object)属性匹配pageNumber。GetPageCompletedEventArgs当 .UserState属性与原始GetPageAsync(Int32, Object)
userState属性匹配时,操作已完成,并且页面已准备就绪。调用 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
所需文档页的从零开始的页码。
例外
pageNumber 为负数。
注解
取消此方法的异步操作的唯一方法是取消所有异步操作。 与此方法的其他重载形成对比: GetPageAsync(Int32, Object).
此方法引发 GetPageCompleted 事件。 作为 DocumentPage 事件参数之一传递给事件。 了解如何 GetPageAsync(Int32, Object) 使用此方法获取页面。
此方法存储在任务中,它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中,则等待任务时将引发该异常。 使用情况异常(例如 ArgumentException)仍会同步引发。 有关存储的异常,请参阅由 GetPage(Int32)..