Method Paginate

Namespace

DocWright.Reporting.Pagination

Assembly

DocWright.Reporting.dll

Paginate(ReportInstance, FontEngine)

Paginates a report physically, with default options.

public static ReportPageModel Paginate(ReportInstance instance, FontEngine fonts)

Parameters

instance ReportInstance

The processed report.

fonts FontEngine

The font engine text is measured with, and which the renderers should draw with.

Returns

ReportPageModel

The pages.

Exceptions

ArgumentNullException

instance or fonts is null.

ResourceLimitExceededException

A limit in the run's options was exceeded.

Paginate(ReportInstance, FontEngine, ReportPaginationOptions?)

Paginates a report.

public static ReportPageModel Paginate(ReportInstance instance, FontEngine fonts, ReportPaginationOptions? options)

Parameters

instance ReportInstance

The processed report.

fonts FontEngine

The font engine text is measured with, and which the renderers should draw with.

options ReportPaginationOptions

The options, or null for the defaults.

Returns

ReportPageModel

The pages.

Exceptions

ArgumentNullException

instance or fonts is null.

ResourceLimitExceededException

A limit in the run's options was exceeded.

ReportProcessingException

In strict mode, something was reported as an error.

Paginate(ReportInstance, FontEngine, ReportPaginationOptions?, CancellationToken)

Paginates a report.

public static ReportPageModel Paginate(ReportInstance instance, FontEngine fonts, ReportPaginationOptions? options, CancellationToken cancellationToken)

Parameters

instance ReportInstance

The processed report.

fonts FontEngine

The font engine text is measured with, and which the renderers should draw with.

options ReportPaginationOptions

The options, or null for the defaults.

cancellationToken CancellationToken

Cancels pagination; checked between items and pages.

Returns

ReportPageModel

The pages.

Exceptions

ArgumentNullException

instance or fonts is null.

ResourceLimitExceededException

A limit in the run's options was exceeded.

ReportProcessingException

In strict mode, something was reported as an error.

OperationCanceledException

Pagination was cancelled.