DocumentPaginator.GetPageAsync Método
Definição
Importante
Algumas informações dizem respeito a um produto pré-lançado que pode ser substancialmente modificado antes de ser lançado. A Microsoft não faz garantias, de forma expressa ou implícita, em relação à informação aqui apresentada.
Devolve assíncronamente o DocumentPage para o número de página especificado.
Sobrecargas
| Name | Description |
|---|---|
| GetPageAsync(Int32, Object) |
Retorna assíncronamente (através do GetPageCompleted evento) o DocumentPage para o número de página especificado e atribui o ID especificado à tarefa assíncrona. |
| GetPageAsync(Int32) |
Devolve assíncronamente (através do GetPageCompleted evento) o DocumentPage para o número de página especificado. |
GetPageAsync(Int32, Object)
Retorna assíncronamente (através do GetPageCompleted evento) o DocumentPage para o número de página especificado e atribui o ID especificado à 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 para obter.
- userState
- Object
Um identificador único para a tarefa assíncrona.
Exceções
pageNumber é negativo.
Observações
Esta sobrecarga do método permite cancelar esta operação assíncrona sem cancelar todas as operações assíncronas.
Este método eleva o GetPageCompleted evento. O DocumentPage é passado ao evento como um dos argumentos do evento.
Os passos seguintes ilustram como recuperar um assíncrono DocumentPage :
Crie um GetPageCompletedEventHandler delegado e adicione-o para ser notificado dos GetPageCompleted eventos.
Chamada GetPageAsync(Int32, Object) que especifica o
pageNumberdesejado e um únicouserState, que será usado para identificar a conclusão do evento assíncrono.Quando o evento ocorre e o delegado é chamado, compara a propriedade . do GetPageCompletedEventArgsevento com o parâmetro originalGetPageAsync(Int32, Object)
userState.UserState (A GetPageCompletedEventArgspropriedade .PageNumber também corresponderá aopageNumberespecificado na GetPageAsync(Int32, Object) chamada.)Quando a GetPageCompletedEventArgspropriedade .UserState corresponde à original GetPageAsync(Int32, Object)
userState, a operação está completa e a página está pronta.Ligue GetPage para recuperar o arquivo formatado DocumentPage.
Aplica-se a
GetPageAsync(Int32)
Devolve assíncronamente (através do GetPageCompleted evento) o DocumentPage para o 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
O número de página baseado em zero da página do documento que é necessário.
Exceções
pageNumber é negativo.
Observações
A única forma de cancelar a operação assíncrona deste método é cancelar todas as operações assíncronas. Compare isto com a outra sobrecarga deste método: GetPageAsync(Int32, Object).
Este método eleva o GetPageCompleted evento. O DocumentPage é passado ao evento como um dos argumentos do evento. Veja GetPageAsync(Int32, Object) como usar este método para obter a página.
Este método armazena na tarefa que devolve todas as exceções de não-utilização que o equivalente síncrono do método pode lançar. Se uma exceção for armazenada na tarefa devolvida, essa exceção será lançada quando a tarefa for aguardada. As exceções de uso, como ArgumentException, ainda são lançadas de forma síncrona. Para as exceções armazenadas, veja as exceções lançadas por GetPage(Int32).