ControlParameter クラス

定義

Control のプロパティの値をパラメーター オブジェクトにバインドします。Binds the value of a property of a Control to a parameter object.

public ref class ControlParameter : System::Web::UI::WebControls::Parameter
public class ControlParameter : System.Web.UI.WebControls.Parameter
type ControlParameter = class
    inherit Parameter
Public Class ControlParameter
Inherits Parameter
継承
ControlParameter

次のコード例では、オブジェクトをControlParameter使用して、宣言型のListBoxシナリオでコントロールに表示されるDropDownListデータをコントロールの選択された値にバインドする方法を示します。The following code example demonstrates how to use a ControlParameter object to bind data displayed in a ListBox control to the selected value of a DropDownList control in a declarative scenario. SqlDataSource SelectParameters SelectCommandオブジェクトはフォーム上のコントロールのコレクションに追加され、プロパティの "@Title" プレースホルダーテキストに対応します。 ControlParameterThe ControlParameter object is added to the SelectParameters collection of the SqlDataSource control on the form, and corresponds to the "@Title" placeholder text in the SelectCommand property.

<!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><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 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 xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <p><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 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>

注釈

ControlParameterクラスを使用すると、 SelectedValueSelectedIndexなどControlのプロパティの値を、パラメーター化された SQL クエリ、ビジネスオブジェクトのメソッド、またはフィルター式で使用されるパラメーターにバインドできます。You can use the ControlParameter class to bind the value of a Control property, such as SelectedValue or SelectedIndex, to a parameter that is used in a parameterized SQL query, business object method, or filtering expression.

クラスControlParameterは、 Parameter PropertyNameクラスControlIDから継承されたプロパティに加えて、との2つのプロパティを提供します。The ControlParameter class provides two properties in addition to those inherited from the Parameter class: ControlID and PropertyName. プロパティControlIDは、バインドControlするインスタンスを識別しますPropertyName 。プロパティは、 ControlクラスがControlParameter値を取得するのパブリックプロパティを識別します。The ControlID property identifies which Control instance to bind to and the PropertyName property identifies the public property of the Control from which the ControlParameter class retrieves a value.

コンストラクター

ControlParameter()

ControlParameter クラスの名前のない新しいインスタンスを初期化します。Initializes a new unnamed instance of the ControlParameter class.

ControlParameter(ControlParameter)

指定したインスタンスの値を使用して、ControlParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the ControlParameter class with values from the specified instance.

ControlParameter(String, DbType, String, String)

指定したパラメーター名、データベース型、コントロール ID、およびプロパティ名を使用して、ControlParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the ControlParameter class by using the specified parameter name, database type, control ID, and property name.

ControlParameter(String, String)

バインド先のコントロールを識別する指定されたコントロール名を使用して、ControlParameter クラスの名前付きの新しいインスタンスを初期化します。Initializes a new named instance of the ControlParameter class, using the specified control name to identify which control to bind to.

ControlParameter(String, String, String)

指定されたプロパティ名およびバインド先のコントロールを識別するコントロール名を使用して、ControlParameter クラスの名前付きの新しいインスタンスを初期化します。Initializes a new named instance of the ControlParameter class, using the specified property name and control name to identify which control to bind to.

ControlParameter(String, TypeCode, String, String)

指定されたプロパティ名およびバインド先のコントロールを識別するコントロール名を使用して、ControlParameter クラスの厳密に型指定された名前付きの新しいインスタンスを初期化します。Initializes a new named and strongly typed instance of the ControlParameter class, using the specified property name and control name to identify which control to bind to.

プロパティ

ControlID

ControlParameter オブジェクトのバインド先のコントロールの名前を指定します。Specifies the name of the control that the ControlParameter object binds to.

ConvertEmptyStringToNull

Parameter オブジェクトのバインド先の値が Empty の場合に、その値を null に変換する必要があるかどうかを示す値を取得または設定します。Gets or sets a value indicating whether the value that the Parameter object is bound to should be converted to null if it is Empty.

(継承元 Parameter)
DbType

パラメーターのデータベース型を取得または設定します。Gets or sets the database type of the parameter.

(継承元 Parameter)
DefaultValue

パラメーターの既定値を指定します。Evaluate(HttpContext, Control) メソッドの呼び出し時に、パラメーターはこの値にバインドされ、初期化前の状態に戻されます。Specifies a default value for the parameter, should the value that the parameter is bound to be uninitialized when the Evaluate(HttpContext, Control) method is called.

(継承元 Parameter)
Direction

Parameter オブジェクトを使用して値をコントロールにバインドするかどうか、またはそのコントロールを使用して値を変更できるかどうかを示します。Indicates whether the Parameter object is used to bind a value to a control, or the control can be used to change the value.

