DynamicDocumentPaginator Класс

Определение

Предоставление абстрактного базового класса, который поддерживает автоматическую фоновую разбивку на страницы и отслеживание позиций содержимого при разбивке в дополнение к методам и свойствам его собственного базового класса.Provides an abstract base class that supports automatic background pagination and tracking content positions across repaginations in addition to the methods and properties of its own base class.

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

Комментарии

По умолчанию DynamicDocumentPaginator содержимое будет автоматически разбиваться в фоновом режиме (этот процесс начинается IsBackgroundPaginationEnabled , если задано значение true по умолчанию).By default, a DynamicDocumentPaginator will automatically pre-paginate content in the background (this process begins when IsBackgroundPaginationEnabled is true, which is the default setting).

Если IsBackgroundPaginationEnabled имеет значение true , макет также будет репагинатед из-за изменений содержимого или изменений в PageSize .When IsBackgroundPaginationEnabled is true, the layout will also be repaginated due to changes in content or changes in PageSize.

Это PaginationProgress событие возникает при завершении разбивки на страницы (или репагинатион) одной или нескольких страниц, например в следующих ситуациях:The PaginationProgress event occurs upon completion of pagination (or repagination) of one or more pages, such as in the following situations:

  • PaginationProgress события происходят, когда содержимое разбивается на страницы в фоновом режиме.PaginationProgress events occur as content is paginated in the background. В зависимости от реализации событие может произойти после разбивка одной или нескольких страниц ( PaginationProgressEventArgs указывает, какие страницы были страничными).Depending on the implementation, the event may occur upon paginating one or multiple pages (PaginationProgressEventArgs specifies which pages have been paginated).

  • Вызовы метода GetPage или GetPageAsync могут привести к PaginationProgress возникновению события, если указанная страница не была разбита на страницы.Calls to GetPage or GetPageAsync may cause an PaginationProgress event to occur if the page specified has not been paginated. Например, если включена фоновая разбивка на страницы ( IsBackgroundPaginationEnabled = true ), но разбиение на страницы выполняется только на третьей странице, вызов GetPage с аргументом 6 приведет к разбиению страниц на четыре, пять, шесть и семь.For example, if background pagination is enabled (IsBackgroundPaginationEnabled = true) but pagination has only been completed up to the third page, a call of GetPage with an argument of 6 will cause pages four, five, six, and seven to be paginated. После завершения PaginationProgress будет вызвано событие с PaginationProgressEventArgs параметрами Start = 4 и Count = 4.Upon completion, a PaginationProgress event will be raised with PaginationProgressEventArgs settings of Start = 4 and Count = 4.

  • При включении фоновой разбивки на страницы ( IsBackgroundPaginationEnabled = true ) изменение в PageSize содержимом формата потока, например FlowDocument , может вызвать репагинатион и связанные PaginationProgress события.With background pagination enabled (IsBackgroundPaginationEnabled = true), a change in PageSize on flow-format content, such as a FlowDocument, may cause repagination and associated PaginationProgress events. Обратите внимание, что PageSize не оказывает влияния на содержимое фиксированного формата репагинатион, например FixedDocument , когда размер визуальной страницы не влияет на макет.Note that PageSize has no effect in repagination on fixed-format content, such as FixedDocument, where the visual page size does not affect the layout.

PaginationCompletedСобытие также возникает при отключении фоновой разбивки на страницы.A PaginationCompleted event also occurs when background pagination is disabled. Например, если имеется только одна страница содержимого и IsBackgroundPaginationEnabled = false ), вызов GetPage с аргументом, равным 0, приведет к появлению двух событий:For example, if there is only one page of content and IsBackgroundPaginationEnabled = false), calling GetPage with an argument of 0 will result in two events:

  1. PaginationProgressСобытие с PaginationProgressEventArgs параметрами Start = 0 и Count = 1.A PaginationProgress event with PaginationProgressEventArgs settings of Start = 0 and Count = 1.

  2. PaginationCompletedСобытие.A PaginationCompleted event.

Конструкторы

DynamicDocumentPaginator()

Инициализирует новый экземпляр класса DynamicDocumentPaginator.Initializes a new instance of the DynamicDocumentPaginator class.

Свойства

IsBackgroundPaginationEnabled

Возвращает или задает значение, которое показывает автоматическое выполнение разбивки страницы в фоновом режиме в ответ на такие события, как изменения размера страницы.Gets or sets a value indicating whether pagination is performed automatically in the background in response to certain events, such as a change in page size.

IsPageCountValid

Получение значения, указывающего на то, является ли PageCount общим числом страниц, при переопределении в производном классе.When overridden in a derived class, gets a value indicating whether PageCount is the total number of pages.

(Унаследовано от DocumentPaginator)
PageCount

При переопределении в производном классе возвращает число отформатированных на данный момент страниц.When overridden in a derived class, gets a count of the number of pages currently formatted.

(Унаследовано от DocumentPaginator)
PageSize

Получает или задает варианта ширины и высоты каждой страницы при переопределении в производном классе.When overridden in a derived class, gets or sets the suggested width and height of each page.

