Class Parameter

Represents a processing instance of a ReportParameter.

Inheritance
System.Object
Parameter
Parameter
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Reporting.Processing
Assembly: Telerik.Reporting.dll

Syntax

public class Parameter

Constructors

Parameter()

Initializes a new instance of the Parameter class.

Declaration
public Parameter()

Properties

AllowBlank

Determines if the parameter allows an empty string to be passed. Only for parameters of type string.

Declaration
public bool AllowBlank { get; set; }
Property Value
System.Boolean

AllowNull

Determines if the parameter allows no value to be passed from it's editor.

Declaration
public bool AllowNull { get; set; }
Property Value
System.Boolean

AutoRefresh

Determines whether the report viewer should auto-update the report when the parameter value is changed.

Declaration
public bool AutoRefresh { get; set; }
Property Value
System.Boolean

AvailableValues

Gets or sets the list of the available values for the current parameter.

Declaration
public List<ParameterValue> AvailableValues { get; set; }
Property Value
System.Collections.Generic.List<ParameterValue>

ChildParameters

Gets or sets IDs of all parameters that depend on the current parameter.

Declaration
public string[] ChildParameters { get; set; }
Property Value
System.String[]

HasChildParameters

Gets a value indicating whether other parameters depend on the current parameter.

Declaration
public bool HasChildParameters { get; }
Property Value
System.Boolean

ID

Gets or sets the ID of the parameter.

Declaration
public string ID { get; set; }
Property Value
System.String

IsVisible

Determines if the parameter should be displayed in the report viewer.

Declaration
public bool IsVisible { get; set; }
Property Value
System.Boolean

Label

Gets the label of the parameter. Returns a string that contains the label of the current parameter's Value or an array of strings that contains the labels of all values when multivalue parameter.

Declaration
public object Label { get; }
Property Value
System.Object

Multivalue

Determines if the parameter can hold more then one value.

Declaration
public bool Multivalue { get; set; }
Property Value
System.Boolean

Name

Gets or sets the Name of the parameters

Declaration
public string Name { get; set; }
Property Value
System.String

Text

Gets or sets the text for the parameter to be displayed in the report viewer.

Declaration
public string Text { get; set; }
Property Value
System.String

Type

Gets or sets the type of the parameter.

Declaration
public string Type { get; set; }
Property Value
System.String

Remarks

The string that represents the parameter type should be the System.Type.FullName of the CLR type corresponding to the ReportParameterType.

Value

Gets or sets the value of the parameter.

Declaration
public object Value { get; set; }
Property Value
System.Object

Remarks

Value should of the allowed types, or System.Collections.IEnumerable containing values of the allowed types.