DocumentPaginator.GetPageAsync 方法
定義
重要
部分資訊涉及發行前產品,在發行之前可能會有大幅修改。 Microsoft 對此處提供的資訊,不做任何明確或隱含的瑕疵擔保。
以異步方式傳回指定頁碼的 DocumentPage。
多載
| GetPageAsync(Int32, Object) |
以異步方式傳回指定頁碼的 GetPageCompletedDocumentPage,並將指定的標識碼指派給異步工作。 |
| GetPageAsync(Int32) |
以異步方式傳回指定頁碼的 DocumentPage(透過 GetPageCompleted 事件)。 |
GetPageAsync(Int32, Object)
以異步方式傳回指定頁碼的 GetPageCompletedDocumentPage,並將指定的標識碼指派給異步工作。
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
異步工作的唯一標識符。
例外狀況
pageNumber 為負數。
備註
此方法的這個多載可讓您取消此異步操作,而不取消所有異步操作。
這個方法會引發 GetPageCompleted 事件。 DocumentPage 會當做其中一個事件自變數傳遞至事件。
下列步驟說明如何以異步方式擷取 DocumentPage:
建立 GetPageCompletedEventHandler 委派,並將它新增至 GetPageCompleted 事件的通知。
呼叫 GetPageAsync(Int32, Object) 指定所需的
pageNumber和唯一的userState,用來識別異步事件的完成。當事件發生並呼叫委派時,請比較事件的 GetPageCompletedEventArgs。具有原始 GetPageAsync(Int32, Object)
userState參數的UserState 屬性。 (GetPageCompletedEventArgs.PageNumber 屬性也會符合 GetPageAsync(Int32, Object) 呼叫中指定的pageNumber。當 GetPageCompletedEventArgs時。UserState 屬性符合原始 GetPageAsync(Int32, Object)
userState,作業已完成,而且頁面已就緒。呼叫 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
所需文件頁碼的以零起始的頁碼。
例外狀況
pageNumber 為負數。
備註
取消此方法異步操作的唯一方法是取消所有異步操作。 與此方法的其他多載形成對比:GetPageAsync(Int32, Object)。
這個方法會引發 GetPageCompleted 事件。 DocumentPage 會當做其中一個事件自變數傳遞至事件。 如需如何使用此方法取得頁面,請參閱 GetPageAsync(Int32, Object)。
這個方法會儲存在工作中,它會傳回方法同步對應項可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中,則會在等候工作時擲回該例外狀況。 使用例外狀況,例如 ArgumentException,仍會同步擲回。 如需預存的例外狀況,請參閱 GetPage(Int32)擲回的例外狀況。