Class
ParameterCollection

Represents a collection of Parameter objects.

Definition

Namespace:Telerik.Reporting

Assembly:Telerik.Reporting.dll

Syntax:

cs-api-definition
[TypeConverter("Telerik.Reporting.Design.ParameterCollectionConverter, Telerik.Reporting.Design, Version=19.3.26.121, Culture=neutral, PublicKeyToken=a9d7983dfcc261be")]
public class ParameterCollection : Collection<Parameter>

Inheritance: objectCollection<Parameter>ParameterCollection

Constructors

ParameterCollection()

Declaration

cs-api-definition
public ParameterCollection()

Properties

this[string]

Gets a Parameter by name.

Declaration

cs-api-definition
public Parameter this[string name] { get; }

Parameters

name

string

The name of the parameter.

Property Value

Parameter

A parameter if found; otherwise null (Nothing)

Methods

Add(string, object)

Creates a Parameter with specific settings and adds it to the ParameterCollection or updates an existing one.

Declaration

cs-api-definition
public void Add(string name, object value)

Parameters

name

string

A string value that will be used as Name for the newly created Parameter.

value

object

A object value that will be used as Value for the newly created Parameter. Can be an expression.

AddRange(IEnumerable<Parameter>)

Adds or updates a sequence of Parameter objects in the ParameterCollection.

Declaration

cs-api-definition
public void AddRange(IEnumerable<Parameter> collection)

Parameters

collection

IEnumerable<Parameter>

An enumerable collection of Parameter objects to add to or update in the ParameterCollection.

Remarks

The Parameter objects from the collection are either appended to the end of the ParameterCollection or updated in place if they already exist.

Contains(string)

Determines whether the ParameterCollection contains a parameter with a specific name.

Declaration

cs-api-definition
public bool Contains(string name)

Parameters

name

string

A string that specifies the parameter name for which to search the elements of the ParameterCollection.

Returns

bool

Returns a bool value indicating whether the ParameterCollection object contains a parameter with the specified name.

Equals(ParameterCollection)

TODO: Add documentation.

Declaration

cs-api-definition
public bool Equals(ParameterCollection other)

Parameters

other

ParameterCollection

Returns

bool

Equals(object)

TODO: Add documentation.

Declaration

cs-api-definition
public override bool Equals(object obj)

Parameters

obj

object

Returns

bool

Overrides object.Equals(object)

GetHashCode()

TODO: Add documentation.

Declaration

cs-api-definition
public override int GetHashCode()

Returns

int

Overrides object.GetHashCode()

IndexOf(string)

Determines the index of a specific parameter in the ParameterCollection.

Declaration

cs-api-definition
public int IndexOf(string name)

Parameters

name

string

The parameter name used to locate the parameter in the ParameterCollection.

Returns

int

The index of parameter if found in the ParameterCollection; otherwise, -1.

InsertItem(int, Parameter)

TODO: Add documentation.

Declaration

cs-api-definition
protected override void InsertItem(int index, Parameter item)

Parameters

index

int

item

Parameter

Overrides Collection<Parameter>.InsertItem(int, Parameter)

SetItem(int, Parameter)

TODO: Add documentation.

Declaration

cs-api-definition
protected override void SetItem(int index, Parameter item)

Parameters

index

int

item

Parameter

Overrides Collection<Parameter>.SetItem(int, Parameter)

ToString()

TODO: Add documentation.

Declaration

cs-api-definition
public override string ToString()

Returns

string

Overrides object.ToString()