DynamicDocumentPaginator Класс
Определение
Важно!
Некоторые сведения относятся к предварительной версии продукта, в которую до выпуска могут быть внесены существенные изменения. Майкрософт не предоставляет никаких гарантий, явных или подразумеваемых, относительно приведенных здесь сведений.
Предоставляет абстрактный базовый класс, который поддерживает автоматическую разбивку на страницы фона и отслеживание позиций содержимого в дополнение к методам и свойствам собственного базового класса.
public ref class DynamicDocumentPaginator abstract : System::Windows::Documents::DocumentPaginator
public abstract class DynamicDocumentPaginator : System.Windows.Documents.DocumentPaginator
type DynamicDocumentPaginator = class
inherit DocumentPaginator
Public MustInherit Class DynamicDocumentPaginator
Inherits DocumentPaginator
- Наследование
Комментарии
По умолчанию DynamicDocumentPaginator автоматически выполняется предварительная разбивка содержимого в фоновом режиме (этот процесс начинается, когда IsBackgroundPaginationEnabled это trueпараметр по умолчанию).
Если IsBackgroundPaginationEnabled это trueтак, макет также будет переоплачен из-за изменений содержимого или изменений в PageSize.
Событие PaginationProgress происходит после завершения разбиения на страницы (или повторной обработки) одной или нескольких страниц, например в следующих ситуациях:
PaginationProgress события происходят так, как содержимое разбиается на страницы в фоновом режиме. В зависимости от реализации событие может возникать при разбиении на страницы одной или нескольких страниц (PaginationProgressEventArgs указывает, какие страницы были разбиены на страницы).
GetPage Вызовы или GetPageAsync могут привести PaginationProgress к возникновению события, если указанная страница не была разбина на страницы. Например, если фоновая разбивка на страницы включена (IsBackgroundPaginationEnabled =
true), но разбивка на страницы завершена только до третьей страницы, вызов GetPage аргумента 6 приведет к тому, что страницы четыре, пять, шесть и семь будут разбиены на страницы. По завершении PaginationProgress событие будет возникать с PaginationProgressEventArgs параметрами Start = 4 и Count = 4.Если включена фоновая разбиение на IsBackgroundPaginationEnabled страницы ( =
truePageSize), изменение содержимого в формате потока, напримерFlowDocument, может привести к повторному заполнению и связанным PaginationProgress событиям. Обратите внимание, что PageSize при повторном просмотре содержимого фиксированного формата не влияет, например FixedDocument, если размер визуальной страницы не влияет на макет.
Событие PaginationCompleted также возникает при отключении фоновой разбивки на страницы. Например, если есть только одна страница содержимого и IsBackgroundPaginationEnabled = falseвызов GetPage с аргументом 0 приведет к двум событиям:
PaginationProgress Событие с PaginationProgressEventArgs параметрами Start = 0 и Count = 1.
PaginationCompleted Событие.
Конструкторы
| Имя. | Описание |
|---|---|
| DynamicDocumentPaginator() |
Инициализирует новый экземпляр класса DynamicDocumentPaginator. |
Свойства
| Имя. | Описание |
|---|---|
| IsBackgroundPaginationEnabled |
Возвращает или задает значение, указывающее, выполняется ли разбиение на страницы автоматически в фоновом режиме в ответ на определенные события, например изменение размера страницы. |
| IsPageCountValid |
При переопределении в производном классе получает значение, указывающее, является ли PageCount общее количество страниц. (Унаследовано от DocumentPaginator) |
| PageCount |
При переопределении в производном классе получает количество страниц, отформатированных в данный момент. (Унаследовано от DocumentPaginator) |
| PageSize |
При переопределении в производном классе получает или задает рекомендуемую ширину и высоту каждой страницы. (Унаследовано от DocumentPaginator) |
| Source |
При переопределении в производном классе возвращает элемент с разбивкой на страницы. (Унаследовано от DocumentPaginator) |
Методы
| Имя. | Описание |
|---|---|
| CancelAsync(Object) |
Отменяет предыдущую GetPageAsync или GetPageNumberAsync операцию. (Унаследовано от DocumentPaginator) |
| ComputePageCount() |
Принудительно выполняет разбивку на страницы содержимого, обновляется PageCount с новым итогом и задает IsPageCountValid значение |
| ComputePageCountAsync() |
Асинхронно принудительно выполняет разбиение на страницы содержимого, обновляется PageCount с новым итогом и задает IsPageCountValid значение |
| ComputePageCountAsync(Object) |
Асинхронно принудительно выполняет разбиение на страницы содержимого, обновляется PageCount с новым итогом, задает IsPageCountValid значение |
| Equals(Object) |
Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object) |
| GetHashCode() |
Служит хэш-функцией по умолчанию. (Унаследовано от Object) |
| GetObjectPosition(Object) |
При переопределении в производном классе возвращает ContentPosition значение для указанного Object. |
| GetPage(Int32) |
При переопределении в производном классе получает DocumentPage значение для указанного номера страницы. (Унаследовано от DocumentPaginator) |
| GetPageAsync(Int32, Object) |
Асинхронно возвращает (через GetPageCompleted событие) DocumentPage указанный номер страницы и назначает указанный идентификатор асинхронной задаче. (Унаследовано от DocumentPaginator) |
| GetPageAsync(Int32) |
Асинхронно возвращает (через событие) GetPageCompleted указанный DocumentPage номер страницы. (Унаследовано от DocumentPaginator) |
| GetPageNumber(ContentPosition) |
При переопределении в производном классе возвращает отсчитываемый от нуля номер страниц указанного ContentPosition. |
| GetPageNumberAsync(ContentPosition, Object) |
Асинхронно возвращает (через этот метод вызывает GetPageNumberCompleted событие) нулевые номера страниц указанного.ContentPosition |
| GetPageNumberAsync(ContentPosition) |
Асинхронно возвращает (через этот метод вызывает GetPageNumberCompleted событие) нулевые номера страниц указанного.ContentPosition |
| GetPagePosition(DocumentPage) |
При переопределении в производном классе получает положение указанной страницы в содержимом документа. |
| GetType() |
Возвращает Type текущего экземпляра. (Унаследовано от Object) |
| MemberwiseClone() |
Создает неглубокую копию текущей Object. (Унаследовано от Object) |
| OnComputePageCountCompleted(AsyncCompletedEventArgs) |
Вызывает событие ComputePageCountCompleted. (Унаследовано от DocumentPaginator) |
| OnGetPageCompleted(GetPageCompletedEventArgs) |
Вызывает событие GetPageCompleted. (Унаследовано от DocumentPaginator) |
| OnGetPageNumberCompleted(GetPageNumberCompletedEventArgs) |
Вызывает событие GetPageNumberCompleted. |
| OnPagesChanged(PagesChangedEventArgs) |
Вызывает событие PagesChanged. (Унаследовано от DocumentPaginator) |
| OnPaginationCompleted(EventArgs) |
Вызывает событие PaginationCompleted. |
| OnPaginationProgress(PaginationProgressEventArgs) |
Вызывает событие PaginationProgress. |
| ToString() |
Возвращает строку, представляющую текущий объект. (Унаследовано от Object) |
События
| Имя. | Описание |
|---|---|
| ComputePageCountCompleted |
Происходит после ComputePageCountAsync завершения операции. (Унаследовано от DocumentPaginator) |
| GetPageCompleted |
Происходит при GetPageAsync завершении. (Унаследовано от DocumentPaginator) |
| GetPageNumberCompleted |
Происходит при GetPageNumberAsync завершении. |
| PagesChanged |
Происходит при изменении содержимого документа. (Унаследовано от DocumentPaginator) |
| PaginationCompleted |
Происходит, когда все содержимое документа было разбиено на страницы. |
| PaginationProgress |
Происходит при разбиении на страницы одного или нескольких страниц содержимого. |