ParameterCollection.Remove メソッド

.NET Framework クラス ライブラリ リファレンス

ParameterCollection.Remove メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

指定した Parameter オブジェクトを ParameterCollection コレクションから削除します。

名前空間: System.Web.UI.WebControls
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Public Sub Remove ( _
    parameter As Parameter _
)

Visual Basic (使用法)

Dim instance As ParameterCollection
Dim parameter As Parameter

instance.Remove(parameter)

C#

public void Remove (
    Parameter parameter
)

C++

public:
void Remove (
    Parameter^ parameter
)

J#

public void Remove (
    Parameter parameter
)

JScript

public function Remove (
    parameter : Parameter
)

パラメータ

parameter

ParameterCollection から削除する Parameter。

解説

このメソッドを使用して、指定した Parameter オブジェクトを ParameterCollection コレクションから削除します。

使用例

Remove メソッドと Item インデクサを使用して、ParameterCollection コレクションから Parameter オブジェクトを削除する方法を次のコード例に示します。この例では、複数の QueryStringParameter オブジェクトを SelectParameters コレクションに追加しています。コレクションから QueryStringParameter オブジェクトが 1 つ削除され、ページの読み込み時にコレクションの順序が出力されます。

Visual Basic

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

C#

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

J#

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

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
ParameterCollection クラス
ParameterCollection メンバ
System.Web.UI.WebControls 名前空間
Parameter クラス
Add
RemoveAt