CookieParameter CookieParameter CookieParameter CookieParameter Class

Определение

Привязывает значение файла cookie 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
Наследование
CookieParameterCookieParameterCookieParameterCookieParameter

Примеры

В следующем примере кода демонстрируется использование SqlDataSource управления и CookieParameter объект привязан к HTTP-cookie для отображения данных из базы данных 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 для привязки значение файла cookie HTTP на стороне клиента, параметр, используемый элементами управления источником данных ASP.NET, передаваемый как часть HTTP-запроса.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 Класс пытается выполнить привязку именованного файла cookie при каждом Evaluate вызывается метод.The CookieParameter class attempts to bind to the named cookie every time the Evaluate method is called.

Важно!

Элементы управления с привязкой данных в параметре может исключение, если CookieParameter объект указан, но не соответствующий файл cookie передается с помощью 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. Аналогичным образом, они могут не отображать данные, если файл cookie передается с 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() CookieParameter() CookieParameter()

Инициализирует новый безымянный экземпляр класса CookieParameter.Initializes a new unnamed instance of the CookieParameter class.

CookieParameter(CookieParameter) CookieParameter(CookieParameter) CookieParameter(CookieParameter) CookieParameter(CookieParameter)

Инициализирует новый экземпляр класса CookieParameter значениями экземпляра, заданного параметром original.Initializes a new instance of the CookieParameter class with the values of the instance specified by the original parameter.

CookieParameter(String, DbType, String) CookieParameter(String, DbType, String) CookieParameter(String, DbType, String) CookieParameter(String, DbType, String)

Инициализирует новый экземпляр класса CookieParameter, который имеет указанные имя и тип базы данных и привязан к заданному файлу Cookie HTTP.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) CookieParameter(String, String) CookieParameter(String, String) CookieParameter(String, String)

Инициализирует новый именованный экземпляр класса CookieParameter, используя заданную строку для обозначения файла cookie HTTP, к которому выполняется привязка.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) CookieParameter(String, TypeCode, String) CookieParameter(String, TypeCode, String) CookieParameter(String, TypeCode, String)

Инициализирует новый именованный и строго типизированный экземпляр класса CookieParameter, используя заданную строку для обозначения файла cookie HTTP, к которому выполняется привязка.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 ConvertEmptyStringToNull ConvertEmptyStringToNull ConvertEmptyStringToNull

Возвращает или задает значение, указывающее на необходимость преобразования значения, к которому привязан объект Parameter в null, если его значение равно Empty.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.

(Inherited from Parameter)
CookieName CookieName CookieName CookieName

Возвращает или задает имя файла cookie HTTP, к которому привязывается параметр.Gets or sets the name of the HTTP cookie that the parameter binds to.

DbType DbType DbType DbType

Возвращает или задает тип базы данных параметра.Gets or sets the database type of the parameter.

(Inherited from Parameter)
DefaultValue DefaultValue DefaultValue 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.

(Inherited from Parameter)
Direction Direction Direction 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.

(Inherited from Parameter)
IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState IStateManager.IsTrackingViewState

Получает значение, указывающее сохраняет ли объект Parameter изменения в данных о состоянии представления.Gets a value indicating whether the Parameter object is saving changes to its view state.

(Inherited from Parameter)
IsTrackingViewState IsTrackingViewState IsTrackingViewState IsTrackingViewState

Получает значение, указывающее сохраняет ли объект Parameter изменения в данных о состоянии представления.Gets a value indicating whether the Parameter object is saving changes to its view state.

(Inherited from Parameter)
Name Name Name Name

Получает или задает имя параметра.Gets or sets the name of the parameter.

(Inherited from Parameter)
Size Size Size Size

Возвращает или задает размер параметра.Gets or sets the size of the parameter.

(Inherited from Parameter)
Type Type Type Type

Получает или задает тип параметра.Gets or sets the type of the parameter.

(Inherited from Parameter)
ValidateInput ValidateInput ValidateInput ValidateInput

Получает или задает значение, указывающее, проверяется ли значение параметра.Gets or sets a value that specifies whether the parameter's value is validated.

ViewState ViewState ViewState 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.

(Inherited from Parameter)

Методы

Clone() Clone() Clone() Clone()

Возвращает дубликат текущего экземпляра CookieParameter.Returns a duplicate of the current CookieParameter instance.

Equals(Object) Equals(Object) Equals(Object) Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Inherited from Object)
Evaluate(HttpContext, Control) Evaluate(HttpContext, Control) Evaluate(HttpContext, Control) Evaluate(HttpContext, Control)

Обновляет и возвращает значение объекта CookieParameter.Updates and returns the value of the CookieParameter object.

GetDatabaseType() GetDatabaseType() GetDatabaseType() GetDatabaseType()

Возвращает значение DbType, эквивалентное типу среды CLR текущего экземпляра Parameter.Gets the DbType value that is equivalent to the CLR type of the current Parameter instance.

(Inherited from Parameter)
GetHashCode() GetHashCode() GetHashCode() GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Inherited from Object)
GetType() GetType() GetType() GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Inherited from Object)
LoadViewState(Object) LoadViewState(Object) LoadViewState(Object) LoadViewState(Object)

Восстанавливает сохраненное раннее состояние представления источника данных.Restores the data source view's previously saved view state.

(Inherited from Parameter)
MemberwiseClone() MemberwiseClone() MemberwiseClone() MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Inherited from Object)
OnParameterChanged() OnParameterChanged() OnParameterChanged() OnParameterChanged()

Вызывает метод OnParametersChanged(EventArgs) коллекции ParameterCollection, содержащей объект Parameter.Calls the OnParametersChanged(EventArgs) method of the ParameterCollection collection that contains the Parameter object.

(Inherited from Parameter)
SaveViewState() SaveViewState() SaveViewState() SaveViewState()

Сохраняет изменения в данных о состоянии представления объекта Parameter после обратной передачи страницы на сервер.Saves the changes to the Parameter object's view state since the time the page was posted back to the server.

(Inherited from Parameter)
SetDirty() SetDirty() SetDirty() SetDirty()

Обозначает объект Parameter как подлежащий записи его состояния в данные о состоянии представления.Marks the Parameter object so its state will be recorded in view state.

(Inherited from Parameter)
ToString() ToString() ToString() ToString()

Преобразует значение этого экземпляра в эквивалентное ему строковое представление.Converts the value of this instance to its equivalent string representation.

(Inherited from Parameter)
TrackViewState() TrackViewState() TrackViewState() 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.

(Inherited from Parameter)

Явные реализации интерфейса

ICloneable.Clone() ICloneable.Clone() ICloneable.Clone() ICloneable.Clone()

Возвращает дубликат текущего экземпляра Parameter.Returns a duplicate of the current Parameter instance.

(Inherited from Parameter)
IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object) IStateManager.LoadViewState(Object)

Восстанавливает сохраненное раннее состояние представления источника данных.Restores the data source view's previously saved view state.

(Inherited from Parameter)
IStateManager.SaveViewState() IStateManager.SaveViewState() IStateManager.SaveViewState() IStateManager.SaveViewState()

Сохраняет изменения в данных о состоянии представления объекта Parameter после обратной передачи страницы на сервер.Saves the changes to the Parameter object's view state since the time the page was posted back to the server.

(Inherited from Parameter)
IStateManager.TrackViewState() IStateManager.TrackViewState() IStateManager.TrackViewState() 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.

(Inherited from Parameter)

Применяется к

Дополнительно