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.UserState 属性与原始 GetPageNumberAsyncuserState 参数进行比较。

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

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

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

适用于