SessionParameter クラス

定義

セッション変数の値をパラメーター オブジェクトにバインドします。Binds the value of a session variable to a parameter object.

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

次の例は、オブジェクトのSessionParameter使用方法を示しています。The following example shows how to use a SessionParameter object. この例では、別のページがという名前empidのセッション変数に employee ID 値を格納していることを前提としています。The example assumes that another page has stored an employee ID value in a session variable named empid. この例のページでempidは、クエリのWhere句で session 変数を使用し、クエリGridViewの結果をコントロールに表示します。The example page uses the empid session variable in the Where clause of a query and displays the result of the query in a GridView control. オブジェクトのプロパティは5に設定されているので、この例を実行employeeIDする前に、という名前のセッション変数が設定empidされていない場合は、5という値を持つレコードのデータが表示されます。 DefaultValue SessionParameterBecause the DefaultValue property of the SessionParameter object is set to 5, data for the record that has the employeeID value of 5 will still be displayed if no session variable named empid is set before you run the example.

<%@ Page language="C#"%>
<!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" method="post" runat="server">
      <p>Show My Orders:</p>

      <asp:SqlDataSource
          id="OdbcDataSource1"
          runat="server"
          ProviderName="System.Data.Odbc"
          ConnectionString="dsn=MyOdbcDsn;"
          SelectCommand="SELECT OrderId, CustomerId, OrderDate
                         FROM Orders
                         WHERE EmployeeID = ?
                         ORDER BY CustomerId ASC;">
          <SelectParameters>
              <asp:SessionParameter
                Name="empid"
                SessionField="empid"
                DefaultValue="5" />
          </SelectParameters>
      </asp:SqlDataSource>

      <p>
      <asp:GridView
          id="GridView1"
          runat="server"
          DataSourceID="OdbcDataSource1" />
      </p>
    </form>
  </body>
</html>
<%@ Page language="VB"%>
<!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" method="post" runat="server">
      <p>Show My Orders:</p>

      <asp:SqlDataSource
          id="OdbcDataSource1"
          runat="server"
          ProviderName="System.Data.Odbc"
          ConnectionString="dsn=MyOdbcDsn;"
          SelectCommand="SELECT OrderId, CustomerId, OrderDate 
                         FROM Orders 
                         WHERE EmployeeID = ? 
                         ORDER BY CustomerId ASC;">
          <SelectParameters>
              <asp:SessionParameter
                Name="empid"
                SessionField="empid"
                DefaultValue="5" />
          </SelectParameters>
      </asp:SqlDataSource>

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

注釈

オブジェクトは、通常、データベースクエリのWhere句にHttpSessionState変数の値を含めるために使用されます。 SessionParameterA SessionParameter object is typically used in order to include the value of an HttpSessionState variable in the Where clause of a database query. プロパティSessionFieldは、がSessionParameter値を取得するときに使用されるセッション変数を識別します。The SessionField property identifies the session variable from which the SessionParameter retrieves a value.

注意

SessionParameterオブジェクトを使用してパラメーターにデータをバインドするコントロールは、指定されたセッション変数が設定されていない場合に、例外をスローすることがあります。Controls that bind data to a parameter by using a SessionParameter object might throw an exception if the specified session variable is not set. このエラーを回避するには (該当する場合DefaultValue )、プロパティを設定します。To avoid this error (where appropriate), set the DefaultValue property.

コンストラクター

SessionParameter()

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

SessionParameter(SessionParameter)

original パラメーターで指定されたインスタンスの値を使用して、SessionParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the SessionParameter class with the values of the instance specified by the original parameter.

SessionParameter(String, DbType, String)

指定された名前と型を使用し、指定されたセッション状態の名前/値ペアにパラメーターをバインドして、SessionParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the SessionParameter class, by using the specified name and type, and binding the parameter to the specified session state name/value pair. このコンストラクターは、データベース型用です。This constructor is for database types.

SessionParameter(String, String)

バインド先のセッション状態の名前/値ペアを識別する文字列を指定して、SessionParameter クラスの名前付きの新しいインスタンスを初期化します。Initializes a new named instance of the SessionParameter class, using the specified string to identify which session state name/value pair to bind to.

SessionParameter(String, TypeCode, String)

バインド先のセッション状態の名前/値ペアを識別する文字列を指定して、SessionParameter クラスの厳密に型指定された名前付きの新しいインスタンスを初期化します。Initializes a new named and strongly typed instance of the SessionParameter class, using the specified string to identify which session state name/value pair to bind 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)
SessionField

パラメーターのバインド先のセッション変数の名前を取得または設定します。Gets or sets the name of the session variable that the parameter 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()

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

Equals(Object)

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

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

SessionParameter オブジェクトの値を更新して返します。Updates and returns the value of the SessionParameter 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)

適用対象

こちらもご覧ください