Class ReportRunOptions

Namespace

DocWright.Reporting.Processing

Assembly

DocWright.Reporting.dll

Everything about one run of a report that does not come from the definition or the data: who runs it, when, in which culture, with which parameter values, and under which limits.

public sealed class ReportRunOptions

Inheritance

object

ReportRunOptions

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Nothing is ambient. The clock, the thread's culture and the machine's identity are never read. A run with the same definition, data and options produces the same instance.

Two cultures, both measured. Culture is the culture of the person running the report: parameter values supplied as text are read in it, and User!Language is its name — which is where the reference implementation reads the thread's culture. Expressions are evaluated in the report's own <Language>, and in en-US when it states none, whatever this is. Literal defaults written in the definition are read in neither: the reference reads them culture-independently, and so does DocWright.

Constructors

ReportRunOptions()

Initializes options with the en-US culture and nothing else supplied.

Properties

CodeHost

Gets or sets the host that runs the report's custom code, or null to refuse it (DXP9103).

Culture

Gets or sets the culture of the user running the report. Defaults to en-US.

Diagnostics

Gets or sets where diagnostics are reported, or null.

ExecutionTime

Gets or sets the instant the report runs at: Globals!ExecutionTime, Now() and Today(). Null refuses those expressions (DXP9106) rather than reading the clock.

InteractiveSorts

Gets the interactive sorts to apply, in the order they were made: what a viewer collects when someone clicks a text box that offers one (UserSort), and Shift+clicks another.

Limits

Gets the limits the run is bounded by.

Parameters

Gets the parameter values the host supplies, by name (names are case-sensitive).

RenderFormatIsInteractive

Gets or sets Globals!RenderFormat.IsInteractive.

RenderFormatName

Gets or sets Globals!RenderFormat.Name.

ReportFolder

Gets or sets Globals!ReportFolder.

ReportName

Gets or sets Globals!ReportName.

ReportServerUrl

Gets or sets Globals!ReportServerUrl.

StrictMode

Gets or sets a value indicating whether anything reported as an error stops the run with ReportProcessingException. By default an error is reported and processing continues without the part that failed.

SubreportResolver

Gets or sets what finds the definition a subreport names, or null to run no subreports (DXP9211).

UserId

Gets or sets User!UserID.