New to Telerik Reporting? Start a free 30-day trial

Parameter

Class

Represents a processing instance of a ReportParameter.

Definition

Namespace:Telerik.Reporting.Processing

Assembly:Telerik.Reporting.dll

Syntax:

public class Parameter

Inheritance: objectParameter

Constructors

Parameter()

Initializes a new instance of the Parameter class.

public Parameter()

Properties

AllowBlank

bool

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

public bool AllowBlank { get; set; }

AllowNull

bool

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

public bool AllowNull { get; set; }

AutoRefresh

bool

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

public bool AutoRefresh { get; set; }

AvailableValues

List<ParameterValue>

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

public List<ParameterValue> AvailableValues { get; set; }

ChildParameters

string[]

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

public string[] ChildParameters { get; set; }

HasChildParameters

bool

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

public bool HasChildParameters { get; }

ID

string

Gets or sets the ID of the parameter.

public string ID { get; set; }

IsVisible

bool

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

public bool IsVisible { get; set; }

Label

object

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.

public object Label { get; }

Multivalue

bool

Determines if the parameter can hold more then one value.

public bool Multivalue { get; set; }

Name

string

Gets or sets the Name of the parameters

public string Name { get; set; }

Text

string

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

public string Text { get; set; }

Type

string

Gets or sets the type of the parameter.

public string Type { get; set; }

Remarks:

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

Value

object

Gets or sets the value of the parameter.

public object Value { get; set; }

Remarks:

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