(Унаследовано от DocumentPaginator)
Source

Возвращение разбиваемого на страницы элемента при переопределении в производном классе.When overridden in a derived class, returns the element being paginated.

(Унаследовано от DocumentPaginator)

Методы

CancelAsync(Object)

Отмена предыдущей операции GetPageAsync или GetPageNumberAsync.Cancels a previous GetPageAsync or GetPageNumberAsync operation.

(Унаследовано от DocumentPaginator)
ComputePageCount()

Обеспечивает разбиение содержимого на страницы, обновляет PageCount новым значением общего количества страниц и присваивает IsPageCountValid значение true.Forces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to true.

(Унаследовано от DocumentPaginator)
ComputePageCountAsync()

Асинхронный вызов разбивки содержимого на страницы, обновления PageCount новой суммой и установки IsPageCountValid на значение true.Asynchronously, forces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to true.

(Унаследовано от DocumentPaginator)
ComputePageCountAsync(Object)

Асинхронный вызов разбивки содержимого на страницы, обновления PageCount новой суммой и установки IsPageCountValid на значение true.Asynchronously, forces a pagination of the content, updates PageCount with the new total, sets IsPageCountValid to true.

(Унаследовано от DocumentPaginator)
Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetObjectPosition(Object)

При переопределении в производном классе возвращает ContentPosition для заданного Object.When overridden in a derived class, returns a ContentPosition for the specified Object.

GetPage(Int32)

Получение DocumentPage для заданного номера страницы при переопределении в производном классе.When overridden in a derived class, gets the DocumentPage for the specified page number.

(Унаследовано от DocumentPaginator)
GetPageAsync(Int32)

Асинхронное возвращение (посредством события GetPageCompleted) DocumentPage для заданного номера страницы.Asynchronously returns (through the GetPageCompleted event) the DocumentPage for the specified page number.

(Унаследовано от DocumentPaginator)
GetPageAsync(Int32, Object)

Асинхронное возвращение (посредством события GetPageCompleted) DocumentPage для заданного номера страницы и назначение заданного идентификатора для асинхронной задачи.Asynchronously returns (through the GetPageCompleted event) the DocumentPage for the specified page number and assigns the specified ID to the asynchronous task.

(Унаследовано от DocumentPaginator)
GetPageNumber(ContentPosition)

При переопределении в производном классе возвращает начинающийся с нуля номер страницы для заданного ContentPosition.When overridden in a derived class, returns the zero-based page number of the specified ContentPosition.

GetPageNumberAsync(ContentPosition)

Асинхронный возврат (данный метод вызывает событие GetPageNumberCompleted) начинающегося с нуля номера страницы заданного ContentPosition.Asynchronously, returns (through the This method raises the GetPageNumberCompleted event) the zero-based page number of the specified ContentPosition.

GetPageNumberAsync(ContentPosition, Object)

Асинхронный возврат (данный метод вызывает событие GetPageNumberCompleted) начинающегося с нуля номера страницы заданного ContentPosition.Asynchronously, returns (through the This method raises the GetPageNumberCompleted event) the zero-based page number of the specified ContentPosition.

GetPagePosition(DocumentPage)

При переопределении в производном классе получает положение заданной страницы в содержимом документа.When overridden in a derived class, gets the position of the specified page in the document's content.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
OnComputePageCountCompleted(AsyncCompletedEventArgs)

Вызывает событие ComputePageCountCompleted.Raises the ComputePageCountCompleted event.

(Унаследовано от DocumentPaginator)
OnGetPageCompleted(GetPageCompletedEventArgs)

Вызывает событие GetPageCompleted.Raises the GetPageCompleted event.

(Унаследовано от DocumentPaginator)
OnGetPageNumberCompleted(GetPageNumberCompletedEventArgs)

Вызывает событие GetPageNumberCompleted.Raises the GetPageNumberCompleted event.

OnPagesChanged(PagesChangedEventArgs)

Вызывает событие PagesChanged.Raises the PagesChanged event.

(Унаследовано от DocumentPaginator)
OnPaginationCompleted(EventArgs)

Вызывает событие PaginationCompleted.Raises the PaginationCompleted event.

OnPaginationProgress(PaginationProgressEventArgs)

Вызывает событие PaginationProgress.Raises the PaginationProgress event.

ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

События

ComputePageCountCompleted

Происходит при завершении операции ComputePageCountAsync.Occurs when a ComputePageCountAsync operation has finished.

(Унаследовано от DocumentPaginator)
GetPageCompleted

Происходит после завершения работы метода GetPageAsync.Occurs when GetPageAsync has completed.

(Унаследовано от DocumentPaginator)
GetPageNumberCompleted

Происходит после завершения работы метода GetPageNumberAsync.Occurs when GetPageNumberAsync has completed.

PagesChanged

Происходит при изменении содержимого документа.Occurs when the document content is changed.

(Унаследовано от DocumentPaginator)
PaginationCompleted

Происходит после разбивки всего содержимого документа.Occurs when all document content has been paginated.

PaginationProgress

Происходит при разбивке одной или более страниц содержимого.Occurs when one or more content pages have been paginated.

Применяется к