(継承元 Parameter)
IsTrackingViewState

Parameter オブジェクトがビューステートへの変更を保存しているかどうかを示す値を取得します。Gets a value indicating whether the Parameter object is saving changes to its view state.

(継承元 Parameter)
Name

パラメーターの名前を取得または設定します。Gets or sets the name of the parameter.

(継承元 Parameter)
PropertyName

ControlID オブジェクトがバインドする、ControlParameter プロパティにより識別されるコントロールのプロパティの名前を取得または設定します。Gets or sets the property name of the control identified by the ControlID property that the ControlParameter object binds to.

Size

パラメーターのサイズを取得または設定します。Gets or sets the size of the parameter.

(継承元 Parameter)
Type

パラメーターの型を取得または設定します。Gets or sets the type of the parameter.

(継承元 Parameter)
ViewState

同一のページに対する複数の要求にわたって、Parameter オブジェクトのビューステートを保存し、復元できるようにする状態情報のディクショナリを取得します。Gets a dictionary of state information that allows you to save and restore the view state of a Parameter object across multiple requests for the same page.

(継承元 Parameter)

メソッド

Clone()

現在の ControlParameter インスタンスの複製を返します。Returns a duplicate of the current ControlParameter instance.

Equals(Object)

指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判定します。Determines whether the specified object is equal to the current object.

(継承元 Object)
Evaluate(HttpContext, Control)

ControlParameter オブジェクトの値を更新して返します。Updates and returns the value of the ControlParameter object.

GetDatabaseType()

現在の DbType インスタンスの CLR 型と等価な Parameter 値を取得します。Gets the DbType value that is equivalent to the CLR type of the current Parameter instance.

(継承元 Parameter)
GetHashCode()

既定のハッシュ関数として機能します。Serves as the default hash function.

(継承元 Object)
GetType()

現在のインスタンスの Type を取得します。Gets the Type of the current instance.

(継承元 Object)
LoadViewState(Object)

データ ソース ビューの、以前保存したビューステートを復元します。Restores the data source view's previously saved view state.

(継承元 Parameter)
MemberwiseClone()

現在の Object の簡易コピーを作成します。Creates a shallow copy of the current Object.

(継承元 Object)
OnParameterChanged()

OnParametersChanged(EventArgs) オブジェクトを格納する ParameterCollection コレクションの Parameter メソッドを呼び出します。Calls the OnParametersChanged(EventArgs) method of the ParameterCollection collection that contains the Parameter object.

(継承元 Parameter)
SaveViewState()

ページがサーバーにポスト バックされた時間以降に発生した、Parameter オブジェクトのビューステートへの変更を保存します。Saves the changes to the Parameter object's view state since the time the page was posted back to the server.

(継承元 Parameter)
SetDirty()

Parameter オブジェクトの状態がビューステートで記録されるように、このオブジェクトをマークします。Marks the Parameter object so its state will be recorded in view state.

(継承元 Parameter)
ToString()

このインスタンスの値を、それと等価の文字列形式に変換します。Converts the value of this instance to its equivalent string representation.

(継承元 Parameter)
TrackViewState()

Parameter オブジェクトがビューステートの変更を追跡するようにします。それにより、変更をコントロールの ViewState オブジェクトに格納して、同じページに対する複数の要求にわたって永続化できます。Causes the Parameter object to track changes to its view state so they can be stored in the control's ViewState object and persisted across requests for the same page.

(継承元 Parameter)

明示的なインターフェイスの実装

ICloneable.Clone()

現在の Parameter インスタンスの複製を返します。Returns a duplicate of the current Parameter instance.

(継承元 Parameter)
IStateManager.IsTrackingViewState

Parameter オブジェクトがビューステートへの変更を保存しているかどうかを示す値を取得します。Gets a value indicating whether the Parameter object is saving changes to its view state.

(継承元 Parameter)
IStateManager.LoadViewState(Object)

データ ソース ビューの、以前保存したビューステートを復元します。Restores the data source view's previously saved view state.

(継承元 Parameter)
IStateManager.SaveViewState()

ページがサーバーにポスト バックされた時間以降に発生した、Parameter オブジェクトのビューステートへの変更を保存します。Saves the changes to the Parameter object's view state since the time the page was posted back to the server.

(継承元 Parameter)
IStateManager.TrackViewState()

Parameter オブジェクトがビューステートの変更を追跡するようにします。それにより、変更をコントロールの ViewState オブジェクトに格納して、同じページに対する複数の要求にわたって永続化できます。Causes the Parameter object to track changes to its view state so they can be stored in the control's ViewState object and persisted across requests for the same page.

(継承元 Parameter)

適用対象

こちらもご覧ください