DynamicDocumentPaginator.GetPageNumberAsync 方法

定义

返回指定 ContentPosition的从零开始的页码。

重载

GetPageNumberAsync(ContentPosition)

异步返回(通过此方法引发 GetPageNumberCompleted 事件)指定 ContentPosition的从零开始的页码。

GetPageNumberAsync(ContentPosition, Object)

异步返回(通过此方法引发 GetPageNumberCompleted 事件)指定 ContentPosition的从零开始的页码。

GetPageNumberAsync(ContentPosition)

异步返回(通过此方法引发 GetPageNumberCompleted 事件)指定 ContentPosition的从零开始的页码。

public:
 virtual void GetPageNumberAsync(System::Windows::Documents::ContentPosition ^ contentPosition);
public virtual void GetPageNumberAsync (System.Windows.Documents.ContentPosition contentPosition);
abstract member GetPageNumberAsync : System.Windows.Documents.ContentPosition -> unit
override this.GetPageNumberAsync : System.Windows.Documents.ContentPosition -> unit
Public Overridable Sub GetPageNumberAsync (contentPosition As ContentPosition)

参数

contentPosition
ContentPosition

需要其页码的内容位置。

注解

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

此方法引发 GetPageNumberCompleted 事件。 页码作为事件参数之一传递给事件。 请参阅 GetPageNumberAsync(ContentPosition, Object),了解如何使用此方法获取页码。

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

适用于

GetPageNumberAsync(ContentPosition, Object)

异步返回(通过此方法引发 GetPageNumberCompleted 事件)指定 ContentPosition的从零开始的页码。

public:
 virtual void GetPageNumberAsync(System::Windows::Documents::ContentPosition ^ contentPosition, System::Object ^ userState);
public virtual void GetPageNumberAsync (System.Windows.Documents.ContentPosition contentPosition, object userState);
abstract member GetPageNumberAsync : System.Windows.Documents.ContentPosition * obj -> unit
override this.GetPageNumberAsync : System.Windows.Documents.ContentPosition * obj -> unit
Public Overridable Sub GetPageNumberAsync (contentPosition As ContentPosition, userState As Object)

参数

contentPosition
ContentPosition

要返回页码的内容位置元素。

userState
Object

异步任务的唯一标识符。

注解

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

此方法引发 GetPageNumberCompleted 事件。

以下步骤演示如何异步检索给定 contentPosition 的页码。

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

  2. 调用 GetPageNumberAsync(ContentPosition, Object) 指定所需的 contentPosition,以及用于标识异步任务的唯一 userState 对象。

  3. 事件发生并调用委托时,比较事件的 GetPageNumberCompletedEventArgs。使用原始 GetPageNumberAsyncuserState 参数UserState 属性。

  4. GetPageNumberCompletedEventArgs时。UserState 属性与原始 GetPageNumberAsync(ContentPosition, Object)userState匹配,操作已完成,页码已准备就绪。 (GetPageNumberCompletedEventArgs.ContentPosition 属性也将与原始 GetPageNumberAsync(ContentPosition, Object)contentPosition 参数匹配。

  5. GetPageNumberCompletedEventArgsPageNumber 属性包含指定 contentPosition的从零开始的页码。

GetPageNumber 提供与 GetPageNumberAsync类似的功能,但对于同步操作。

适用于