This documentation is archived and is not being maintained.

DynamicDocumentPaginator Class

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.

Namespace: System.Windows.Documents
Assembly: PresentationCore (in presentationcore.dll)
XML Namespace:

public abstract class DynamicDocumentPaginator : DocumentPaginator
public abstract class DynamicDocumentPaginator extends DocumentPaginator
public abstract class DynamicDocumentPaginator extends DocumentPaginator
This class is abstract; see Inheritance Hierarchy for derived non-abstract classes usable in XAML.

By default, a DynamicDocumentPaginator will automatically pre-paginate content in the background (this process begins when IsBackgroundPaginationEnabled is true, which is the default setting).

When IsBackgroundPaginationEnabled is true, the layout will also be repaginated due to changes in content or changes in PageSize.

The PaginationProgress event occurs upon completion of pagination (or repagination) of one or more pages, such as in the following situations:

  • PaginationProgress events occur as content is paginated in the background. Depending on the implementation, the event may occur upon paginating one or multiple pages (PaginationProgressEventArgs specifies which pages have been paginated).

  • Calls to GetPage or GetPageAsync may cause an PaginationProgress event to occur if the page specified has not been paginated. 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. Upon completion, a PaginationProgress event will be raised with PaginationProgressEventArgs settings of Start = 4 and Count = 4.

  • 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. 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.

A PaginationCompleted event also occurs when background pagination is disabled. 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. A PaginationProgress event with PaginationProgressEventArgs settings of Start = 0 and Count = 1.

  2. A PaginationCompleted event.


Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0