DocumentPaginator.GetPageAsync Método

Definición

Espacio de nombres:

System.Windows.Documents

Ensamblado:

PresentationCore.dll

Devuelve de forma asincrónica el DocumentPage del número de página especificado.

Sobrecargas

GetPageAsync(Int32, Object)	Devuelve de forma asincrónica (a través del evento GetPageCompleted) el DocumentPage del número de página especificado y asigna el identificador especificado a la tarea asincrónica.
GetPageAsync(Int32)	Devuelve de forma asincrónica (a través del evento GetPageCompleted) el DocumentPage del número de página especificado.

GetPageAsync(Int32, Object)

Devuelve de forma asincrónica (a través del evento GetPageCompleted) el DocumentPage del número de página especificado y asigna el identificador 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 del DocumentPage que se va a obtener.

userState

Object

Identificador único de la tarea asincrónica.

Excepciones

ArgumentOutOfRangeException

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 evento GetPageCompleted. El DocumentPage se pasa al evento como uno de los argumentos del evento.

Los pasos siguientes muestran cómo recuperar un DocumentPage de forma asincrónica:

1. Cree un delegado GetPageCompletedEventHandler y agréguelo para recibir una notificación de eventos GetPageCompleted.

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

3. Cuando se produce el evento y se llama al delegado, compare el GetPageCompletedEventArgsdel evento .UserState propiedad con el parámetro GetPageAsync(Int32, Object)userState original. (La propiedad GetPageCompletedEventArgs.PageNumber también coincidirá con el pageNumber especificado en la llamada a GetPageAsync(Int32, Object)).

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

5. Llame a GetPage para recuperar el DocumentPagecon formato .

GetPageAsync(Int32)

Devuelve de forma asincrónica (a través del evento GetPageCompleted) el DocumentPage del 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

ArgumentOutOfRangeException

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. Contraste esto con la otra sobrecarga de este método: GetPageAsync(Int32, Object).

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

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