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开始，这是) 默认设置。

当 为 true时IsBackgroundPaginationEnabled，布局也将由于 内容更改或 中的PageSize更改而重新绘制。

在 PaginationProgress 完成一个或多个页面的分页 (或重页) 时发生该事件，例如在以下情况下：

• PaginationProgress 在后台对内容进行分页时发生事件。 根据实现，在分页一个或多个页面时可能会发生该事件， (PaginationProgressEventArgs 指定哪些页面已) 分页。

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

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

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

1. 一个PaginationProgress设置为 Start = 0 且 Count = 1 的事件PaginationProgressEventArgs。

2. 事件 PaginationCompleted 。

构造函数

DynamicDocumentPaginator()

初始化 DynamicDocumentPaginator 类的新实例。

属性

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

方法

CancelAsync(Object)	取消前一个 GetPageAsync 或 GetPageNumberAsync 操作。 (继承自 DocumentPaginator)
ComputePageCount()	强制对内容进行分页，用新的总页数更新 PageCount，并将 IsPageCountValid 设置为 true。 (继承自 DocumentPaginator)
ComputePageCountAsync()	通过异步方式强制对内容进行分页，用新的总页数更新 PageCount，并将 IsPageCountValid 设置为 true。 (继承自 DocumentPaginator)
ComputePageCountAsync(Object)	通过异步方式强制对内容进行分页，用新的总页数更新 PageCount，并将 IsPageCountValid 设置为 true。 (继承自 DocumentPaginator)
Equals(Object)	确定指定对象是否等于当前对象。 (继承自 Object)
GetHashCode()	作为默认哈希函数。 (继承自 Object)
GetObjectPosition(Object)	在派生类中重写时，返回指定 ContentPosition 的 Object。
GetPage(Int32)	当在派生类中重写时，获取指定页码的 DocumentPage。 (继承自 DocumentPaginator)
GetPageAsync(Int32)	（通过 GetPageCompleted 事件）异步返回指定页码的 DocumentPage。 (继承自 DocumentPaginator)
GetPageAsync(Int32, Object)	（通过 GetPageCompleted 事件）异步返回指定页码的 DocumentPage，并将指定的 ID 分配给异步任务。 (继承自 DocumentPaginator)
GetPageNumber(ContentPosition)	在派生类中重写时，返回指定 ContentPosition 的从零开始的页码。
GetPageNumberAsync(ContentPosition)	（通过此方法引发 GetPageNumberCompleted 事件）异步返回指定 ContentPosition 的从零开始的页码。
GetPageNumberAsync(ContentPosition, Object)	（通过此方法引发 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	当已对一个或多个内容页进行分页时发生。