DocumentPaginator.GetPageAsync Método

Definição

Namespace:

System.Windows.Documents

Assembly:

PresentationCore.dll

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

Sobrecargas

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

GetPageAsync(Int32, Object)

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

public virtual void GetPageAsync (int pageNumber, object userState);

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

ArgumentOutOfRangeException

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 evento GetPageCompleted. O DocumentPage é passado para o evento como um dos argumentos do evento.

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

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

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

3. Quando o evento ocorre e o delegado é chamado, compare o GetPageCompletedEventArgsdo evento.UserState propriedade com o parâmetro de GetPageAsync(Int32, Object)userState original. (A propriedade GetPageCompletedEventArgs.PageNumber também corresponderá ao pageNumber especificado na chamada GetPageAsync(Int32, Object).)

4. Quando o GetPageCompletedEventArgs.UserState propriedade corresponde ao GetPageAsync(Int32, Object)userStateoriginal, a operação está concluída e a página está pronta.

5. Chame GetPage para recuperar o DocumentPageformatado.

GetPageAsync(Int32)

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

public virtual void GetPageAsync (int pageNumber);

Parâmetros

pageNumber

Int32

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

Exceções

ArgumentOutOfRangeException

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 evento GetPageCompleted. O DocumentPage é passado para o evento como um dos argumentos do evento. Consulte GetPageAsync(Int32, Object) de 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).