ParameterCollection.Item Property (String)

 

Gets or sets the Parameter object with the specified name in the collection.

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

Public Property Item (
	name As String
) As Parameter

Parameters

name
Type: System.String

The Name of the Parameter to retrieve from the collection.

Property Value

Type: System.Web.UI.WebControls.Parameter

The Parameter with the specified name in the collection. If the Parameter is not found in the collection, the indexer returns null.

Use this indexer to get a Parameter object by name from the ParameterCollection collection, using array notation.

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 is removed from the collection, and the order of the collection is printed when the page loads.

<%@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>

.NET Framework
Available since 2.0
Return to top
Show: