Method GetParameters

Namespace

DocWright.Reporting.Processing

Assembly

DocWright.Reporting.dll

GetParameters(ReportDefinition, ReportDataProvider?, ReportRunOptions)

Works out the report's parameters without running the report.

public static IReadOnlyList<ReportParameterPrompt> GetParameters(ReportDefinition definition, ReportDataProvider? dataProvider, ReportRunOptions options)

Parameters

definition ReportDefinition

The report definition.

dataProvider ReportDataProvider

The data provider, for parameters whose values come from datasets; may be null.

options ReportRunOptions

The run's options, including the values the user supplied.

Returns

IReadOnlyList<ReportParameterPrompt>

Every parameter, in document order.

Exceptions

ArgumentNullException

definition or options is null.

ReportProcessingException

A parameter's definition is in error.

GetParameters(ReportDefinition, ReportDataProvider?, ReportRunOptions, CancellationToken)

Works out the report's parameters without running the report.

public static IReadOnlyList<ReportParameterPrompt> GetParameters(ReportDefinition definition, ReportDataProvider? dataProvider, ReportRunOptions options, CancellationToken cancellationToken)

Parameters

definition ReportDefinition

The report definition.

dataProvider ReportDataProvider

The data provider, for parameters whose values come from datasets; may be null.

options ReportRunOptions

The run's options, including the values the user supplied.

cancellationToken CancellationToken

Cancels the work.

Returns

IReadOnlyList<ReportParameterPrompt>

Every parameter, in document order.

Exceptions

ArgumentNullException

definition or options is null.

ReportProcessingException

A parameter's definition is in error.