Parameter.Name プロパティ

  • リファレンス

定義

名前空間:
System.Web.UI.WebControls
アセンブリ:
System.Web.dll

パラメーターの名前を取得または設定します。

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

プロパティ値

String

パラメーターの名前。 既定値は Empty です。

例

次のコード例は、中間層のビジネス オブジェクトからデータを取得するコントロールとGridView、結果をObjectDataSource表示するコントロールを使用してフィルター処理されたデータを表示する方法を示しています。 このコード例は、コントロール、コントロール、GridViewコントロール、ObjectDataSourceおよび [送信] ボタンで構成されていますTextBox。 既定では、 TextBox コントロールには従業員の 1 人の名前が Northwind 設定されます。 コントロールには GridView 、コントロール内の名前で識別された従業員に関する情報が TextBox 表示されます。 別の従業員のデータを取得するには、コントロールに従業員の氏名を TextBox 入力し、ボタンをクリックします。

プロパティは FilterExpression 、 プロパティによって取得されたデータをフィルター処理するために使用される式を SelectMethod 指定します。 コレクションに含まれるパラメーターに対して評価されるパラメーター プレースホルダーを FilterParameters 使用します。 この例では、パラメーターの型がスペースを含む文字列型であるため、パラメーター プレースホルダーは単一引用符で囲まれています。 パラメーターの型が数値型または日付型の場合、境界引用符は必要ありません。

このコード例は、 クラスの プロパティに対して FilterExpression 提供されるより大きな例の ObjectDataSource 一部です。

<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.CS" Assembly="Samples.AspNet.CS" %>
<%@ 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 void ObjectDataSource1_Filtering(object sender, ObjectDataSourceFilteringEventArgs e)
    {
        if (Textbox1.Text == "")
        {
            e.ParameterValues.Clear();
            e.ParameterValues.Add("FullName", "Nancy Davolio");
        }
    }
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ObjectDataSource - C# Example</title>
  </head>
  <body>
    <form id="Form1" method="post" runat="server">

        <p>Show all users with the following name.</p>

        <asp:textbox id="Textbox1" runat="server" text="Nancy Davolio" />

        <asp:gridview
          id="GridView1"
          runat="server"
          datasourceid="ObjectDataSource1"
          autogeneratecolumns="False">
          <columns>
            <asp:boundfield headertext="ID" datafield="EmpID" />
            <asp:boundfield headertext="Name" datafield="FullName" />
            <asp:boundfield headertext="Street Address" datafield="Address" />
          </columns>
        </asp:gridview>

        <!-- Security Note: The ObjectDataSource uses a FormParameter,
             Security Note: which does not perform validation of input from the client. -->

        <asp:objectdatasource
          id="ObjectDataSource1"
          runat="server"
          selectmethod="GetAllEmployeesAsDataSet"
          typename="Samples.AspNet.CS.EmployeeLogic"
          filterexpression="FullName='{0}'" OnFiltering="ObjectDataSource1_Filtering">
            <filterparameters>
              <asp:formparameter name="FullName" formfield="Textbox1" defaultvalue="Nancy Davolio" />
            </filterparameters>
        </asp:objectdatasource>

        <p><asp:button id="Button1" runat="server" text="Search" /></p>

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

<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.VB" Assembly="Samples.AspNet.VB" %>
<%@ 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 ObjectDataSource1_Filtering(ByVal sender As Object, ByVal e As System.Web.UI.WebControls.ObjectDataSourceFilteringEventArgs)
        If Textbox1.Text = "" Then
            e.ParameterValues.Clear()
            e.ParameterValues.Add("FullName", "Nancy Davolio")
        End If
    End Sub
</script>

<html xmlns="http://www.w3.org/1999/xhtml" >
  <head>
    <title>ObjectDataSource - VB Example</title>
  </head>
  <body>
    <form id="Form1" method="post" runat="server">

        <p>Show all users with the following name.</p>

        <asp:textbox id="Textbox1" runat="server" text="Nancy Davolio" />

        <asp:gridview
          id="GridView1"
          runat="server"
          datasourceid="ObjectDataSource1"
          autogeneratecolumns="False">
          <columns>
            <asp:boundfield headertext="ID" datafield="EmpID" />
            <asp:boundfield headertext="Name" datafield="FullName" />
            <asp:boundfield headertext="Street Address" datafield="Address" />
          </columns>
        </asp:gridview>

        <!-- Security Note: The ObjectDataSource uses a FormParameter,
             Security Note: which does not perform validation of input from the client. -->

        <asp:objectdatasource
          id="ObjectDataSource1"
          runat="server"
          selectmethod="GetAllEmployeesAsDataSet"
          typename="Samples.AspNet.VB.EmployeeLogic"
          filterexpression="FullName='{0}'" OnFiltering="ObjectDataSource1_Filtering">
            <filterparameters>
              <asp:formparameter name="FullName" formfield="Textbox1" defaultvalue="Nancy Davolio" />
            </filterparameters>
        </asp:objectdatasource>

        <p><asp:button id="Button1" runat="server" text="Search" /></p>

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

注釈

Parameter オブジェクトは名前を持つ必要はありません。ただし、データ ソース コントロールでは、パラメーター名を使用して、コレクション内のオブジェクトと SQL クエリまたはビジネス メソッドシグネチャのパラメーターを照合 Parameter できます。 たとえば、コントロールは SqlDataSource オブジェクトの名前を使用して、 Parameter パラメーター化された SQL クエリのプレースホルダーと一致させることができます。 同様に、コントロールは SqlDataSource コレクション内のオブジェクトの名前を Parameter 使用して、 FilterParameters プロパティの FilterExpression プレースホルダーと一致させることができます。 場合によっては、名前が使用されず、オブジェクトがコレクションにParameterCollection追加されるParameter順序がより重要になります。 詳細については、「 SqlDataSource コントロールでのパラメーターの使用 」および「 ObjectDataSource コントロールでのパラメーターの使用」を参照してください。

パラメーターの名前が変更されると、 OnParameterChanged メソッドが呼び出されます。

適用対象

こちらもご覧ください