Parameter.Name プロパティ
アセンブリ: System.Web (system.web.dll 内)
構文
パラメータの名前。既定値は String.Empty です。
Parameter オブジェクトには名前は必要ありません。ただし、データ ソース コントロールはパラメータ名を使用して、コレクション内の Parameter オブジェクトを SQL クエリまたはビジネス メソッド シグネチャのパラメータと一致させる場合があります。たとえば、SqlDataSource コントロールは、Parameter オブジェクトの名前を使用して、パラメータ化された SQL クエリ内のプレースホルダに一致させます。同様に、SqlDataSource コントロールは、FilterParameters コレクション内の Parameter オブジェクトの名前を使用して、FilterExpression プロパティ内のプレースホルダに一致させます。名前を使用せず、Parameter オブジェクトが ParameterCollection コレクションに追加された順序の方が重要になる場合もあります。詳細については、SqlDataSource コントロールにおけるパラメータの使用、ObjectDataSource コントロールにおけるパラメータの使用 の各トピックを参照してください。
中間層のビジネス オブジェクトおよび GridView コントロールから、ObjectDataSource コントロールを使用してデータを取得し、フィルタ処理済みのデータを表示する方法を次のコード例に示します。このコード例は、TextBox、GridView、ObjectDataSource の各コントロールと [Submit] ボタンで構成されます。既定では、TextBox コントロールには Northwind のいずれかの従業員の名前が設定されます。GridView コントロールには、TextBox コントロール内の名前で識別される従業員の情報が表示されます。別の従業員のデータを取得するには、TextBox コントロールに目的の従業員のフルネームを入力し、ボタンをクリックします。
FilterExpression プロパティは、SelectMethod プロパティによって取得したデータのフィルタ処理に使用する式を指定します。FilterParameters コレクションに含まれるパラメータとして評価されるパラメータ プレースホルダを使用します。この例では、パラメータの型が文字列型 (スペースが含まれる場合がある) であるため、パラメータ プレースホルダは単一引用符で囲まれます。パラメータの型が数値型または日付型の場合、引用符は不要です。
このコード例は、ObjectDataSource クラスの FilterExpression プロパティのトピックで取り上げているコード例の一部分です。
<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.VB" Assembly="Samples.AspNet.VB" %> <%@ Page language="vb" %> <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> <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>
<%@ Register TagPrefix="aspSample" Namespace="Samples.AspNet.CS" Assembly="Samples.AspNet.CS" %> <%@ Page language="c#" %> <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> <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.JSL" Assembly="Samples.AspNet.JSL" %> <%@ Page language="VJ#" %> <script runat="server"> protected void ObjectDataSource1_Filtering(Object sender, ObjectDataSourceFilteringEventArgs e) { if (Textbox1.get_Text() == "") { e.get_ParameterValues().Clear(); e.get_ParameterValues().Add("FullName", "Nancy Davolio"); } } </script> <html> <head> <title>ObjectDataSource - VJ# 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> <asp:objectdatasource id="ObjectDataSource1" runat="server" selectmethod="GetAllEmployeesAsDataSet" typename="Samples.AspNet.JSL.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>
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 によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
参照
- Parameter.Name プロパティのページへのリンク