HttpCookieCollection Class
.NET Framework 4.5
Provides a type-safe way to manipulate HTTP cookies.
System.Object
System.Collections.Specialized.NameObjectCollectionBase
System.Web.HttpCookieCollection
System.Collections.Specialized.NameObjectCollectionBase
System.Web.HttpCookieCollection
Namespace: System.Web
Assembly: System.Web (in System.Web.dll)
The HttpCookieCollection type exposes the following members.
| Name | Description | |
|---|---|---|
 | AllKeys | Gets a string array containing all the keys (cookie names) in the cookie collection. |
| Count | Gets the number of key/value pairs contained in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
| Item[Int32] | Gets the cookie with the specified numerical index from the cookie collection. |
| Item[String] | Gets the cookie with the specified name from the cookie collection. |
| Keys | Gets a NameObjectCollectionBase.KeysCollection instance that contains all the keys in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
| Name | Description | |
|---|---|---|
| Add | Adds the specified cookie to the cookie collection. |
| Clear | Clears all cookies from the cookie collection. |
| CopyTo | Copies members of the cookie collection to an Array beginning at the specified index of the array. |
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Get(Int32) | Returns the HttpCookie item with the specified index from the cookie collection. |
| Get(String) | Returns the cookie with the specified name from the cookie collection. |
| GetEnumerator | Returns an enumerator that iterates through the NameObjectCollectionBase. (Inherited from NameObjectCollectionBase.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetKey | Returns the key (name) of the cookie at the specified numerical index. |
| GetObjectData | Implements the ISerializable interface and returns the data needed to serialize the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| OnDeserialization | Implements the ISerializable interface and raises the deserialization event when the deserialization is complete. (Inherited from NameObjectCollectionBase.) |
| Remove | Removes the cookie with the specified name from the collection. |
| Set | Updates the value of an existing cookie in a cookie collection. |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
| Name | Description | |
|---|---|---|
| ICollection.CopyTo | Copies the entire NameObjectCollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from NameObjectCollectionBase.) |
 | ICollection.IsSynchronized | Gets a value indicating whether access to the NameObjectCollectionBase object is synchronized (thread safe). (Inherited from NameObjectCollectionBase.) |
| ICollection.SyncRoot | Gets an object that can be used to synchronize access to the NameObjectCollectionBase object. (Inherited from NameObjectCollectionBase.) |
The following code example demonstrates how to read cookies using the Cookies property of the HttpRequest object and write cookies using the Cookies property of the HttpResponse object. Both properties return HttpCookieCollection objects. If either of two cookies named userName and lastVisit are not in the HTTP request, then they are created in the HTTP response. If the two cookies exist, the properties of the cookies are displayed.
<%@ 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"> protected void Page_Load(object sender, EventArgs e) { StringBuilder sb = new StringBuilder(); // Check to see if cookies exist in HTTP request. if (Request.Cookies["userName"] == null && Request.Cookies["lastVist"] == null) { Response.Cookies["userName"].Value = "user name"; Response.Cookies["userName"].Expires = DateTime.Now.AddMinutes(20d); HttpCookie aCookie = new HttpCookie("lastVisit"); aCookie.Value = DateTime.Now.ToString(); aCookie.Expires = DateTime.Now.AddMinutes(20d); Response.Cookies.Add(aCookie); sb.Append("Two cookies added to response. " + "Refresh the page to read the cookies."); } else { HttpCookieCollection cookies = Request.Cookies; for (int i = 0; i < cookies.Count; i++) { sb.Append("Name: " + cookies[i].Name + "<br/>"); sb.Append("Value: " + cookies[i].Value + "<br/>"); sb.Append("Expires: " + cookies[i].Expires.ToString() + "<br/><br/>"); } } Label1.Text = sb.ToString(); } </script> <html xmlns="http://www.w3.org/1999/xhtml" > <head runat="server"> <title>HttpCookieCollection Example</title> </head> <body> <form id="form1" runat="server"> <div> <asp:Label id="Label1" runat="server"></asp:Label> </div> </form> </body> </html>
Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
