Interface IReportParameter
Represents a report parameter.
Namespace: Telerik.Reporting
Assembly: Telerik.Reporting.dll
Syntax
public interface IReportParameterProperties
AllowBlank
Gets or sets a value that indicates whether an empty string is a valid value for the parameter. Only for parameters of Type String.
Declaration
bool AllowBlank { get; set; }Property Value
|
System.Boolean
|
AllowNull
Determines if the parameter allows no value to be passed from it's editor.
Declaration
bool AllowNull { get; set; }Property Value
|
System.Boolean
|
Remarks
Only if this property is set to false null (
Nothing in VB) are considered as valid values of the
parameter.
AutoRefresh
Determines whether to trigger the report preview after changing the value for a parameter. Applies only for visible parameters.
Declaration
bool AutoRefresh { get; set; }Property Value
|
System.Boolean
|
Remarks
If this property is set to true, the report viewer will trigger the report preview automatically when the parameter value is changed. The parameter should be visible in order to auto preview the report.
AvailableValues
Gets an object that defines a set of valid values the parameter can accept from.
Declaration
ReportParameterAvailableValues AvailableValues { get; }Property Value
|
ReportParameterAvailableValues
|
Remarks
The available values, or valid values, are a set of predefined values which are acceptable as value of the parameter. Each available value may have label that will be displayed if the parameter is visible.
Mergeable
Gets or sets a value indicating whether this parameter should be merged with identical parameters from other reports when this report is part of a ReportBook.
Declaration
bool Mergeable { get; set; }Property Value
|
System.Boolean
|
Remarks
Controls parameter merging in ReportBook. The default value of the Mergeable property is true. Set the Mergeable property to false if you want to prevent a parameter from being merged with its equivalent ones.
MultiValue
Determines if the parameter can hold more then one value.
Declaration
bool MultiValue { get; set; }Property Value
|
System.Boolean
|
Remarks
If the value is set to true as a valid value of the parameter is accepted or System.Collections.IEnumerable of values of the specified Type of the parameter. Parameters with MultiValue turned on are mainly used with the IN logical operator.
Name
Gets or sets the name of the parameter. Used to access the parameter.
Declaration
string Name { get; set; }Property Value
|
System.String
|
Remarks
Parameter names must be unique in the context of a single report. The name must be a valid identifier - may contain only digits (0-9), letters (a-z, A-Z), and underscore sign (_). Must begin with a letter or underscore.
Text
Gets or sets the text for the parameter's automatic UI displayed in the report viewer.
Declaration
string Text { get; set; }Property Value
|
System.String
|
Remarks
The Text property specifies the text for the parameter to be displayed in the report viewer as prompt to the end user. If value for the property is not provided the Name of the parameter is used.
Type
Gets or sets the data type of the parameter.
Declaration
ReportParameterType Type { get; set; }Property Value
|
ReportParameterType
|
Remarks
Determines the type of the values. Acceptable values for each type are listed in ReportParameterType. The default parameter type is String.
Value
Gets or sets the value of the parameter. Can be an Expression that evaluates to an object, value of the allowed types, or System.Collections.IEnumerable containing values of the allowed types.
Declaration
object Value { get; set; }Property Value
|
System.Object
|
Visible
Determines whether automatic user interface (UI) prompting for values to be generated for the parameter.
Declaration
bool Visible { get; set; }Property Value
|
System.Boolean
|
Remarks
Specifies whether the parameter will have UI in the parameters area. When at least one report parameter has the Visible property turned on, a parameter area is shown as part of the report viewer. If this property is set to false, the parameter must be populated programmatically or at design time.