DocumentPaginator.GetPageAsync Método

Definición

De forma asincrónica, devuelve DocumentPage para el número de página especificado.

Sobrecargas

GetPageAsync(Int32, Object)

De forma asincrónica, devuelve (mediante el evento GetPageCompleted) DocumentPage para el número de página especificado y asigna el Id. especificado a la tarea asincrónica.

GetPageAsync(Int32)

De forma asincrónica, devuelve (mediante el evento GetPageCompleted) DocumentPage para el número de página especificado.

GetPageAsync(Int32, Object)

De forma asincrónica, devuelve (mediante el evento GetPageCompleted) DocumentPage para el número de página especificado y asigna el Id. especificado a la tarea asincrónica.

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)

Parámetros

pageNumber
Int32

Número de página de base cero de DocumentPage que se debe obtener.

userState
Object

Identificador único de la tarea asincrónica.

Excepciones

pageNumber es negativo.

Comentarios

Esta sobrecarga del método permite cancelar esta operación asincrónica sin cancelar todas las operaciones asincrónicas.

Este método genera el GetPageCompleted evento . DocumentPage se pasa al evento como uno de los argumentos del evento.

En los pasos siguientes se muestra cómo recuperar de DocumentPage forma asincrónica:

  1. Cree un GetPageCompletedEventHandler delegado y agréguelo para recibir notificaciones de GetPageCompleted eventos.

  2. Llame a GetPageAsync(Int32, Object) especificando el pageNumber deseado y un único userState, que se usará para identificar la finalización del evento asincrónico.

  3. Cuando se produce el evento y se llama al delegado, compare la propiedad . del evento con el parámetro originaluserStateGetPageAsync(Int32, Object).GetPageCompletedEventArgsUserState (La GetPageCompletedEventArgspropiedad .PageNumber también coincidirá con el pageNumber especificado en la GetPageAsync(Int32, Object) llamada).

  4. Cuando la propiedad .UserState coincide con el GetPageCompletedEventArgsoriginalGetPageAsync(Int32, Object)userState, la operación se completa y la página está lista.

  5. Llame GetPage a para recuperar el formato DocumentPage.

Se aplica a

GetPageAsync(Int32)

De forma asincrónica, devuelve (mediante el evento GetPageCompleted) DocumentPage para el número de página especificado.

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)

Parámetros

pageNumber
Int32

Número de página de base cero de la página del documento que se necesita.

Excepciones

pageNumber es negativo.

Comentarios

La única manera de cancelar la operación asincrónica de este método es cancelar todas las operaciones asincrónicas. Compare esto con la otra sobrecarga de este método: GetPageAsync(Int32, Object).

Este método genera el GetPageCompleted evento . DocumentPage se pasa al evento como uno de los argumentos del evento. Vea GetPageAsync(Int32, Object) cómo usar este método para obtener la página.

Este método almacena en la tarea que devuelve todas las excepciones que no son de uso que puede producir el homólogo sincrónico del método. Si se almacena una excepción en la tarea devuelta, esa excepción se producirá cuando se espere a la tarea. Las excepciones de uso, como ArgumentException, se siguen produciendo de forma sincrónica. Para ver las excepciones almacenadas, vea las excepciones producidas por GetPage(Int32).

Se aplica a