DynamicDocumentPaginator 类

定义

命名空间:

System.Windows.Documents

程序集:

PresentationCore.dll

提供一个抽象基类，除了支持其自己的基类的方法和属性之外，还支持跨重新分页的自动后台分页和跟踪内容位置。

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

继承

Object

DocumentPaginator

DynamicDocumentPaginator

注解

默认情况下，DynamicDocumentPaginator后台会自动预分页内容（此过程从何时IsBackgroundPaginationEnabledtrue开始，即默认设置）。

何时IsBackgroundPaginationEnabledtrue，布局也将因内容更改或更改而PageSize重新进行重新分页。

事件发生 PaginationProgress 在完成一个或多个页面的分页（或重新分页），例如在以下情况下：

• PaginationProgress 事件发生时，内容在后台分页。 根据实现的不同，在分页一个或多个页面时可能发生该事件（PaginationProgressEventArgs 指定哪些页面已分页）。

• GetPage如果指定的页面尚未分页，则调用或GetPageAsync可能导致PaginationProgress发生事件。 例如，如果启用了后台分页（IsBackgroundPaginationEnabled = true但分页仅完成到第三页），则具有参数 6 的 GetPage 调用将导致页 4、5、6 和 7 分页。 完成后，将引发一个PaginationProgress事件，其设置为 PaginationProgressEventArgs = 4 和 Start = Count 4。

• 启用后台分页（IsBackgroundPaginationEnabled = true）， PageSize 更改流格式内容（例如 FlowDocument，可能会导致重新分页和相关 PaginationProgress 事件）。 请注意， PageSize 对固定格式内容（例如 FixedDocument，视觉页面大小不影响布局）的重新绘图没有影响。

PaginationCompleted禁用后台分页时也会发生事件。 例如，如果只有一页内容，并且IsBackgroundPaginationEnabled = falseGetPage调用参数为 0 的调用将导致两个事件：

1. 一个 PaginationProgress 设置为 PaginationProgressEventArgsStart = 0 和 Count = 1 的事件。

2. 一个 PaginationCompleted 事件。

构造函数

名称	说明
DynamicDocumentPaginator()	初始化 DynamicDocumentPaginator 类的新实例。

属性

名称	说明
IsBackgroundPaginationEnabled	获取或设置一个值，该值指示是否在后台自动执行分页以响应某些事件，例如页面大小的变化。
IsPageCountValid	在派生类中重写时，获取一个值，该值指示是否 PageCount 为页总数。 (继承自 DocumentPaginator)
PageCount	在派生类中重写时，获取当前格式化的页数的计数。 (继承自 DocumentPaginator)
PageSize	在派生类中重写时，获取或设置每个页面的建议宽度和高度。 (继承自 DocumentPaginator)
Source	在派生类中重写时，返回正在分页的元素。 (继承自 DocumentPaginator)

方法

名称	说明
CancelAsync(Object)	取消上 GetPageAsync 一个或 GetPageNumberAsync 操作。 (继承自 DocumentPaginator)
ComputePageCount()	强制对内容进行分页，使用新总数进行更新 PageCount ，并将其设置为 IsPageCountValidtrue。 (继承自 DocumentPaginator)
ComputePageCountAsync()	以异步方式强制对内容进行分页、使用新总数进行更新 PageCount 并设置为 IsPageCountValidtrue。 (继承自 DocumentPaginator)
ComputePageCountAsync(Object)	以异步方式强制内容分页，使用新的总计进行更新 PageCount ，设置为 IsPageCountValidtrue。 (继承自 DocumentPaginator)
GetObjectPosition(Object)	在派生类中重写时，返回 ContentPosition 指定的 Object值 。
GetPage(Int32)	在派生类中重写时，获取 DocumentPage 指定页码。 (继承自 DocumentPaginator)
GetPageAsync(Int32, Object)	异步返回指定页码（通过 GetPageCompleted 事件）， DocumentPage 并将指定的 ID 分配给异步任务。 (继承自 DocumentPaginator)
GetPageAsync(Int32)	异步返回指定页码的 （通过 GetPageCompleted 事件） DocumentPage 。 (继承自 DocumentPaginator)
GetPageNumber(ContentPosition)	在派生类中重写时，返回指定 ContentPosition页码的从零开始。
GetPageNumberAsync(ContentPosition, Object)	异步返回 （通过此方法引发 GetPageNumberCompleted 事件） 指定的 ContentPosition从零开始的页码。
GetPageNumberAsync(ContentPosition)	异步返回 （通过此方法引发 GetPageNumberCompleted 事件） 指定的 ContentPosition从零开始的页码。
GetPagePosition(DocumentPage)	在派生类中重写时，获取指定页面在文档内容中的位置。
OnComputePageCountCompleted(AsyncCompletedEventArgs)	引发 ComputePageCountCompleted 事件。 (继承自 DocumentPaginator)
OnGetPageCompleted(GetPageCompletedEventArgs)	引发 GetPageCompleted 事件。 (继承自 DocumentPaginator)
OnGetPageNumberCompleted(GetPageNumberCompletedEventArgs)	引发 GetPageNumberCompleted 事件。
OnPagesChanged(PagesChangedEventArgs)	引发 PagesChanged 事件。 (继承自 DocumentPaginator)
OnPaginationCompleted(EventArgs)	引发 PaginationCompleted 事件。
OnPaginationProgress(PaginationProgressEventArgs)	引发 PaginationProgress 事件。

活动

名称	说明
ComputePageCountCompleted	操作 ComputePageCountAsync 完成时发生。 (继承自 DocumentPaginator)
GetPageCompleted	GetPageAsync完成后发生。 (继承自 DocumentPaginator)
GetPageNumberCompleted	GetPageNumberAsync完成后发生。
PagesChanged	更改文档内容时发生。 (继承自 DocumentPaginator)
PaginationCompleted	当所有文档内容都已分页时发生。
PaginationProgress	在分页一个或多个内容页时发生。