Documentation

Class ParameterCollection

Represents a collection of Parameter objects.

Inheritance
System.Object
System.Collections.ObjectModel.Collection<Parameter>
ParameterCollection
Namespace: Telerik.Reporting
Assembly: Telerik.Reporting.dll

Syntax

public class ParameterCollection : Collection<Parameter>, IList<Parameter>, ICollection<Parameter>, IList, ICollection, IReadOnlyList<Parameter>, IReadOnlyCollection<Parameter>, IEnumerable<Parameter>, IEnumerable, IEquatable<ParameterCollection>, ICloneable
Remarks

The collection does not allow adding two parameters with matching names.

Constructors

ParameterCollection()

Declaration
public ParameterCollection()

Properties

Item[String]

Gets a Parameter by name.

Declaration
public Parameter this[string name] { get; }
Parameters
System.String name

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
public void Add(string name, object value)
Parameters
System.String name

A System.String value that will be used as Name for the newly created Parameter.
System.Object value

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

AddRange(IEnumerable<Parameter>)

Adds/updates an enumerable of Parameter objects to/in the ParameterCollection.

Declaration
public void AddRange(IEnumerable<Parameter> collection)
Parameters
System.Collections.Generic.IEnumerable<Parameter> collection

Remarks

The Parameter objects returned from the enumerable are appended to the end of the ParameterCollection or updated in place.

Contains(String)

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

Declaration
public bool Contains(string name)
Parameters
System.String name

A System.String that specifies the parameter name for which to search the elements of the ParameterCollection.
Returns
System.Boolean

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

Equals(Object)

Declaration
public override bool Equals(object obj)
Parameters
System.Object obj

Returns
System.Boolean

Overrides
System.Object.Equals(System.Object)

Equals(ParameterCollection)

Declaration
public bool Equals(ParameterCollection other)
Parameters
ParameterCollection other

Returns
System.Boolean

GetHashCode()

Declaration
public override int GetHashCode()
Returns
System.Int32

Overrides
System.Object.GetHashCode()

IndexOf(String)

Determines the index of a specific parameter in the ParameterCollection.

Declaration
public int IndexOf(string name)
Parameters
System.String name

The parameter name used to locate the parameter in the ParameterCollection.
Returns
System.Int32

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

InsertItem(Int32, Parameter)

Declaration
protected override void InsertItem(int index, Parameter item)
Parameters
System.Int32 index

Parameter item

Overrides
System.Collections.ObjectModel.Collection<Telerik.Reporting.Parameter>.InsertItem(System.Int32, Telerik.Reporting.Parameter)

SetItem(Int32, Parameter)

Declaration
protected override void SetItem(int index, Parameter item)
Parameters
System.Int32 index

Parameter item

Overrides
System.Collections.ObjectModel.Collection<Telerik.Reporting.Parameter>.SetItem(System.Int32, Telerik.Reporting.Parameter)

ToString()

Declaration
public override string ToString()
Returns
System.String

Overrides
System.Object.ToString()