CookieParameter クラス

定義

クライアント側の HTTP クッキーの値をパラメーター オブジェクトにバインドします。Binds the value of a client-side HTTP cookie to a parameter object. パラメーター クエリまたはコマンドでこのパラメーターを使用すると、データを選択、フィルター処理、または更新できます。The parameter can be used in a parameterized query or command to select, filter, or update data.

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

次のコード例では、HTTP クッキーにバインドされたコントロールとオブジェクトを使用して、 SqlDataSource CookieParameter コントロールに Northwind Traders データベースのデータを表示する方法を示し GridView ます。The following code example demonstrates how to use a SqlDataSource control and CookieParameter object bound to an HTTP cookie to display data from the Northwind Traders database in a GridView control.

<%@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">

void Page_Load(Object sender, EventArgs e){
  // These cookies might be added by a login form.
  // They are added here for simplicity.
  if (!IsPostBack) {
      Response.Cookies.Add(new HttpCookie("lname",    "davolio"));
      Response.Cookies.Add(new HttpCookie("loginname","ndavolio"));
      Response.Cookies.Add(new HttpCookie("lastvisit", DateTime.Now.ToString()));
  }
}


</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <asp:SqlDataSource
          id="SqlDataSource1"
          runat="server"
          DataSourceMode="DataSet"
          ConnectionString="<%$ ConnectionStrings:MyNorthwind%>"
          SelectCommand = "SELECT OrderID,CustomerID,OrderDate,RequiredDate,ShippedDate 
                           FROM Orders WHERE EmployeeID = 
                           (SELECT EmployeeID FROM Employees WHERE LastName = @lastname)">
          <SelectParameters>
            <asp:CookieParameter Name="lastname" CookieName="lname" />
          </SelectParameters>
      </asp:SqlDataSource>

      <asp:GridView
          id="GridView1"
          runat="server"
          AllowSorting="True"
          DataSourceID="SqlDataSource1">
      </asp:GridView>

    </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">

<script runat="server">

Sub Page_Load(sender As Object, e As EventArgs)
  ' These cookies might be added by a login form.
  ' They are added here for simplicity.
  If (Not IsPostBack) Then
      Dim cookie As HttpCookie

      cookie = New HttpCookie("lname","davolio")
      Response.Cookies.Add(cookie)

      cookie = New HttpCookie("loginname","ndavolio")
      Response.Cookies.Add(cookie)

      cookie = New HttpCookie("lastvisit", DateTime.Now.ToString())
      Response.Cookies.Add(cookie)
  End If
End Sub ' Page_Load
</script>
<html xmlns="http://www.w3.org/1999/xhtml" >
  <head runat="server">
    <title>ASP.NET Example</title>
</head>
<body>
    <form id="form1" runat="server">

      <asp:SqlDataSource
          id="SqlDataSource1"
          runat="server"
          DataSourceMode="DataSet"
          ConnectionString="<%$ ConnectionStrings:MyNorthwind%>"
          SelectCommand = "SELECT OrderID,CustomerID,OrderDate,RequiredDate,ShippedDate 
                           FROM Orders WHERE EmployeeID = 
                           (SELECT EmployeeID FROM Employees WHERE LastName = @lastname)">
          <SelectParameters>                 
            <asp:CookieParameter Name="lastname" CookieName="lname" />
          </SelectParameters>
      </asp:SqlDataSource>

      <asp:GridView
          id="GridView1"
          runat="server"
          AllowSorting="True"
          DataSourceID="SqlDataSource1">
      </asp:GridView>

    </form>
  </body>
</html>

注釈

クラスを使用して、 CookieParameter http 要求の一部として渡されるクライアント側の http クッキーの値を、ASP.NET データソースコントロールで使用されるパラメーターにバインドできます。You can use the CookieParameter class to bind the value of a client-side HTTP cookie passed as part of an HTTP request to a parameter used by ASP.NET data source controls.

クラスは、 CookieParameter CookieName バインド先のオブジェクトの名前、およびクラスから継承されたオブジェクトの名前を識別するプロパティを提供し HttpCookie Parameter ます。The CookieParameter class provides the CookieName property, which identifies the name of the HttpCookie object to bind to, in addition to those inherited from the Parameter class. クラスは、 CookieParameter Evaluate メソッドが呼び出されるたびに、指定された cookie にバインドしようとします。The CookieParameter class attempts to bind to the named cookie every time the Evaluate method is called.

重要

パラメーターにデータをバインドするコントロールは、オブジェクトが指定されている場合に例外をスローすることがあり CookieParameter ますが、HTTP 要求では対応するクッキーが渡されません。Controls that bind data to the parameter might throw an exception if a CookieParameter object is specified, but no corresponding cookie is passed with the HTTP request. 同様に、でクッキーが渡された場合、データが表示されないこともあり null ます。Similarly, they might display no data if the cookie is passed with null. DefaultValue必要に応じて、このような状況を回避するには、プロパティを設定します。Set the DefaultValue property to avoid these situations where appropriate.

コンストラクター

CookieParameter()

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

CookieParameter(CookieParameter)

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

CookieParameter(String, DbType, String)

指定された名前とデータベース型を持ち、指定された HTTP クッキーにバインドされている CookieParameter クラスの新しいインスタンスを初期化します。Initializes a new instance of the CookieParameter class that has the specified name and database type and that is bound to the specified HTTP cookie.

CookieParameter(String, String)

バインド先の HTTP クッキーを識別する文字列を指定して、CookieParameter クラスの名前付きの新しいインスタンスを初期化します。Initializes a new named instance of the CookieParameter class, using the specified string to identify which HTTP cookie to bind to.

CookieParameter(String, TypeCode, String)

バインド先の HTTP クッキーを識別する文字列を指定して、CookieParameter クラスの厳密に型指定された名前付きの新しいインスタンスを初期化します。Initializes a new named and strongly typed instance of the CookieParameter class, using the specified string to identify which HTTP cookie 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)
CookieName

パラメーターのバインド先の HTTP クッキーの名前を取得または設定します。Gets or sets the name of the HTTP cookie that the parameter binds to.

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)
Size

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

(継承元 Parameter)
Type

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

(継承元 Parameter)
ValidateInput

パラメーターの値を検証するかどうかを指定する値を取得または設定します。Gets or sets a value that specifies whether the parameter's value is validated.

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()

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

Equals(Object)

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

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

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

適用対象

こちらもご覧ください