Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

DocumentPaginator Class

Provides an abstract base class that supports creation of multiple-page elements from a single document.

Namespace:  System.Windows.Documents
Assembly:  PresentationCore (in PresentationCore.dll)
public abstract class DocumentPaginator

The DocumentPaginator type exposes the following members.

  NameDescription
Protected methodDocumentPaginatorInitializes a new instance of the DocumentPaginator class.
Top
  NameDescription
Public propertyIsPageCountValidWhen overridden in a derived class, gets a value indicating whether PageCount is the total number of pages.
Public propertyPageCountWhen overridden in a derived class, gets a count of the number of pages currently formatted
Public propertyPageSizeWhen overridden in a derived class, gets or sets the suggested width and height of each page.
Public propertySourceWhen overridden in a derived class, returns the element being paginated.
Top
  NameDescription
Public methodCancelAsyncCancels a previous GetPageAsync or DynamicDocumentPaginator.GetPageNumberAsync operation.
Public methodComputePageCountForces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to true.
Public methodComputePageCountAsync()Asynchronously, forces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to true.
Public methodComputePageCountAsync(Object)Asynchronously, forces a pagination of the content, updates PageCount with the new total, sets IsPageCountValid to true.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetPageWhen overridden in a derived class, gets the DocumentPage for the specified page number.
Public methodGetPageAsync(Int32)Asynchronously returns (through the GetPageCompleted event) the DocumentPage for the specified page number.
Public methodGetPageAsync(Int32, Object)Asynchronously returns (through the GetPageCompleted event) the DocumentPage for the specified page number and assigns the specified ID to the asynchronous task.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodOnComputePageCountCompletedRaises the ComputePageCountCompleted event.
Protected methodOnGetPageCompletedRaises the GetPageCompleted event.
Protected methodOnPagesChangedRaises the PagesChanged event.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top
  NameDescription
Public eventComputePageCountCompletedOccurs when a ComputePageCountAsync operation has finished.
Public eventGetPageCompletedOccurs when GetPageAsync has completed.
Public eventPagesChangedOccurs when the document content is changed.
Top

If you need automatic background repagination in response to events such as changing the page size of a FlowDocument, then use DynamicDocumentPaginator as your base class.

.NET Framework

Supported in: 4.5.1, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows Phone 8.1, Windows Phone 8, Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.