Modifier

Partager via

ParameterCollection.Remove(Parameter) Method

  • Reference

Definition

Namespace:
System.Web.UI.WebControls
Assembly:
System.Web.dll

Removes the specified Parameter object from the ParameterCollection collection.

public:
 void Remove(System::Web::UI::WebControls::Parameter ^ parameter);
public void Remove (System.Web.UI.WebControls.Parameter parameter);
member this.Remove : System.Web.UI.WebControls.Parameter -> unit
Public Sub Remove (parameter As Parameter)

Parameters

parameter
Parameter

The Parameter to remove from the ParameterCollection.

Examples

The following code example demonstrates how to use the Remove method and the Item[] indexer to remove a Parameter object from a ParameterCollection collection. 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 qs2 =
        new QueryStringParameter("QueryStringParam2","requestfield2");
    aSqlDataSource.SelectParameters.Add(qs2);

    QueryStringParameter qs3 =
        new QueryStringParameter("QueryStringParam3","requestfield3");
    aSqlDataSource.SelectParameters.Add(qs3);

    // Remove the QueryStringParameter named QueryStringParameter2
    // using the Remove method and the ParameterCollection indexer
    // property.
    aSqlDataSource.SelectParameters.Remove( aSqlDataSource.SelectParameters["QueryStringParam2"] );

    // 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>");
    }
}
</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)

    Dim qs3 As New QueryStringParameter("QueryStringParam3","requestfield3")
    aSqlDataSource.SelectParameters.Add(qs3)

    ' Remove the QueryStringParameter named QueryStringParameter2
    ' using the Remove method and the ParameterCollection indexer
    ' property.
    aSqlDataSource.SelectParameters.Remove( aSqlDataSource.SelectParameters("QueryStringParam2") )

    ' 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>")
    Next
End Sub ' Page_Load
</SCRIPT>

Remarks

Use this method to remove the specified Parameter object from a ParameterCollection collection.

Applies to

See also