ControlParameter.PropertyName プロパティとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

ControlParameter.PropertyName プロパティ

メモ : このプロパティは、.NET Framework version 2.0 で新しく追加されたものです。

ControlParameter オブジェクトがバインドする、ControlID プロパティにより識別されるコントロールのプロパティの名前を取得または設定します。

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

Visual Basic (宣言)

Public Property PropertyName As
 String

Visual Basic (使用法)

Dim instance As ControlParameter
Dim value As String

value = instance.PropertyName

instance.PropertyName = value

public string PropertyName { get;
 set; }

C++

public:
property String^ PropertyName {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_PropertyName ()

/** @property */
public void set_PropertyName (String value)

JScript

public function get PropertyName
 () : String

public function set PropertyName
 (value : String)

プロパティ値
ControlParameter がバインドする、コントロールのプロパティの名前を表す string。

解説

PropertyName プロパティは、実行時に ControlParameter オブジェクトがバインドする、ControlID プロパティにより識別される Control オブジェクトのパブリックプロパティを識別します。PropertyName には、複合コントロールのプロパティを識別するための "SelectedValue" などの単純文字列、または Eval 構文を使用した式を設定できます。

PropertyName プロパティはオプションですが、Evaluate メソッドがコントロールに正しくバインドできるように、通常、ControlID プロパティと PropertyName プロパティの両方を設定します。ControlID プロパティを設定し、PropertyName プロパティを設定しないと、Evaluate メソッドは ControlValuePropertyAttribute 属性を使用して既定の PropertyName プロパティを識別しようとします(この属性の指定はコントロール作成者の責任です)。識別に失敗すると、Evaluate は、ArgumentException 例外をスローします。

次の表は、プロパティに ControlValuePropertyAttribute 属性を装飾する ASP.NET コントロールの一覧です。

コントロール	プロパティ
Calendar	SelectedDate
CheckBox	Checked
DataList	SelectedValue
DetailsView	SelectedValue
FormView	SelectedValue
GridView	SelectedValue
Label	Text
ListControl	SelectedValue
Menu	SelectedValue
TextBox	Text
TreeView	SelectedValue

使用例

次のコード例では、ControlParameter オブジェクトを使用して、ListBox コントロール内に表示されるデータを、宣言シナリオの DropDownList コントロールの選択した値にバインドする方法を示します。ControlParameter オブジェクトは、フォームの SqlDataSource コントロールの SelectParameters コレクションに追加され、SelectCommand プロパティの "@Title" プレースホルダテキストに対応します。

Visual Basic

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

      <p><asp:dropdownlist
          id="DropDownList1"
          runat="server"
          autopostback="True">
          <asp:listitem selected>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 LastName FROM Employees WHERE
 Title = @Title">
          <selectparameters>
              <asp:controlparameter name="Title"
 controlid="DropDownList1" propertyname="SelectedValue"/>
          </selectparameters>
      </asp:sqldatasource>

      <p><asp:listbox
          id="ListBox1"
          runat="server"
          datasourceid="SqlDataSource1"
          datatextfield="LastName">
      </asp:listbox></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>
  <body>
    <form runat="server">

      <p><asp:dropdownlist
          id="DropDownList1"
          runat="server"
          autopostback="True">
          <asp:listitem selected>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 LastName FROM Employees WHERE Title = @Title">
          <selectparameters>
              <asp:controlparameter name="Title" controlid="DropDownList1"
 propertyname="SelectedValue"/>
          </selectparameters>
      </asp:sqldatasource>

      <p><asp:listbox
          id="ListBox1"
          runat="server"
          datasourceid="SqlDataSource1"
          datatextfield="LastName">
      </asp:listbox></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>
  <BODY>
    <FORM runat="server">

      <p><asp:DropDownList
          id="DropDownList1"
          runat="server"
          AutoPostBack="True">
          <asp:ListItem Selected>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="Data Source=localhost;Integrated Security=SSPI;Initial
 Catalog=Northwind;"
          SelectCommand="SELECT LastName FROM Employees WHERE Title = @Title">
          <SelectParameters>
              <asp:ControlParameter Name="Title" ControlId="DropDownList1"
 PropertyName="SelectedValue"/>
          </SelectParameters>
      </asp:SqlDataSource>

      <p><asp:ListBox
          id="ListBox1"
          runat="server"
          DataSourceID="SqlDataSource1"
          DataTextField="LastName">
      </asp:ListBox></p>

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

ControlID プロパティおよび PropertyName プロパティを設定して、ControlParameter オブジェクトのバインド先のコントロールを指定する方法を、次のコード例に示します。この例では、ListBox コントロールに値が読み込まれます。ListBox コントロールの SelectedValue プロパティを使用して、SqlDataSource コントロールが取得するデータおよび GridView コントロールが表示するデータに対してフィルタ処理を行っています。

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">
Private Sub Page_Load(sender As
 Object, e As EventArgs)

    If (IsPostBack) Then
        GridView1.DataBind()
    Else
      Dim li As ListItem

      li = New ListItem("Nancy Davolio",
   "1",True)
      ListBox1.Items.Add(li)

      li = New ListItem("Janet Leverling",
 "3",True)
      ListBox1.Items.Add(li)

      li = New ListItem("Margaret Peacock"
,"4",True)
      ListBox1.Items.Add(li)

      li = New ListItem("Michael Suyama",
  "6",True)
      ListBox1.Items.Add(li)

      li = New ListItem("Robert King",
     "7",True)
      ListBox1.Items.Add(li)

      li = New ListItem("Anne Dodsworth",
  "9",True)
      ListBox1.Items.Add(li)
    End If
End Sub ' Page_Load
</SCRIPT>

<HTML>
  <body>
    <form id="Form1" method="post"
 runat="server">
      <p>Show Orders For:</P>

      <p>
      <asp:ListBox
        id="ListBox1"
        runat="server"
        AutoPostBack="True">
      </asp:ListBox></P>

      <asp:SqlDataSource
        id="OdbcDataSource1"
        runat="server"
        ProviderName="System.Data.Odbc"
        DataSourceMode="DataSet"
        SelectCommand="SELECT OrderID, ShipName FROM Orders WHERE
 EmployeeID = ?;"
        ConnectionString="dsn=MyOdbcDSN;">
        <SELECTPARAMETERS>
          <asp:ControlParameter
            PropertyName="SelectedValue"
            ControlID="ListBox1"
            Name="empID">
          </asp:ControlParameter>
        </SELECTPARAMETERS>
      </asp:SqlDataSource>

      <p>
      <asp:GridView
        id="GridView1"
        runat="server"
        DataSourceID="OdbcDataSource1">
      </asp:GridView></p>
    </form>
  </body>
</HTML>

<%@ 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">
private void Page_Load(object sender, System.EventArgs
 e)
{
  if (IsPostBack) {
    GridView1.DataBind();
  }
  else {
    ListBox1.Items.Add(new ListItem("Nancy Davolio",
   "1",true));
    ListBox1.Items.Add(new ListItem("Janet Leverling",
 "3",true));
    ListBox1.Items.Add(new ListItem("Margaret Peacock"
,"4",true));
    ListBox1.Items.Add(new ListItem("Michael Suyama",
  "6",true));
    ListBox1.Items.Add(new ListItem("Robert King", 
    "7",true));
    ListBox1.Items.Add(new ListItem("Anne Dodsworth",
  "9",true));
  }
}
</SCRIPT>

<HTML>
  <body>
    <form id="Form1" method="post" runat="server">
      <p>Show Orders For:</P>

      <p>
      <asp:ListBox
        id="ListBox1"
        runat="server"
        AutoPostBack="True">
      </asp:ListBox></P>

      <asp:SqlDataSource
        id="OdbcDataSource1"
        runat="server"
        ProviderName="System.Data.Odbc"
        DataSourceMode="DataSet"
        SelectCommand="SELECT OrderID, ShipName FROM Orders WHERE EmployeeID
 = ?;"
        ConnectionString="dsn=MyOdbcDSN;">
        <SELECTPARAMETERS>
          <asp:ControlParameter
            PropertyName="SelectedValue"
            ControlID="ListBox1"
            Name="empID">
          </asp:ControlParameter>
        </SELECTPARAMETERS>
      </asp:SqlDataSource>

      <p>
      <asp:GridView
        id="GridView1"
        runat="server"
        DataSourceID="OdbcDataSource1">
      </asp:GridView></p>
    </form>
  </body>
</HTML>

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

<SCRIPT runat="server">
    private void Page_Load(Object sender, System.EventArgs
 e)
    {
        if (get_IsPostBack()) {
            GridView1.DataBind();
        }
        else {
            ListBox1.get_Items().Add(new ListItem("Nancy
 Davolio", "1"));
            ListBox1.get_Items().Add(new ListItem("Janet
 Leverling", "3"));
            ListBox1.get_Items().Add(new ListItem("Margaret
 Peacock", "4"));
            ListBox1.get_Items().Add(new ListItem("Michael
 Suyama", "6"));
            ListBox1.get_Items().Add(new ListItem("Robert
 King", "7"));
            ListBox1.get_Items().Add(new ListItem("Anne Dodsworth",
 "9"));
        }
    }//Page_Load
</SCRIPT>

<HTML>
  <body>
    <form id="Form1" method="post" runat="server">
      <p>Show Orders For:</P>

      <p>
      <asp:ListBox
        id="ListBox1"
        runat="server"
        AutoPostBack="True">
      </asp:ListBox></P>

      <asp:SqlDataSource
        id="OdbcDataSource1"
        runat="server"
        ProviderName="System.Data.Odbc"
        DataSourceMode="DataSet"
        SelectCommand="SELECT OrderID, ShipName FROM Orders WHERE EmployeeID
 = ?;"
        ConnectionString="dsn=MyOdbcDSN;">
        <SELECTPARAMETERS>
          <asp:ControlParameter
            PropertyName="SelectedValue"
            ControlID="ListBox1"
            Name="empID">
          </asp:ControlParameter>
        </SELECTPARAMETERS>
      </asp:SqlDataSource>

      <p>
      <asp:GridView
        id="GridView1"
        runat="server"
        DataSourceID="OdbcDataSource1">
      </asp:GridView></p>
    </form>
  </body>
</HTML>