Parameter.Name プロパティ
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
パラメーターの名前を取得または設定します。
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
プロパティ値
パラメーターの名前。 既定値は Empty です。
例
次のコード例では、 ObjectDataSource コントロールを使用してフィルター処理されたデータを表示し、中間層のビジネス オブジェクトと GridView コントロールからデータを取得して結果を表示する方法を示します。 このコード例は、 TextBox コントロール、 GridView コントロール、 ObjectDataSource コントロール、送信ボタンで構成されています。 既定では、 TextBox コントロールには、 Northwind 従業員の 1 人の名前が設定されます。
GridView コントロールには、TextBox コントロールの名前で識別された従業員に関する情報が表示されます。 別の従業員のデータを取得するには、 TextBox コントロールに従業員の氏名を入力し、ボタンをクリックします。
FilterExpression プロパティは、SelectMethod プロパティによって取得されたデータをフィルター処理するために使用される式を指定します。 FilterParameters コレクションに含まれるパラメーターに評価されるパラメーター プレースホルダーを使用します。 この例では、パラメーターの型がスペースを含む文字列型であるため、パラメーター プレースホルダーは単一引用符で囲まれています。 パラメーターの型が数値型または日付型の場合、境界引用符は必要ありません。
このコード例は、ObjectDataSource クラスの FilterExpression プロパティに対して提供されるより大きな例の一部です。
<%@ 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 オブジェクトに名前を付ける必要はありません。ただし、データ ソース コントロールでは、パラメーター名を使用して、コレクション内の Parameter オブジェクトと SQL クエリまたはビジネス メソッドシグネチャのパラメーターを照合できます。 たとえば、 SqlDataSource コントロールでは、 Parameter オブジェクトの名前を使用して、パラメーター化された SQL クエリのプレースホルダーと一致させることができます。 同様に、SqlDataSource コントロールでは、FilterParameters コレクション内のParameter オブジェクトの名前を使用して、FilterExpression プロパティのプレースホルダーと一致させることができます。 場合によっては、名前が使用されず、 Parameter オブジェクトが ParameterCollection コレクションに追加される順序がより重要になります。 詳細については、「 SqlDataSource コントロールでのパラメーターの使用 」および 「ObjectDataSource コントロールでのパラメーターの使用」を参照してください。
パラメーターの名前が変更されると、 OnParameterChanged メソッドが呼び出されます。