CookieParameter クラス

リファレンス

定義

名前空間:: System.Web.UI.WebControls

アセンブリ:: System.Web.dll

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

クライアント側の HTTP クッキーの値をパラメーターオブジェクトにバインドします。パラメータークエリまたはコマンドでこのパラメーターを使用すると、データを選択、フィルター処理、または更新できます。

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

継承: Object

Parameter
CookieParameter

例

次のコード例では、HTTP Cookie にバインドされたコントロールとCookieParameterオブジェクトを使用SqlDataSourceして、Northwind Traders データベースのデータをコントロールに表示する方法をGridView示します。

<%@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 Cookie の値を、データソースコントロールによって使用されるパラメーター ASP.NET バインドできます。

クラスは CookieParameter 、プロパティを CookieName 提供します。このプロパティは、クラスから継承されたものに加えて、バインド先のオブジェクトの名前 HttpCookie を Parameter 識別します。クラスは CookieParameter 、メソッドが呼び出されるたびに Evaluate 、名前付き Cookie にバインドしようとします。

重要

オブジェクトが指定されているが、HTTP 要求で対応する Cookie が渡されない場合、パラメーターにデータを CookieParameter バインドするコントロールは例外をスローする可能性があります。同様に、Cookie がで null渡された場合、データが表示されない場合があります。必要に DefaultValue 応じてこのような状況を回避するには、プロパティを設定します。

コンストラクター

CookieParameter()	CookieParameter クラスの名前のない新しいインスタンスを初期化します。
CookieParameter(CookieParameter)	`original` パラメーターで指定されたインスタンスの値を使用して、CookieParameter クラスの新しいインスタンスを初期化します。
CookieParameter(String, DbType, String)	指定された名前とデータベース型を持ち、指定された HTTP クッキーにバインドされている CookieParameter クラスの新しいインスタンスを初期化します。
CookieParameter(String, String)	バインド先の HTTP クッキーを識別する文字列を指定して、CookieParameter クラスの名前付きの新しいインスタンスを初期化します。
CookieParameter(String, TypeCode, String)	バインド先の HTTP クッキーを識別する文字列を指定して、CookieParameter クラスの厳密に型指定された名前付きの新しいインスタンスを初期化します。

プロパティ

ConvertEmptyStringToNull	Parameter オブジェクトのバインド先の値が Empty の場合に、その値を `null` に変換する必要があるかどうかを示す値を取得または設定します。 (継承元 Parameter)
CookieName	パラメーターのバインド先の HTTP クッキーの名前を取得または設定します。
DbType	パラメーターのデータベース型を取得または設定します。 (継承元 Parameter)
DefaultValue	パラメーターの既定値を指定します。Evaluate(HttpContext, Control) メソッドの呼び出し時に、パラメーターはこの値にバインドされ、初期化前の状態に戻されます。 (継承元 Parameter)
Direction	Parameter オブジェクトを使用して値をコントロールにバインドするかどうか、またはそのコントロールを使用して値を変更できるかどうかを示します。 (継承元 Parameter)
IsTrackingViewState	Parameter オブジェクトがビューステートへの変更を保存しているかどうかを示す値を取得します。 (継承元 Parameter)
Name	パラメーターの名前を取得または設定します。 (継承元 Parameter)
Size	パラメーターのサイズを取得または設定します。 (継承元 Parameter)
Type	パラメーターの型を取得または設定します。 (継承元 Parameter)
ValidateInput	パラメーターの値を検証するかどうかを指定する値を取得または設定します。
ViewState	同一のページに対する複数の要求にわたって、Parameter オブジェクトのビューステートを保存し、復元できるようにする状態情報のディクショナリを取得します。 (継承元 Parameter)

メソッド

Clone()	現在の CookieParameter インスタンスの複製を返します。
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
Evaluate(HttpContext, Control)	CookieParameter オブジェクトの値を更新して返します。
GetDatabaseType()	現在の DbType インスタンスの CLR 型と等価な Parameter 値を取得します。 (継承元 Parameter)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
LoadViewState(Object)	データソースビューの、以前保存したビューステートを復元します。 (継承元 Parameter)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
OnParameterChanged()	OnParametersChanged(EventArgs) オブジェクトを格納する ParameterCollection コレクションの Parameter メソッドを呼び出します。 (継承元 Parameter)
SaveViewState()	ページがサーバーにポストバックされた時間以降に発生した、Parameter オブジェクトのビューステートへの変更を保存します。 (継承元 Parameter)
SetDirty()	Parameter オブジェクトの状態がビューステートで記録されるように、このオブジェクトをマークします。 (継承元 Parameter)
ToString()	このインスタンスの値を、それと等価の文字列形式に変換します。 (継承元 Parameter)
TrackViewState()	Parameter オブジェクトがビューステートの変更を追跡するようにします。それにより、変更をコントロールの ViewState オブジェクトに格納して、同じページに対する複数の要求にわたって永続化できます。 (継承元 Parameter)

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

ICloneable.Clone()	現在の Parameter インスタンスの複製を返します。 (継承元 Parameter)
IStateManager.IsTrackingViewState	Parameter オブジェクトがビューステートへの変更を保存しているかどうかを示す値を取得します。 (継承元 Parameter)
IStateManager.LoadViewState(Object)	データソースビューの、以前保存したビューステートを復元します。 (継承元 Parameter)
IStateManager.SaveViewState()	ページがサーバーにポストバックされた時間以降に発生した、Parameter オブジェクトのビューステートへの変更を保存します。 (継承元 Parameter)
IStateManager.TrackViewState()	Parameter オブジェクトがビューステートの変更を追跡するようにします。それにより、変更をコントロールの ViewState オブジェクトに格納して、同じページに対する複数の要求にわたって永続化できます。 (継承元 Parameter)

適用対象

次の方法で共有