Skip to end of metadata
Go to start of metadata

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

Definition

public abstract class DocumentPaginator

Summary

The following table summarizes the members exposed in this class.

Protected Constructors

DocumentPaginator Constructor() Initializes a new instance of DocumentPaginator class.

Public Properties

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.

Public Methods

GetPage(int) When overridden in a derived class, gets the DocumentPage for the specified page number.

Protected Methods

OnPagesChanged(PagesChangedEventArgs) Raises the OnPagesChanged event when the document content is changed.

Events

PagesChanged Occurs when the document content is changed.

Protected Constructors

protected DocumentPaginator()

Initializes a new instance of DocumentPaginator class.

Public Properties

public bool IsPageCountValid { get; }

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

public int PageCount { get; }

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

public Size PageSize { get; set; }

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

public IDocumentPaginatorSource Source { get; }

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

Public Methods

public DocumentPage GetPage(int pageNumber)

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

Parameters

pageNumber The zero-based page number of the document page that is needed.

Return Types

The DocumentPage for the specified pageNumber, or null if the page does not exist.

Protected Methods

protected void OnPagesChanged(PagesChangedEventArgs e)

Raises the OnPagesChanged event when the document content is changed.

Parameters

e PagesChangedEventArgs event args.

Events

public event PagesChangedEventHandler PagesChanged

Occurs when the document content is changed.

  • No labels