DynamicDocumentPaginator Members

DynamicDocumentPaginator Members

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.

The DynamicDocumentPaginator type exposes the following members.

  NameDescription
Protected method DynamicDocumentPaginator Initializes a new instance of the DynamicDocumentPaginator class.
Top

  NameDescription
Public method CancelAsync Cancels a previous GetPageAsync or DynamicDocumentPaginator.GetPageNumberAsync operation. (Inherited from DocumentPaginator.)
Public method ComputePageCount Forces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to true. (Inherited from DocumentPaginator.)
Public method ComputePageCountAsync Overloaded. Asynchronously, forces a pagination of the content, updates PageCount with the new total, and sets IsPageCountValid to true.
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetObjectPosition When overridden in a derived class, returns a ContentPosition for the specified Object.
Public method GetPage When overridden in a derived class, gets the DocumentPage for the specified page number. (Inherited from DocumentPaginator.)
Public method GetPageAsync Overloaded. Asynchronously returns the DocumentPage for the specified page number.
Public method GetPageNumber When overridden in a derived class, returns the zero-based page number of the specified ContentPosition.
Public method GetPageNumberAsync Overloaded. Returns the zero-based page number of the specified ContentPosition.
Public method GetPagePosition When overridden in a derived class, gets the position of the specified page in the document's content.
Public method GetType Gets the type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method OnComputePageCountCompleted Raises the ComputePageCountCompleted event. (Inherited from DocumentPaginator.)
Protected method OnGetPageCompleted Raises the GetPageCompleted event. (Inherited from DocumentPaginator.)
Protected method OnGetPageNumberCompleted Raises the GetPageNumberCompleted event.
Protected method OnPagesChanged Raises the PagesChanged event. (Inherited from DocumentPaginator.)
Protected method OnPaginationCompleted Raises the PaginationCompleted event.
Protected method OnPaginationProgress Raises the PaginationProgress event.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Public property IsBackgroundPaginationEnabled 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.
Public property IsPageCountValid When overridden in a derived class, gets a value indicating whether PageCount is the total number of pages. (Inherited from DocumentPaginator.)
Public property PageCount When overridden in a derived class, gets a count of the number of pages currently formatted (Inherited from DocumentPaginator.)
Public property PageSize When overridden in a derived class, gets or sets the suggested width and height of each page. (Inherited from DocumentPaginator.)
Public property Source When overridden in a derived class, returns the element being paginated. (Inherited from DocumentPaginator.)
Top

  NameDescription
Public event ComputePageCountCompleted Occurs when a ComputePageCountAsync operation has finished. (Inherited from DocumentPaginator.)
Public event GetPageCompleted Occurs when GetPageAsync has completed. (Inherited from DocumentPaginator.)
Public event GetPageNumberCompleted Occurs when GetPageNumberAsync has completed.
Public event PagesChanged Occurs when the document content is changed. (Inherited from DocumentPaginator.)
Public event PaginationCompleted Occurs when all document content has been paginated.
Public event PaginationProgress Occurs when one or more content pages have been paginated.
Top

Community Additions

ADD
Show:
© 2016 Microsoft