Export (0) Print
Expand All

ParameterCollection.Remove Method

Note: This method is new in the .NET Framework version 2.0.

Removes the specified Parameter object from the ParameterCollection collection.

Namespace: System.Web.UI.WebControls
Assembly: System.Web (in system.web.dll)

public void Remove (
	Parameter parameter
)
public void Remove (
	Parameter parameter
)
public function Remove (
	parameter : Parameter
)

Parameters

parameter

The Parameter to remove from the ParameterCollection.

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

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="VJ#" %>
<SCRIPT runat="server">
private void Page_Load(Object sender, System.EventArgs e) 
{
    SqlDataSource aSqlDataSource = new SqlDataSource();    

    QueryStringParameter qs1 = 
        new QueryStringParameter("QueryStringParam1","requestfield1");
    aSqlDataSource.get_SelectParameters().Add(qs1);        

    QueryStringParameter qs2 = 
        new QueryStringParameter("QueryStringParam2","requestfield2");        
    aSqlDataSource.get_SelectParameters().Add(qs2);
                
    QueryStringParameter qs3 = 
        new QueryStringParameter("QueryStringParam3","requestfield3");        
    aSqlDataSource.get_SelectParameters().Add(qs3);
                    
    // Remove the QueryStringParameter named QueryStringParameter2
    // using the Remove method and the ParameterCollection indexer 
    // property.
    aSqlDataSource.get_SelectParameters().Remove(
        aSqlDataSource.get_SelectParameters().get_Item("QueryStringParam2"));
            
    // Iterate through the ParameterCollection and print out the 
    // names of the Parameters contained by it.
    Parameter aParameter = null;
    for(int iCtr=0; iCtr < aSqlDataSource.get_SelectParameters().get_Count();
        iCtr++) {
            aParameter = aSqlDataSource.get_SelectParameters()
                .get_Item(iCtr);
            get_Response().Write(aParameter.get_Name() + "<BR>");
    }
} //Page_Load
</SCRIPT>

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show:
© 2015 Microsoft