DynamicDocumentPaginator Class

 

Provides an abstract base class that supports automatic background pagination and tracking content positions across repaginations in addition to the methods and properties of its own base class.

Namespace:   System.Windows.Documents
Assembly:  PresentationCore (in PresentationCore.dll)

System.Object
  System.Windows.Documents.DocumentPaginator
    System.Windows.Documents.DynamicDocumentPaginator

public abstract class DynamicDocumentPaginator : DocumentPaginator

NameDescription
System_CAPS_protmethodDynamicDocumentPaginator()

Initializes a new instance of the DynamicDocumentPaginator class.

NameDescription
System_CAPS_pubpropertyIsBackgroundPaginationEnabled

Gets or sets a value indicating whether pagination is performed automatically in the background in response to certain events, such as a change in page size.

System_CAPS_pubpropertyIsPageCountValid

When overridden in a derived class, gets a value indicating whether PageCount is the total number of pages. (Inherited from DocumentPaginator.)

System_CAPS_pubpropertyPageCount

When overridden in a derived class, gets a count of the number of pages currently formatted(Inherited from DocumentPaginator.)

System_CAPS_pubpropertyPageSize

When overridden in a derived class, gets or sets the suggested width and height of each page.(Inherited from DocumentPaginator.)

System_CAPS_pubpropertySource

When overridden in a derived class, returns the element being paginated.(Inherited from DocumentPaginator.)

NameDescription
System_CAPS_pubmethodCancelAsync(Object)

Cancels a previous GetPageAsync or DynamicDocumentPaginator.GetPageNumberAsync operation.(Inherited from DocumentPaginator.)

System_CAPS_pubmethodComputePageCount()

Forces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to true.(Inherited from DocumentPaginator.)

System_CAPS_pubmethodComputePageCountAsync()

Asynchronously, forces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to true.(Inherited from DocumentPaginator.)

System_CAPS_pubmethodComputePageCountAsync(Object)

Asynchronously, forces a pagination of the content, updates PageCount with the new total, sets IsPageCountValid to true. (Inherited from DocumentPaginator.)

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_pubmethodGetObjectPosition(Object)

When overridden in a derived class, returns a ContentPosition for the specified Object.

System_CAPS_pubmethodGetPage(Int32)

When overridden in a derived class, gets the DocumentPage for the specified page number.(Inherited from DocumentPaginator.)

System_CAPS_pubmethodGetPageAsync(Int32)

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

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.(Inherited from DocumentPaginator.)

System_CAPS_pubmethodGetPageNumber(ContentPosition)

When overridden in a derived class, returns the zero-based page number of the specified ContentPosition.

System_CAPS_pubmethodGetPageNumberAsync(ContentPosition)

Asynchronously, returns (through the This method raises the GetPageNumberCompleted event) the zero-based page number of the specified ContentPosition.

System_CAPS_pubmethodGetPageNumberAsync(ContentPosition, Object)

Asynchronously, returns (through the This method raises the GetPageNumberCompleted event) the zero-based page number of the specified ContentPosition.

System_CAPS_pubmethodGetPagePosition(DocumentPage)

When overridden in a derived class, gets the position of the specified page in the document's content.

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. (Inherited from DocumentPaginator.)

System_CAPS_protmethodOnGetPageCompleted(GetPageCompletedEventArgs)

Raises the GetPageCompleted event. (Inherited from DocumentPaginator.)

System_CAPS_protmethodOnGetPageNumberCompleted(GetPageNumberCompletedEventArgs)

Raises the GetPageNumberCompleted event.

System_CAPS_protmethodOnPagesChanged(PagesChangedEventArgs)

Raises the PagesChanged event. (Inherited from DocumentPaginator.)

System_CAPS_protmethodOnPaginationCompleted(EventArgs)

Raises the PaginationCompleted event.

System_CAPS_protmethodOnPaginationProgress(PaginationProgressEventArgs)

Raises the PaginationProgress 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. (Inherited from DocumentPaginator.)

System_CAPS_pubeventGetPageCompleted

Occurs when GetPageAsync has completed.(Inherited from DocumentPaginator.)

System_CAPS_pubeventGetPageNumberCompleted

Occurs when GetPageNumberAsync has completed.

System_CAPS_pubeventPagesChanged

Occurs when the document content is changed.(Inherited from DocumentPaginator.)

System_CAPS_pubeventPaginationCompleted

Occurs when all document content has been paginated.

System_CAPS_pubeventPaginationProgress

Occurs when one or more content pages have been paginated.

By default, a DynamicDocumentPaginator will automatically pre-paginate content in the background (this process begins when IsBackgroundPaginationEnabled is true, which is the default setting).

When IsBackgroundPaginationEnabled is true, the layout will also be repaginated due to changes in content or changes in PageSize.

The PaginationProgress event occurs upon completion of pagination (or repagination) of one or more pages, such as in the following situations:

A PaginationCompleted event also occurs when background pagination is disabled. For example, if there is only one page of content and IsBackgroundPaginationEnabled = false), calling GetPage with an argument of 0 will result in two events:

  1. A PaginationProgress event with PaginationProgressEventArgs settings of Start = 0 and Count = 1.

  2. A PaginationCompleted event.

.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: