DocumentPaginator.GetPageAsync メソッド

定義

名前空間:

System.Windows.Documents

アセンブリ:

PresentationCore.dll

指定したページ番号の DocumentPage を非同期的に返します。

オーバーロード

GetPageAsync(Int32, Object)	指定したページ番号の DocumentPage を非同期的に (GetPageCompleted イベントを通じて) 返し、指定した ID を非同期タスクに割り当てます。
GetPageAsync(Int32)	指定したページ番号の DocumentPage を非同期に (GetPageCompleted イベントを介して) 返します。

GetPageAsync(Int32, Object)

指定したページ番号の DocumentPage を非同期的に (GetPageCompleted イベントを通じて) 返し、指定した 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

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

例外

ArgumentOutOfRangeException

pageNumber は負の値です。

注釈

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

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

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

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

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

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

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

5. GetPage を呼び出して、書式設定された DocumentPageを取得します。

GetPageAsync(Int32)

指定したページ番号の DocumentPage を非同期に (GetPageCompleted イベントを介して) 返します。

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 から始まるページ番号。

例外

ArgumentOutOfRangeException

pageNumber は負の値です。

注釈

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

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

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