DynamicDocumentPaginator.GetPageNumberAsync メソッド

定義

名前空間:

System.Windows.Documents

アセンブリ:

PresentationCore.dll

指定した ContentPositionの 0 から始まるページ番号を返します。

オーバーロード

GetPageNumberAsync(ContentPosition)	非同期的に、指定した ContentPositionの 0 から始まるページ番号を (This メソッドを使用して GetPageNumberCompleted イベントを発生させます) を返します。
GetPageNumberAsync(ContentPosition, Object)	非同期的に、指定した ContentPositionの 0 から始まるページ番号を (This メソッドを使用して GetPageNumberCompleted イベントを発生させます) を返します。

GetPageNumberAsync(ContentPosition)

非同期的に、指定した ContentPositionの 0 から始まるページ番号を (This メソッドを使用して GetPageNumberCompleted イベントを発生させます) を返します。

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 イベントを発生させます。 ページ番号は、イベント引数の 1 つとしてイベントに渡されます。 このメソッドを使用してページ番号を取得する方法については、GetPageNumberAsync(ContentPosition, Object) を参照してください。

このメソッドは、メソッドの同期的な例外がスローできるすべての非使用例外を返すタスクに格納します。 返されたタスクに例外が格納されている場合、その例外はタスクが待機しているときにスローされます。 ArgumentExceptionなどの使用例外は、引き続き同期的にスローされます。 格納されている例外については、GetPageNumber(ContentPosition)によってスローされる例外を参照してください。

GetPageNumberAsync(ContentPosition, Object)

非同期的に、指定した ContentPositionの 0 から始まるページ番号を (This メソッドを使用して GetPageNumberCompleted イベントを発生させます) を返します。

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するとき.プロパティが元の GetPageNumberAsync(ContentPosition, Object)userStateと一致UserState、操作が完了し、ページ番号が準備完了です。 (GetPageNumberCompletedEventArgs.ContentPosition プロパティは、元の GetPageNumberAsync(ContentPosition, Object)contentPosition パラメーターとも一致します)。

5. GetPageNumberCompletedEventArgs.PageNumber プロパティには、指定した contentPositionの 0 から始まるページ番号が含まれます。

GetPageNumber は、GetPageNumberAsyncと同様の機能を提供しますが、同期操作用です。