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.
Definition
Namespace:Telerik.ReportViewer.Html5.WebForms
Assembly:Telerik.ReportViewer.Html5.WebForms.dll
Syntax:
[TypeConverter(typeof(ParameterCollectionConverter))]
public class ParameterCollection : Collection<Parameter>Inheritance: objectCollection<Parameter>ParameterCollection
Constructors
public ParameterCollection()Properties
Gets a Parameter by name from the collection.
public Parameter this[string name] { get; }The name of the parameter to retrieve.
Property Value:The Parameter object with the specified name if found; otherwise, null.
Provides indexed access to parameters by name for convenient parameter value retrieval and assignment.
Methods
Creates a Parameter with specific settings and adds it to the ParameterCollection or updates an existing one.
Adds/updates an enumerable of Parameter objects to/in the ParameterCollection.
public void AddRange(IEnumerable<Parameter> collection)An enumerable of Parameter objects to add to/update in the ParameterCollection.
The Parameter objects returned from the enumerable are appended to the end of the ParameterCollection or updated in place.
Determines whether the ParameterCollection contains a parameter with a specific name.
public bool Contains(string name)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.
Determines whether the current ParameterCollection is equal to the specified object.
public override bool Equals(object obj)The object to compare with the current ParameterCollection.
Returns:bool
True if the specified object is a ParameterCollection and is equal to the current collection; otherwise, false.
Overrides:
Determines whether the current ParameterCollection is equal to another ParameterCollection by comparing all parameter values.
public bool Equals(ParameterCollection other)The ParameterCollection to compare with the current collection.
Returns:bool
True if the collections contain the same parameters in the same order; otherwise, false.
Performs deep comparison of all parameters including their names and values for collection equality determination.
Serves as the default hash function for the ParameterCollection.
public override int GetHashCode()int
A hash code based on all parameters in the collection for use in hash-based collections.
Overrides:
Calculates a hash code from all parameters in the collection to support proper hash table operations.
Determines the index of a specific parameter in the ParameterCollection.
public int IndexOf(string name)The parameter name used to locate the parameter in the ParameterCollection.
Returns:int
The index of parameter if found in the ParameterCollection; otherwise, -1.
Inserts a parameter at the specified index, or updates an existing parameter if one with the same name already exists.
protected override void InsertItem(int index, Parameter item)The zero-based index at which the parameter should be inserted.
itemParameterThe Parameter object to insert into the collection.
Overrides:
If a parameter with the same name already exists, the existing parameter's value is updated instead of adding a duplicate.
Sets the parameter at the specified index, or updates an existing parameter if one with the same name already exists.
protected override void SetItem(int index, Parameter item)The zero-based index at which the parameter should be set.
itemParameterThe Parameter object to set in the collection.
Overrides:
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.
Returns a string representation of the ParameterCollection containing all parameter information.
public override string ToString()string
A semicolon-separated string containing the string representation of all parameters in the collection.
Overrides:
Provides a compact string representation of all parameters for debugging and logging purposes.