Table of Contents

Method Preview

Namespace
ReportWright.Data
Assembly
ReportWright.Data.Abstractions.dll

Preview(ReportDefinition, string, IDictionary<string, ReportParameterValue>?, int, CancellationToken)

Reads a capped sample of a dataset's rows.

public DataPreview Preview(ReportDefinition definition, string dataSetName, IDictionary<string, ReportParameterValue>? parameters, int maxRows, CancellationToken cancellationToken)

Parameters

definition ReportDefinition

The report.

dataSetName string

The dataset's name.

parameters IDictionary<string, ReportParameterValue>

Parameter values the query may read, or null.

maxRows int

The most rows to return.

cancellationToken CancellationToken

Cancels the read.

Returns

DataPreview

The sample; Truncated says whether the source had more.

Exceptions

ArgumentOutOfRangeException

maxRows is not positive.