ParameterCollection.RemoveAt(Int32) Method

Reference

Definition

Namespace:: System.Web.UI.WebControls

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Removes the Parameter object at the specified index from the ParameterCollection collection.

public:
 void RemoveAt(int index);

public void RemoveAt (int index);

member this.RemoveAt : int -> unit

Public Sub RemoveAt (index As Integer)

Parameters

index: Int32

The index of the Parameter to remove.

Examples

The following code example demonstrates how to use the RemoveAt method to remove a Parameter object from a ParameterCollection collection at a specific location. In this example, several QueryStringParameter objects are added to a SelectParameters collection, one QueryStringParameter object is removed from the collection, and the order of the collection is printed when the page loads.

<%@page Language="C#" %>
<SCRIPT runat="server">
private void Page_Load(object sender, EventArgs e) {

    SqlDataSource aSqlDataSource = new SqlDataSource();

    // Security Note: The SqlDataSource uses a QueryStringParameter,
    // Security Note: which does not perform validation of input from the client.

    QueryStringParameter qs1 =
        new QueryStringParameter("QueryStringParam1","requestfield1");

    aSqlDataSource.SelectParameters.Add(qs1);

    QueryStringParameter qs3 =
        new QueryStringParameter("QueryStringParam2","requestfield2");

    aSqlDataSource.SelectParameters.Add(qs3);

    // Insert another QueryStringParameter with the same name as the previous parameter.
    aSqlDataSource.SelectParameters.Add( new QueryStringParameter("QueryStringParameter2","requestfield3") );

    // There are two parameters named QueryStringParam3. Use the
    // RemoveAt method to remove the last element from the collection.
    aSqlDataSource.SelectParameters.RemoveAt( (aSqlDataSource.SelectParameters.Count - 1) );

    // Iterate through the ParameterCollection and print out the
    // names of the Parameters contained by it.
    foreach (Parameter aParameter in aSqlDataSource.SelectParameters) {
        Response.Write(aParameter.Name + "<BR>");
        QueryStringParameter qsptemp = (QueryStringParameter) aParameter;
        Response.Write("QueryStringField is " + qsptemp.QueryStringField + "<BR>");
    }
}
</SCRIPT>

<%@page Language="VB" %>
<SCRIPT runat="server">
Sub Page_Load(sender As Object, e As EventArgs)

    Dim aSqlDataSource As New SqlDataSource()

    ' Security Note: The SqlDataSource uses a QueryStringParameter,
    ' Security Note: which does not perform validation of input from the client.

    Dim qs1 As New QueryStringParameter("QueryStringParam1","requestfield1")
    aSqlDataSource.SelectParameters.Add(qs1)

    Dim qs2 As New QueryStringParameter("QueryStringParam2","requestfield2")
    aSqlDataSource.SelectParameters.Add(qs2)

    ' Insert another QueryStringParameter with the same name as the previous parameter.
    Dim qs3 As New QueryStringParameter("QueryStringParam2","requestfield3")
    aSqlDataSource.SelectParameters.Add(qs3)

    ' There are two parameters named QueryStringParam3. Use the
    ' RemoveAt method to remove the last element from the collection.
    aSqlDataSource.SelectParameters.RemoveAt( (aSqlDataSource.SelectParameters.Count - 1) )

    ' Iterate through the ParameterCollection and print out the
    ' names of the Parameters contained by it.
    Dim aParameter As Parameter
    For Each aParameter in aSqlDataSource.SelectParameters
        Response.Write(aParameter.Name & "<BR>")
        Dim qsptemp As QueryStringParameter = CType(aParameter, QueryStringParameter)
        Response.Write("QueryStringField is " & qsptemp.QueryStringField & "<BR>")
    Next
End Sub ' Page_Load
</SCRIPT>

Remarks

Use the RemoveAt method to remove the Parameter object at the specified index from the collection.

Applies to

Jaa