[]
        
(Showing Draft Content)

GrapeCity.ActiveReports.Core.Rendering.ReportParameters.Parameter

Parameter Class

Specifies information about a parameter for the report.

Inheritance
Parameter
Namespace: GrapeCity.ActiveReports.Core.Rendering.ReportParameters
Assembly: MESCIUS.ActiveReports.Core.Rendering.dll
Syntax
public sealed class Parameter

Constructors

Name Description
Parameter(Report, ReportParameter, IParameterInfo)

Creates a Parameter using the Rdl report parameter and the datamap.

Properties

Name Description
AllowBlank

Indicates whether an empty string is a valid value for this parameter.

CurrentValue

Gets or sets the current value of the Parameter.

DataType

The data type of the parameter.

DateOnly

Indicates whether the user should be prompted for both date and time or only the date. Applicable to DateTime parameters.

DefaultValues

The default value or values (if this parameter is a MultiValue parameter) to use for the parameter.

DefinesValidValues

Gets whether this parameter has valid values defined in the report definition.

DependentParameters

Returns Parameter objects that cannot be evaluated until this Parameter is evaluated.

DisplayFormat

Parameter display format.

EnableEmptyArray

Gets or sets whether an empty array is a valid parameter value.

ErrorMessage

Gets the error message associated with this parameter.

Hidden

Indicates the parameter should not be displayed to the user.

Label

Gets or sets the label of the current value of the Parameter.

LabelsArray

Returns an object array of all the Values.Label for this parameter. Mainly for use with Multivalue parameters.

MultiValue

Indicates if this parameter accepts multiple values.

Multiline

Indicates whether the parameter value supposes to be multiline.

Name

Name of the parameter (This name can be used by expressions to refer to this parameter).

Nullable

Indicates the value for this parameter is allowed to be Null.

OrderByCondition

Gets a condition of the this parameter's valid values order.

OrderByDirection

Gets a direction of the this parameter's valid values order.

Prompt

The text to display to a user when prompting for the parameter's value.

PromptUser

Indicates if the user should be prompted for this parameter's value.

QueryParameter

Indicates whether the parameter is used in a query.

SelectAllValue

If not empty, determines the value which will be passed in parameter value if "Select All" flag was set for multivalue parameter.

State

Specifies the current state of this parameter.

ValidValues

The ordered list of possible values for this parameter.

ValidationState

Gets the error message associated with this parameter. For internal use.

Values

Gets the Values collection for this parameter. Used for Multivalue parameters.

ValuesArray

Returns an object array of all the Values.Value for this parameter. Mainly for use with Multivalue parameters.

Methods

Name Description
Create(string, ExpressionInfo, ParameterType, ParameterState, bool, bool, bool, bool, bool, bool, bool, OrderByCondition, OrderByDirection, Report)

Creates new instance of Parameter with specified properties.

Create(string, ExpressionInfo, ParameterType, ParameterState, bool, bool, bool, bool, bool, bool, bool, OrderByCondition, OrderByDirection, Report, EnableEmptyArray)

Creates new instance of Parameter with specified properties.

Create(string, ExpressionInfo, ParameterType, ParameterState, bool, bool, bool, bool, bool, bool, bool, OrderByCondition, OrderByDirection, ExpressionInfo, Report)

Creates new instance of Parameter with specified properties.

Create(string, ExpressionInfo, ParameterType, ParameterState, bool, bool, bool, bool, bool, bool, bool, OrderByCondition, OrderByDirection, ExpressionInfo, Report, EnableEmptyArray)

Creates new instance of Parameter with specified properties.

RefreshParameterValues()

Extension Methods