Class
Parameter

Represents a processing instance of a ReportParameter.

Definition

Namespace:Telerik.Reporting.Processing

Assembly:Telerik.Reporting.dll

Syntax:

cs-api-definition
public class Parameter

Inheritance: objectParameter

Constructors

Parameter()

Initializes a new instance of the Parameter class.

Declaration

cs-api-definition
public Parameter()

Properties

AllowBlank

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

Declaration

cs-api-definition
public bool AllowBlank { get; set; }

Property Value

bool

AllowNull

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

Declaration

cs-api-definition
public bool AllowNull { get; set; }

Property Value

bool

AutoRefresh

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

Declaration

cs-api-definition
public bool AutoRefresh { get; set; }

Property Value

bool

AvailableValues

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

Declaration

cs-api-definition
public List<ParameterValue> AvailableValues { get; set; }

Property Value

List<ParameterValue>

ChildParameters

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

Declaration

cs-api-definition
public string[] ChildParameters { get; set; }

Property Value

string[]

HasChildParameters

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

Declaration

cs-api-definition
public bool HasChildParameters { get; }

Property Value

bool

ID

Gets or sets the ID of the parameter.

Declaration

cs-api-definition
public string ID { get; set; }

Property Value

string

IsVisible

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

Declaration

cs-api-definition
public bool IsVisible { get; set; }

Property Value

bool

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

cs-api-definition
public object Label { get; }

Property Value

object

Multivalue

Determines if the parameter can hold more then one value.

Declaration

cs-api-definition
public bool Multivalue { get; set; }

Property Value

bool

Name

Gets or sets the Name of the parameters

Declaration

cs-api-definition
public string Name { get; set; }

Property Value

string

Text

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

Declaration

cs-api-definition
public string Text { get; set; }

Property Value

string

Type

Gets or sets the type of the parameter.

Declaration

cs-api-definition
public string Type { get; set; }

Property Value

string

Remarks

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

Value

Gets or sets the value of the parameter.

Declaration

cs-api-definition
public object Value { get; set; }

Property Value

object

Remarks

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