SqlDataSourceFilteringEventArgs

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

SqlDataSourceFilteringEventArgs クラス

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

SqlDataSource コントロールの Filtering イベントのデータを提供します。

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

Visual Basic (宣言)

Public Class SqlDataSourceFilteringEventArgs
    Inherits CancelEventArgs

Visual Basic (使用法)

Dim instance As SqlDataSourceFilteringEventArgs

C#

public class SqlDataSourceFilteringEventArgs
 : CancelEventArgs

C++

public ref class SqlDataSourceFilteringEventArgs
 : public CancelEventArgs

J#

public class SqlDataSourceFilteringEventArgs
 extends CancelEventArgs

JScript

public class SqlDataSourceFilteringEventArgs
 extends CancelEventArgs

解説

SqlDataSourceFilteringEventArgs クラスは、データを SqlDataSource コントロールの Filtering イベント ハンドラに渡す場合に使用されます。ParameterValues プロパティは、フィルタ操作を実行する前に、フィルタ パラメータ値へのアクセスを提供します。ObjectDataSourceFilteringEventArgs の Cancel プロパティを true に設定すると、Select メソッドをキャンセルできます。DataSourceMode プロパティの値が DataSet に設定されている場合、フィルタ処理がサポートされます。

使用例

Northwind データベースからデータを取得し、FilterExpression と FilterParameters を使用してフィルタ処理する方法を次のコード例に示します。Select メソッドを実行してデータを取得するときは常に、SqlDataSource の FilterExpression が適用されます。この例では、FilterExpression に、FilterParameters コレクションに格納されているフィルタ パラメータのプレースホルダが格納されています。Filtering イベントで、フィルタ パラメータが Label コントロールに表示されます。

Visual Basic

<%@ Page Language="VB" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML
 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

    Protected Sub SqlDataSource1_Filtering(ByVal
 sender As Object, _
        ByVal e As System.Web.UI.WebControls.SqlDataSourceFilteringEventArgs)
        Label1.Text = e.ParameterValues(0).ToString()
    End Sub
</script>

<HTML>
    <BODY>
        <FORM runat="server">

            <p>Show all employees with the following title:
            <asp:DropDownList
                id="DropDownList1"
                runat="server"
                AutoPostBack="True">
                <asp:ListItem>Sales Representative</asp:ListItem>
                <asp:ListItem>Sales Manager</asp:ListItem>
                <asp:ListItem>Vice President, Sales</asp:ListItem>
            </asp:DropDownList></p>

            <asp:SqlDataSource
                id="SqlDataSource1"
                runat="server"
                ConnectionString="<%$ ConnectionStrings:NorthwindConnection
 %>"
                SelectCommand="SELECT EmployeeID,FirstName,LastName,Title
 FROM Employees"
                FilterExpression="Title='{0}'" OnFiltering="SqlDataSource1_Filtering">
                <FilterParameters>
                    <asp:ControlParameter Name="Title"
 ControlId="DropDownList1" PropertyName="SelectedValue"/>
                </FilterParameters>
            </asp:SqlDataSource>

            <p><asp:GridView
                id="GridView1"
                runat="server"
                DataSourceID="SqlDataSource1"
                AutoGenerateColumns="False">
                <columns>
                    <asp:BoundField Visible="False"
 DataField="EmployeeID" />
                    <asp:BoundField HeaderText="First Name"
 DataField="FirstName" />
                    <asp:BoundField HeaderText="Last Name"
 DataField="LastName" />
                </columns>
            </asp:GridView>
                <asp:Label ID="Label1" runat="server"
 Text="Label"></asp:Label>

        </FORM>
    </BODY>
</HTML>

C#

<%@ Page Language="C#" %>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<script runat="server">

    //Protected Sub SqlDataSource1_Filtering(ByVal sender As Object,
 _
    //    ByVal e As System.Web.UI.WebControls.SqlDataSourceFilteringEventArgs)
    //    Label1.Text = e.ParameterValues(0).ToString()
    //End Sub


    protected void SqlDataSource1_Filtering(object
 sender, SqlDataSourceFilteringEventArgs e)
    {
        Label1.Text = e.ParameterValues[0].ToString();
    }
</script>

<HTML>
    <BODY>
        <FORM id="FORM1" runat="server">

            <p>Show all employees with the following title:
            <asp:DropDownList
                id="DropDownList1"
                runat="server"
                AutoPostBack="True">
                <asp:ListItem>Sales Representative</asp:ListItem>
                <asp:ListItem>Sales Manager</asp:ListItem>
                <asp:ListItem>Vice President, Sales</asp:ListItem>
            </asp:DropDownList></p>

            <asp:SqlDataSource
                id="SqlDataSource1"
                runat="server"
                ConnectionString="<%$ ConnectionStrings:NorthwindConnection
 %>"
                SelectCommand="SELECT EmployeeID,FirstName,LastName,Title FROM
 Employees"
                FilterExpression="Title='{0}'" OnFiltering="SqlDataSource1_Filtering">
                <FilterParameters>
                    <asp:ControlParameter Name="Title" ControlId="DropDownList1"
 PropertyName="SelectedValue"/>
                </FilterParameters>
            </asp:SqlDataSource>

            <p><asp:GridView
                id="GridView1"
                runat="server"
                DataSourceID="SqlDataSource1"
                AutoGenerateColumns="False">
                <columns>
                    <asp:BoundField Visible="False" DataField="EmployeeID"
 />
                    <asp:BoundField HeaderText="First Name" DataField="FirstName"
 />
                    <asp:BoundField HeaderText="Last Name" DataField="LastName"
 />
                </columns>
            </asp:GridView>
                <asp:Label ID="Label1" runat="server" Text="Label"></asp:Label>

        </FORM>
    </BODY>
</HTML>

継承階層

System.Object
   System.EventArgs
     System.ComponentModel.CancelEventArgs
      System.Web.UI.WebControls.SqlDataSourceFilteringEventArgs

スレッド セーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッド セーフです。インスタンス メンバの場合は、スレッド セーフであるとは限りません。

プラットフォーム

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

参照

関連項目
SqlDataSourceFilteringEventArgs メンバ
System.Web.UI.WebControls 名前空間
SqlDataSource.FilterParameters プロパティ
SqlDataSource.FilterExpression プロパティ
SqlDataSource.Filtering イベント
SqlDataSourceFilteringEventHandler
Cancel

SqlDataSourceFilteringEventArgs コンストラクタ

メモ : このコンストラクタは、.NET Framework version 2.0 で新しく追加されたものです。

オブジェクトを指定して、SqlDataSourceFilteringEventArgs クラスの新しいインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    parameterValues As IOrderedDictionary _
)

Visual Basic (使用法)

Dim parameterValues As IOrderedDictionary

Dim instance As New SqlDataSourceFilteringEventArgs(parameterValues)

C#

public SqlDataSourceFilteringEventArgs (
    IOrderedDictionary parameterValues
)

C++

public:
SqlDataSourceFilteringEventArgs (
    IOrderedDictionary^ parameterValues
)

J#

public SqlDataSourceFilteringEventArgs (
    IOrderedDictionary parameterValues
)

JScript

public function SqlDataSourceFilteringEventArgs
 (
    parameterValues : IOrderedDictionary
)

パラメータ

parameterValues

Parameter オブジェクトの IOrderedDictionary。

解説

parameterValues コレクションのパラメータは、Select メソッドの実行時に FilterExpression プロパティに指定されたパラメータに関連付けられます。

プラットフォーム

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

参照

関連項目
SqlDataSourceFilteringEventArgs クラス
SqlDataSourceFilteringEventArgs メンバ
System.Web.UI.WebControls 名前空間
SqlDataSource.FilterParameters プロパティ
SqlDataSource.FilterExpression プロパティ
SqlDataSource.Filtering イベント
SqlDataSourceFilteringEventHandler
Cancel

SqlDataSourceFilteringEventArgs プロパティ

パブリック プロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。 ( CancelEventArgs から継承されます。)
	ParameterValues	SqlDataSource クラスの Parameter オブジェクトへのアクセスを提供する IOrderedDictionary オブジェクトを取得します。

参照

関連項目

SqlDataSourceFilteringEventArgs クラス
System.Web.UI.WebControls 名前空間
SqlDataSource.FilterParameters プロパティ
SqlDataSource.FilterExpression プロパティ
SqlDataSource.Filtering イベント
SqlDataSourceFilteringEventHandler
Cancel

SqlDataSourceFilteringEventArgs メソッド

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

関連項目

SqlDataSourceFilteringEventArgs クラス
System.Web.UI.WebControls 名前空間
SqlDataSource.FilterParameters プロパティ
SqlDataSource.FilterExpression プロパティ
SqlDataSource.Filtering イベント
SqlDataSourceFilteringEventHandler
Cancel

SqlDataSourceFilteringEventArgs メンバ

SqlDataSource コントロールの Filtering イベントのデータを提供します。

SqlDataSourceFilteringEventArgs データ型で公開されるメンバを以下の表に示します。

パブリック コンストラクタ

	名前	説明
	SqlDataSourceFilteringEventArgs	オブジェクトを指定して、SqlDataSourceFilteringEventArgs クラスの新しいインスタンスを初期化します。

パブリック プロパティ

	名前	説明
	Cancel	イベントをキャンセルするかどうかを示す値を取得または設定します。(CancelEventArgs から継承されます。)
	ParameterValues	SqlDataSource クラスの Parameter オブジェクトへのアクセスを提供する IOrderedDictionary オブジェクトを取得します。

パブリック メソッド

( プロテクト メソッド も参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュ アルゴリズムや、ハッシュ テーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクト メソッド

	名前	説明
	Finalize	Object がガベージ コレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)

参照

関連項目

SqlDataSourceFilteringEventArgs クラス
System.Web.UI.WebControls 名前空間
SqlDataSource.FilterParameters プロパティ
SqlDataSource.FilterExpression プロパティ
SqlDataSource.Filtering イベント
SqlDataSourceFilteringEventHandler
Cancel