DynamicDocumentPaginator Classe
Definição
Importante
Algumas informações se referem a produtos de pré-lançamento que podem ser substancialmente modificados antes do lançamento. A Microsoft não oferece garantias, expressas ou implícitas, das informações aqui fornecidas.
Fornece uma classe base abstrata que dá suporte à paginação automática em segundo plano e ao acompanhamento de posições de conteúdo entre reaginações, além dos métodos e propriedades de sua própria classe base.
public ref class DynamicDocumentPaginator abstract : System::Windows::Documents::DocumentPaginatorpublic abstract class DynamicDocumentPaginator : System.Windows.Documents.DocumentPaginatortype DynamicDocumentPaginator = class
inherit DocumentPaginatorPublic MustInherit Class DynamicDocumentPaginator
Inherits DocumentPaginator- Herança
Comentários
Por padrão, um DynamicDocumentPaginator pré-paginará automaticamente o conteúdo em segundo plano (esse processo começa quando IsBackgroundPaginationEnabled é true, que é a configuração padrão).
Quando IsBackgroundPaginationEnabled fortrue, o layout também será repaginado devido a alterações no conteúdo ou alterações.PageSize
O PaginationProgress evento ocorre após a conclusão da paginação (ou reaginação) de uma ou mais páginas, como nas seguintes situações:
PaginationProgress os eventos ocorrem à medida que o conteúdo é paginado em segundo plano. Dependendo da implementação, o evento pode ocorrer após paginar uma ou várias páginas (PaginationProgressEventArgs especifica quais páginas foram paginadas).
Chamadas para GetPage ou GetPageAsync podem fazer com que um PaginationProgress evento ocorra se a página especificada não tiver sido paginada. Por exemplo, se a paginação em segundo plano estiver habilitada (IsBackgroundPaginationEnabled =
true), mas a paginação tiver sido concluída apenas até a terceira página, uma chamada GetPage com um argumento de 6 fará com que as páginas quatro, cinco, seis e sete sejam paginadas. Após a conclusão, um PaginationProgress evento será gerado com PaginationProgressEventArgs configurações de Start = 4 e Count = 4.Com a paginação em segundo plano habilitada (IsBackgroundPaginationEnabled =
true), uma alteração no conteúdo em PageSize formato de fluxo, como um FlowDocument, pode causar reaginação e eventos associados.PaginationProgress Observe que não tem nenhum efeito na reaginação no conteúdo de formato fixo, como FixedDocument, em que PageSize o tamanho da página visual não afeta o layout.
Um PaginationCompleted evento também ocorre quando a paginação em segundo plano é desabilitada. Por exemplo, se houver apenas uma página de conteúdo e IsBackgroundPaginationEnabled = false), a chamada GetPage com um argumento 0 resultará em dois eventos:
Um PaginationProgress evento com PaginationProgressEventArgs configurações de Start = 0 e Count = 1.
Um PaginationCompleted evento.
Construtores
| Nome | Description |
|---|---|
| DynamicDocumentPaginator() |
Inicializa uma nova instância da classe DynamicDocumentPaginator. |
Propriedades
| Nome | Description |
|---|---|
| IsBackgroundPaginationEnabled |
Obtém ou define um valor que indica se a paginação é executada automaticamente em segundo plano em resposta a determinados eventos, como uma alteração no tamanho da página. |
| IsPageCountValid |
Quando substituído em uma classe derivada, obtém um valor que indica se PageCount é o número total de páginas. (Herdado de DocumentPaginator) |
| PageCount |
Quando substituído em uma classe derivada, obtém uma contagem do número de páginas formatadas no momento. (Herdado de DocumentPaginator) |
| PageSize |
Quando substituído em uma classe derivada, obtém ou define a largura e a altura sugeridas de cada página. (Herdado de DocumentPaginator) |
| Source |
Quando substituído em uma classe derivada, retorna o elemento que está sendo paginado. (Herdado de DocumentPaginator) |
Métodos
| Nome | Description |
|---|---|
| CancelAsync(Object) |
Cancela uma operação ou GetPageNumberAsync anteriorGetPageAsync. (Herdado de DocumentPaginator) |
| ComputePageCount() |
Força uma paginação do conteúdo, atualiza PageCount com o novo total e define IsPageCountValid como |
| ComputePageCountAsync() |
De forma assíncrona, força uma paginação do conteúdo, atualiza PageCount com o novo total e define IsPageCountValid como |
| ComputePageCountAsync(Object) |
De forma assíncrona, força uma paginação do conteúdo, atualiza PageCount com o novo total, define IsPageCountValid como |
| Equals(Object) |
Determina se o objeto especificado é igual ao objeto atual. (Herdado de Object) |
| GetHashCode() |
Serve como a função hash predefinida. (Herdado de Object) |
| GetObjectPosition(Object) |
Quando substituído em uma classe derivada, retorna um ContentPosition para o especificado Object. |
| GetPage(Int32) |
Quando substituído em uma classe derivada, obtém o DocumentPage número da página especificado. (Herdado de DocumentPaginator) |
| 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. (Herdado de DocumentPaginator) |
| GetPageAsync(Int32) |
Retorna de forma assíncrona (por meio do GetPageCompleted evento) o DocumentPage número da página especificado. (Herdado de DocumentPaginator) |
| GetPageNumber(ContentPosition) |
Quando substituído em uma classe derivada, retorna o número de página baseado em zero do especificado ContentPosition. |
| GetPageNumberAsync(ContentPosition, Object) |
De forma assíncrona, retorna (por meio do método This gera o GetPageNumberCompleted evento) o número de página baseado em zero do especificado ContentPosition. |
| GetPageNumberAsync(ContentPosition) |
De forma assíncrona, retorna (por meio do método This gera o GetPageNumberCompleted evento) o número de página baseado em zero do especificado ContentPosition. |
| GetPagePosition(DocumentPage) |
Quando substituído em uma classe derivada, obtém a posição da página especificada no conteúdo do documento. |
| GetType() |
Obtém o Type da instância atual. (Herdado de Object) |
| MemberwiseClone() |
Cria uma cópia superficial do Objectatual. (Herdado de Object) |
| OnComputePageCountCompleted(AsyncCompletedEventArgs) |
Aciona o evento ComputePageCountCompleted. (Herdado de DocumentPaginator) |
| OnGetPageCompleted(GetPageCompletedEventArgs) |
Aciona o evento GetPageCompleted. (Herdado de DocumentPaginator) |
| OnGetPageNumberCompleted(GetPageNumberCompletedEventArgs) |
Aciona o evento GetPageNumberCompleted. |
| OnPagesChanged(PagesChangedEventArgs) |
Aciona o evento PagesChanged. (Herdado de DocumentPaginator) |
| OnPaginationCompleted(EventArgs) |
Aciona o evento PaginationCompleted. |
| OnPaginationProgress(PaginationProgressEventArgs) |
Aciona o evento PaginationProgress. |
| ToString() |
Retorna uma cadeia de caracteres que representa o objeto atual. (Herdado de Object) |
Eventos
| Nome | Description |
|---|---|
| ComputePageCountCompleted |
Ocorre quando uma ComputePageCountAsync operação é concluída. (Herdado de DocumentPaginator) |
| GetPageCompleted |
Ocorre quando GetPageAsync concluído. (Herdado de DocumentPaginator) |
| GetPageNumberCompleted |
Ocorre quando GetPageNumberAsync concluído. |
| PagesChanged |
Ocorre quando o conteúdo do documento é alterado. (Herdado de DocumentPaginator) |
| PaginationCompleted |
Ocorre quando todo o conteúdo do documento foi paginado. |
| PaginationProgress |
Ocorre quando uma ou mais páginas de conteúdo foram paginadas. |