DocumentPaginator Class
Provides an abstract base class that supports creation of multiple-page elements from a single document.
Assembly: PresentationCore (in PresentationCore.dll)
System.Windows.Documents::DocumentPaginator
System.Windows.Annotations::AnnotationDocumentPaginator
System.Windows.Documents::DynamicDocumentPaginator
| Name | Description | |
|---|---|---|
![]() | DocumentPaginator() | Initializes a new instance of the DocumentPaginator class. |
| Name | Description | |
|---|---|---|
![]() | IsPageCountValid | When overridden in a derived class, gets a value indicating whether PageCount is the total number of pages. |
![]() | PageCount | When overridden in a derived class, gets a count of the number of pages currently formatted |
![]() | PageSize | When overridden in a derived class, gets or sets the suggested width and height of each page. |
![]() | Source | When overridden in a derived class, returns the element being paginated. |
| Name | Description | |
|---|---|---|
![]() | CancelAsync(Object^) | Cancels a previous GetPageAsync or DynamicDocumentPaginator::GetPageNumberAsync operation. |
![]() | ComputePageCount() | Forces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to true. |
![]() | ComputePageCountAsync() | Asynchronously, forces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to true. |
![]() | ComputePageCountAsync(Object^) | Asynchronously, forces a pagination of the content, updates PageCount with the new total, sets IsPageCountValid to true. |
![]() | Equals(Object^) | Determines whether the specified object is equal to the current object.(Inherited from Object.) |
![]() | Finalize() | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.) |
![]() | GetHashCode() | Serves as the default hash function. (Inherited from Object.) |
![]() | GetPage(Int32) | When overridden in a derived class, gets the DocumentPage for the specified page number. |
![]() | GetPageAsync(Int32) | Asynchronously returns (through the GetPageCompleted event) the DocumentPage for the specified page number. |
![]() | GetPageAsync(Int32, Object^) | Asynchronously returns (through the GetPageCompleted event) the DocumentPage for the specified page number and assigns the specified ID to the asynchronous task. |
![]() | GetType() | |
![]() | MemberwiseClone() | |
![]() | OnComputePageCountCompleted(AsyncCompletedEventArgs^) | Raises the ComputePageCountCompleted event. |
![]() | OnGetPageCompleted(GetPageCompletedEventArgs^) | Raises the GetPageCompleted event. |
![]() | OnPagesChanged(PagesChangedEventArgs^) | Raises the PagesChanged event. |
![]() | ToString() | Returns a string that represents the current object.(Inherited from Object.) |
| Name | Description | |
|---|---|---|
![]() | ComputePageCountCompleted | Occurs when a ComputePageCountAsync operation has finished. |
![]() | GetPageCompleted | Occurs when GetPageAsync has completed. |
![]() | PagesChanged | Occurs when the document content is changed. |
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.
Available since 3.0
Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.



