Class ParameterCollection
Represents a collection of Parameter objects used for configuring report parameters in the HTML5 WebForms ReportViewer. Used to manage parameter values that are passed to reports during initialization and processing.
Namespace: Telerik.ReportViewer.Html5.WebForms
Assembly: Telerik.ReportViewer.Html5.WebForms.dll
Syntax
public class ParameterCollection : Collection<Parameter>, IList<Parameter>, ICollection<Parameter>, IList, ICollection, IReadOnlyList<Parameter>, IReadOnlyCollection<Parameter>, IEnumerable<Parameter>, IEnumerable, IEquatable<ParameterCollection>, ICloneableRemarks
The collection prevents duplicate parameter names by updating existing parameter values when adding parameters with matching names.
Constructors
ParameterCollection()
Declaration
public ParameterCollection()Properties
Item[String]
Gets a Parameter by name from the collection.
Declaration
public Parameter this[string name] { get; }Parameters
|
System.String
name
The name of the parameter to retrieve. |
Property Value
|
Parameter
The Parameter object with the specified name if found; otherwise, null. |
Remarks
Provides indexed access to parameters by name for convenient parameter value retrieval and assignment.
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
An enumerable of Parameter objects to add to/update in the ParameterCollection. |
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)
Determines whether the current ParameterCollection is equal to the specified object.
Declaration
public override bool Equals(object obj)Parameters
|
System.Object
obj
The object to compare with the current ParameterCollection. |
Returns
|
System.Boolean
True if the specified object is a ParameterCollection and is equal to the current collection; otherwise, false. |
Overrides
Equals(ParameterCollection)
Determines whether the current ParameterCollection is equal to another ParameterCollection by comparing all parameter values.
Declaration
public bool Equals(ParameterCollection other)Parameters
|
ParameterCollection
other
The ParameterCollection to compare with the current collection. |
Returns
|
System.Boolean
True if the collections contain the same parameters in the same order; otherwise, false. |
Remarks
Performs deep comparison of all parameters including their names and values for collection equality determination.
GetHashCode()
Serves as the default hash function for the ParameterCollection.
Declaration
public override int GetHashCode()Returns
|
System.Int32
A hash code based on all parameters in the collection for use in hash-based collections. |
Overrides
Remarks
Calculates a hash code from all parameters in the collection to support proper hash table operations.
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)
Inserts a parameter at the specified index, or updates an existing parameter if one with the same name already exists.
Declaration
protected override void InsertItem(int index, Parameter item)Parameters
|
System.Int32
index
The zero-based index at which the parameter should be inserted. |
|
Parameter
item
The Parameter object to insert into the collection. |
Overrides
Remarks
If a parameter with the same name already exists, the existing parameter's value is updated instead of adding a duplicate.
SetItem(Int32, Parameter)
Sets the parameter at the specified index, or updates an existing parameter if one with the same name already exists.
Declaration
protected override void SetItem(int index, Parameter item)Parameters
|
System.Int32
index
The zero-based index at which the parameter should be set. |
|
Parameter
item
The Parameter object to set in the collection. |
Overrides
Remarks
If a parameter with the same name already exists at a different index, the existing parameter's value is updated instead of setting at the specified index.
ToString()
Returns a string representation of the ParameterCollection containing all parameter information.
Declaration
public override string ToString()Returns
|
System.String
A semicolon-separated string containing the string representation of all parameters in the collection. |
Overrides
Remarks
Provides a compact string representation of all parameters for debugging and logging purposes.