DocumentPaginator Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides an abstract base class that supports creation of multiple-page elements from a single document.
public ref class DocumentPaginator abstractpublic abstract class DocumentPaginatortype DocumentPaginator = classPublic MustInherit Class DocumentPaginator- Inheritance
-
DocumentPaginator
- Derived
Remarks
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.
Constructors
| Name | Description |
|---|---|
| DocumentPaginator() |
Initializes a new instance of the DocumentPaginator class. |
Properties
| 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. |
Methods
| Name | Description |
|---|---|
| CancelAsync(Object) |
Cancels a previous GetPageAsync or GetPageNumberAsync operation. |
| ComputePageCount() |
Forces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to |
| ComputePageCountAsync() |
Asynchronously, forces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to |
| ComputePageCountAsync(Object) |
Asynchronously, forces a pagination of the content, updates PageCount with the new total, sets IsPageCountValid to |
| GetPage(Int32) |
When overridden in a derived class, gets 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. |
| GetPageAsync(Int32) |
Asynchronously returns (through the GetPageCompleted event) the DocumentPage for the specified page number. |
| OnComputePageCountCompleted(AsyncCompletedEventArgs) |
Raises the ComputePageCountCompleted event. |
| OnGetPageCompleted(GetPageCompletedEventArgs) |
Raises the GetPageCompleted event. |
| OnPagesChanged(PagesChangedEventArgs) |
Raises the PagesChanged event. |
Events
| Name | Description |
|---|---|
| ComputePageCountCompleted |
Occurs when a ComputePageCountAsync operation has finished. |
| GetPageCompleted |
Occurs when GetPageAsync has completed. |
| PagesChanged |
Occurs when the document content is changed. |
