Compartilhar via


DocumentPaginator.GetPageAsync Método

Definição

Retorna de forma assíncrona o DocumentPage número da página especificado.

Sobrecargas

Nome Description
GetPageAsync(Int32, Object)

Retorna de forma assíncrona (por meio do GetPageCompleted evento) o DocumentPage número da página especificado e atribui a ID especificada à tarefa assíncrona.

GetPageAsync(Int32)

Retorna de forma assíncrona (por meio do GetPageCompleted evento) o DocumentPage número da página especificado.

GetPageAsync(Int32, Object)

Retorna de forma assíncrona (por meio do GetPageCompleted evento) o DocumentPage número da página especificado e atribui a ID especificada à tarefa assíncrona.

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

O número de página baseado em zero do DocumentPage a ser obtido.

userState
Object

Um identificador exclusivo para a tarefa assíncrona.

Exceções

pageNumber é negativo.

Comentários

Essa sobrecarga do método possibilita cancelar essa operação assíncrona sem cancelar todas as operações assíncronas.

Esse método gera o GetPageCompleted evento. O DocumentPage evento é passado como um dos argumentos do evento.

As etapas a seguir ilustram como recuperar de DocumentPage forma assíncrona:

  1. Crie um GetPageCompletedEventHandler delegado e adicione-o para ser notificado sobre GetPageCompleted eventos.

  2. Chame GetPageAsync(Int32, Object) especificando o pageNumber desejado e um exclusivo userState, que será usado para identificar a conclusão do evento assíncrono.

  3. Quando o evento ocorrer e o delegado for chamado, compare a propriedade . do evento com o parâmetro originaluserStateGetPageAsync(Int32, Object).GetPageCompletedEventArgsUserState (A GetPageCompletedEventArgspropriedade .PageNumber também corresponderá à pageNumber especificada na GetPageAsync(Int32, Object) chamada.)

  4. Quando a GetPageCompletedEventArgspropriedade .UserState corresponde ao original GetPageAsync(Int32, Object)userState, a operação é concluída e a página está pronta.

  5. Chamada GetPage para recuperar o formato DocumentPage.

Aplica-se a

GetPageAsync(Int32)

Retorna de forma assíncrona (por meio do GetPageCompleted evento) o DocumentPage número da 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

O número de página baseado em zero da página do documento que é necessário.

Exceções

pageNumber é negativo.

Comentários

A única maneira de cancelar a operação assíncrona desse método é cancelar todas as operações assíncronas. Contraste isso com a outra sobrecarga deste método: GetPageAsync(Int32, Object).

Esse método gera o GetPageCompleted evento. O DocumentPage evento é passado como um dos argumentos do evento. Veja GetPageAsync(Int32, Object) como usar esse método para obter a página.

Esse método armazena na tarefa que retorna todas as exceções de não uso que o equivalente síncrono do método pode gerar. Se uma exceção for armazenada na tarefa retornada, essa exceção será gerada quando a tarefa for aguardada. Exceções de uso, como ArgumentException, ainda são geradas de forma síncrona. Para as exceções armazenadas, consulte as exceções geradas por GetPage(Int32).

Aplica-se a