DocumentPaginator.GetPageAsync 方法

定義

命名空間:

System.Windows.Documents

組件:

PresentationCore.dll

非同步傳回指定之頁碼的 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 的以零起始的頁碼。

userState

Object

非同步工作的唯一識別項。

例外狀況

ArgumentOutOfRangeException

pageNumber 為負。

備註

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

這個方法會 GetPageCompleted 引發 事件。 會 DocumentPage 當做其中一個事件引數傳遞至事件。

下列步驟說明如何以非同步方式擷取 DocumentPage ：

1. 建立 GetPageCompletedEventHandler 委派並加以新增，以通知 GetPageCompleted 事件。

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

3. 當事件發生並呼叫委派時，請比較事件的 GetPageCompletedEventArgs . UserState 屬性與原始 GetPageAsync(Int32, Object)userState 參數。 (. GetPageCompletedEventArgsPageNumber 屬性也會符合 pageNumber call.) 中指定的 GetPageAsync(Int32, Object)

4. 當 . GetPageCompletedEventArgsUserState 屬性符合原始 GetPageAsync(Int32, Object)userState 時，作業就會完成，且頁面已就緒。

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) 例外狀況。