Class ReportParameterPrompt

Namespace

DocWright.Reporting.Processing

Assembly

DocWright.Reporting.dll

A report parameter as a viewer's parameter bar needs it: how to prompt, what is valid, what it is now, and whether the report can run with it.

public sealed class ReportParameterPrompt

Inheritance

object

ReportParameterPrompt

Inherited Members

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

Processing is stateless. A viewer that lets the user change one parameter asks again with every value it holds; the answer says what each parameter is now. A value the user supplied that is no longer valid — because a parameter it depends on changed — comes back with SuppliedValueRejected set and no value, which is when a viewer clears the field and prompts again.

Properties

AllowBlank

Gets a value indicating whether a text parameter may be empty.

AreDefaultValuesFromDataSet

Gets a value indicating whether the default values come from a dataset.

AreValidValuesFromDataSet

Gets a value indicating whether the valid values come from a dataset.

DataType

Gets the parameter's data type.

Dependencies

Gets the names of the parameters this one depends on, in document order.

Dependents

Gets the names of the parameters that depend on this one, in document order.

ErrorCode

Gets the diagnostic code that goes with ErrorMessage, or null.

ErrorMessage

Gets why the parameter has no valid value, or null.

Hidden

Gets a value indicating whether the definition hides the parameter from the user.

Labels

Gets the labels, parallel to Values; an entry is null where there is no valid-values label.

MultiValue

Gets a value indicating whether the parameter takes several values.

Name

Gets the parameter's name.

Nullable

Gets a value indicating whether the parameter may be null.

Prompt

Gets the prompt text, or null when the definition states none.

State

Gets whether the parameter has a value the report can run with.

SuppliedValueRejected

Gets a value indicating whether the host supplied a value for this parameter that was not accepted.

ValidValues

Gets the valid values, or null when any value of the data type is valid.

Values

Gets the current values, typed to DataType: one for a single-valued parameter (which may be null), any number for a multi-valued one, none when there is no valid value.

Methods

ToString()

Returns the name, state and values.