Method Toggle

Namespace

DocWright.Reporting.Viewer

Assembly

DocWright.Reporting.Viewer.dll

Toggle(string)

Applies a toggle and paginates again.

public ReportViewerUpdate Toggle(string toggleKey)

Parameters

toggleKey string

The key, from Key.

Returns

ReportViewerUpdate

The new pagination and the pages that changed.

Remarks

A key the report does not use is not an error: it toggles nothing and the report paginates to the same pages, which is what a stale click from a viewer showing an older pagination should do.

Exceptions

ArgumentNullException

toggleKey is null.

Toggle(string, CancellationToken)

Applies a toggle and paginates again.

public ReportViewerUpdate Toggle(string toggleKey, CancellationToken cancellationToken)

Parameters

toggleKey string

The key, from Key.

cancellationToken CancellationToken

Cancels the pagination.

Returns

ReportViewerUpdate

The new pagination and the pages that changed.

Exceptions

ArgumentNullException

toggleKey is null.