DocumentPaginator.GetPageAsync 方法

定義

命名空間:

System.Windows.Documents

組件:

PresentationCore.dll

非同步回傳 DocumentPage 指定的頁碼。

多載

名稱	Description
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 。

userState

Object

異步工作的唯一標識符。

例外狀況

ArgumentOutOfRangeException

pageNumber 是負的。

備註

此方法的這個多載可讓您取消此異步操作，而不取消所有異步操作。

此方法提升事件。GetPageCompleted 會 DocumentPage 作為事件參數之一傳遞給事件。

以下步驟說明如何非同步取得 ：DocumentPage

1. 建立一個 GetPageCompletedEventHandler 代表並加入，這樣就能收到活動通知 GetPageCompleted 。

2. 呼叫 GetPageAsync(Int32, Object) 指定所需值 pageNumber 及唯一 userState值，用以識別非同步事件的完成。

3. 當事件發生且代理被呼叫時，將事件的 GetPageCompletedEventArgs.UserState property 與原始 GetPageAsync(Int32, Object)userState 參數進行比較。 （GetPageCompletedEventArgs.PageNumber屬性也會與呼叫中GetPageAsync(Int32, Object)指定的屬性相符pageNumber。）

4. 當 .UserState屬性與原始userStateGetPageAsync(Int32, Object)屬性匹配時GetPageCompletedEventArgs，操作完成，頁面就準備好了。

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

所需文件頁碼的以零起始的頁碼。

例外狀況

ArgumentOutOfRangeException

pageNumber 是負的。

備註

取消此方法異步操作的唯一方法是取消所有異步操作。 與此方法的另一種過載形成對比： GetPageAsync(Int32, Object)。

此方法提升事件。GetPageCompleted 會 DocumentPage 作為事件參數之一傳遞給事件。 請參考 GetPageAsync(Int32, Object) 如何使用此方法取得該頁面。

這個方法會儲存在工作中，它會傳回方法同步對應項可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外錯誤，例如 ArgumentException，仍會同步拋出。 關於儲存的例外，請參見由 GetPage(Int32)拋出的例外。