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

NameDescription
System_CAPS_protmethodDocumentPaginator()

Initializes a new instance of the DocumentPaginator class.

NameDescription
System_CAPS_pubpropertyIsPageCountValid

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

System_CAPS_pubpropertyPageCount

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

System_CAPS_pubpropertyPageSize

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

System_CAPS_pubpropertySource

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

NameDescription
System_CAPS_pubmethodCancelAsync(Object)
System_CAPS_pubmethodComputePageCount()

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

System_CAPS_pubmethodComputePageCountAsync()

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

System_CAPS_pubmethodComputePageCountAsync(Object)

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

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetPage(Int32)

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

System_CAPS_pubmethodGetPageAsync(Int32)

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

System_CAPS_pubmethodGetPageAsync(Int32, Object)

Asynchronously returns (through the GetPageCompleted event) the DocumentPage for the specified page number and assigns the specified ID to the asynchronous task.

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodOnComputePageCountCompleted(AsyncCompletedEventArgs)

Raises the ComputePageCountCompleted event.

System_CAPS_protmethodOnGetPageCompleted(GetPageCompletedEventArgs)

Raises the GetPageCompleted event.

System_CAPS_protmethodOnPagesChanged(PagesChangedEventArgs)

Raises the PagesChanged event.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubeventComputePageCountCompleted

Occurs when a ComputePageCountAsync operation has finished.

System_CAPS_pubeventGetPageCompleted

Occurs when GetPageAsync has completed.

System_CAPS_pubeventPagesChanged

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.

.NET Framework
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.

Return to top
Show: