Language

SqlDataSource.FilterExpression プロパティ

定義

Select(DataSourceSelectArguments) メソッドが呼び出されたときに適用されるフィルター式を取得または設定します。

public:
 property System::String ^ FilterExpression { System::String ^ get(); void set(System::String ^ value); };
public string FilterExpression { get; set; }
member this.FilterExpression : string with get, set
Public Property FilterExpression As String

プロパティ値

Select(DataSourceSelectArguments) メソッドを使用してデータを取得するときに適用されるフィルター式を表す文字列。

例外

FilterExpression プロパティが設定され、SqlDataSourceがDataReader モードになっています。

例

次のコード例は、Northwind データベースからデータを取得し、 FilterExpression 文字列と FilterParameters コレクションを使用してフィルター処理する方法を示しています。 FilterExpression プロパティは、データを取得するために Select メソッドが実行されるたびに適用されます。 この例では、 FilterExpression には、 FilterParameters コレクションに含まれるフィルター パラメーターのプレースホルダーが含まれています。 さらに、フィルター パラメーターは、ControlParameter コントロールのSelectedValue プロパティにバインドされているDropDownList オブジェクトです。 DropDownList コントロールのAutoPostBack プロパティは true に設定されているため、DropDownList コントロールの選択を変更すると、ページは情報をサーバーにポストバックし、GridView コントロールは新しいフィルターを使用してデータ ソース コントロールに再バインドします。

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

<html xmlns="http://www.w3.org/1999/xhtml" >
    <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
        <form id="form1" runat="server">

            <p>Show all employees with the following title:
            <asp:DropDownList
                id="DropDownList1"
                runat="server"
                AutoPostBack="True">
                <asp:ListItem Selected="True">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:MyNorthwind%>"
                SelectCommand="SELECT EmployeeID,FirstName,LastName,Title FROM Employees"
                FilterExpression="Title='{0}'">
                <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></p>

        </form>
    </body>
</html>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml" >
    <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
        <form id="form1" runat="server">

            <p>Show all employees with the following title:
            <asp:DropDownList
                id="DropDownList1"
                runat="server"
                AutoPostBack="True">
                <asp:ListItem Selected="True">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:MyNorthwind%>"
                SelectCommand="SELECT EmployeeID,FirstName,LastName,Title FROM Employees"
                FilterExpression="Title='{0}'">
                <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></p>

        </form>
    </body>
</html>

注釈

FilterExpression プロパティ値は、文字列に含まれる置換パラメーターに対して String.Format コレクション内の値を使用する書式指定文字列式 (FilterExpression メソッドによって処理される文字列) です。 フィルター式の構文は、RowFilter プロパティで受け入れられる構文と同じです。フィルター式は、RowFilter メソッドの実行から返されるDataView オブジェクトのSelect プロパティに適用されるためです。 詳細については、Expressionを参照してください。

FilterParameters コレクションにパラメーターを追加する場合は、書式設定文字列のプレースホルダー (たとえば、パラメーター値の代わりに"{0}")を式に含めることもできます。 プレースホルダーは、 FilterParameters コレクション内のパラメーターのインデックスに従って置き換えられます。 FilterParameters コレクション内のオブジェクトがnullされている場合、そのオブジェクトは空の文字列に置き換えられます。

パラメーターは、 FilterExpression プロパティに含めることができます。 パラメーターが文字列型または文字型の場合は、パラメーターを単一引用符で囲みます。 パラメーターが数値型の場合は、引用符は必要ありません。 FilterParameters コレクションには、FilterExpression プロパティで見つかったプレースホルダーに対して評価されるパラメーターが含まれています。

SqlDataSource コントロールは、DataSet モードの場合にのみデータのフィルター処理をサポートします。

FilterExpression プロパティは、FilterExpression コントロールに関連付けられているSqlDataSourceView オブジェクトのSqlDataSource プロパティにデリゲートします。

適用対象

こちらもご覧ください