DocumentPaginator DocumentPaginator DocumentPaginator DocumentPaginator Class

Definition

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

public ref class DocumentPaginator abstract
public abstract class DocumentPaginator
type DocumentPaginator = class
Public MustInherit Class DocumentPaginator
Inheritance
DocumentPaginatorDocumentPaginatorDocumentPaginatorDocumentPaginator
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

DocumentPaginator() DocumentPaginator() DocumentPaginator() DocumentPaginator()

Initializes a new instance of the DocumentPaginator class.

Properties

IsPageCountValid IsPageCountValid IsPageCountValid IsPageCountValid

When overridden in a derived class, gets a value indicating whether PageCount is the total number of pages.

PageCount PageCount PageCount PageCount

When overridden in a derived class, gets a count of the number of pages currently formatted

PageSize PageSize PageSize PageSize

When overridden in a derived class, gets or sets the suggested width and height of each page.

Source Source Source Source

When overridden in a derived class, returns the element being paginated.

Methods

CancelAsync(Object) CancelAsync(Object) CancelAsync(Object) CancelAsync(Object)

Cancels a previous GetPageAsync or GetPageNumberAsync operation.

ComputePageCount() ComputePageCount() ComputePageCount() ComputePageCount()

Forces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to true.

ComputePageCountAsync() ComputePageCountAsync() ComputePageCountAsync() ComputePageCountAsync()

Asynchronously, forces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to true.

ComputePageCountAsync(Object) ComputePageCountAsync(Object) ComputePageCountAsync(Object) ComputePageCountAsync(Object)

Asynchronously, forces a pagination of the content, updates PageCount with the new total, sets IsPageCountValid to true.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetPage(Int32) GetPage(Int32) GetPage(Int32) GetPage(Int32)

When overridden in a derived class, gets the DocumentPage for the specified page number.

GetPageAsync(Int32) GetPageAsync(Int32) GetPageAsync(Int32) GetPageAsync(Int32)

Asynchronously returns (through the GetPageCompleted event) the DocumentPage for the specified page number.

GetPageAsync(Int32, Object) GetPageAsync(Int32, Object) GetPageAsync(Int32, Object) 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() GetType() GetType() GetType()

Gets the Type of the current instance.

(Inherited from Object)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnComputePageCountCompleted(AsyncCompletedEventArgs) OnComputePageCountCompleted(AsyncCompletedEventArgs) OnComputePageCountCompleted(AsyncCompletedEventArgs) OnComputePageCountCompleted(AsyncCompletedEventArgs)

Raises the ComputePageCountCompleted event.

OnGetPageCompleted(GetPageCompletedEventArgs) OnGetPageCompleted(GetPageCompletedEventArgs) OnGetPageCompleted(GetPageCompletedEventArgs) OnGetPageCompleted(GetPageCompletedEventArgs)

Raises the GetPageCompleted event.

OnPagesChanged(PagesChangedEventArgs) OnPagesChanged(PagesChangedEventArgs) OnPagesChanged(PagesChangedEventArgs) OnPagesChanged(PagesChangedEventArgs)

Raises the PagesChanged event.

ToString() ToString() ToString() ToString()

Returns a string that represents the current object.

(Inherited from Object)

Events

ComputePageCountCompleted ComputePageCountCompleted ComputePageCountCompleted ComputePageCountCompleted

Occurs when a ComputePageCountAsync operation has finished.

GetPageCompleted GetPageCompleted GetPageCompleted GetPageCompleted

Occurs when GetPageAsync has completed.

PagesChanged PagesChanged PagesChanged PagesChanged

Occurs when the document content is changed.

Applies to