DocumentPaginator.GetPageAsync メソッド

定義

指定したページ番号の 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 の 0 から始まるページ番号。

userState
Object

非同期タスクの一意の識別子。

例外

pageNumber が負の値です。

注釈

メソッドのこのオーバーロードにより、すべての非同期操作を取り消すことなく、この非同期操作を取り消すことができます。

このメソッドは、 イベントを GetPageCompleted 発生させます。 DocumentPageは、イベント引数の 1 つとしてイベントに渡されます。

次の手順は、 を非同期的に取得する方法を DocumentPage 示しています。

  1. デリゲートを GetPageCompletedEventHandler 作成し、イベントの GetPageCompleted 通知を受け取るために追加します。

  2. 非同期イベントの完了をpageNumber識別するために使用される、目的の と一意userStateの を指定する を呼び出GetPageAsync(Int32, Object)します。

  3. イベントが発生し、デリゲートが呼び出されたら、イベントの の プロパティUserStateを元userStateGetPageAsync(Int32, Object)GetPageCompletedEventArgsパラメーターと比較します。 (. GetPageCompletedEventArgsPageNumber プロパティは、呼び出しで指定された とGetPageAsync(Int32, Object)一致pageNumberします)。

  4. プロパティが元GetPageAsync(Int32, Object)userStateGetPageCompletedEventArgsUserState と一致すると、操作が完了し、ページの準備が整います。

  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

必要なドキュメント ページの 0 から始まるページ番号。

例外

pageNumber が負の値です。

注釈

このメソッドの非同期操作を取り消す唯一の方法は、すべての非同期操作を取り消す方法です。 これは、このメソッドの他のオーバーロード ( ) と対照的です GetPageAsync(Int32, Object)

このメソッドは、 イベントを GetPageCompleted 発生させます。 DocumentPageは、イベント引数の 1 つとしてイベントに渡されます。 このメソッドを使用してページを取得する方法については、「」を参照してください GetPageAsync(Int32, Object)

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

適用対象