HttpCookieCollection Class

Reference

Definition

Namespace:: System.Web

Assembly:: System.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Provides a type-safe way to manipulate HTTP cookies.

public ref class HttpCookieCollection sealed : System::Collections::Specialized::NameObjectCollectionBase

public sealed class HttpCookieCollection : System.Collections.Specialized.NameObjectCollectionBase

type HttpCookieCollection = class
    inherit NameObjectCollectionBase

Public NotInheritable Class HttpCookieCollection
Inherits NameObjectCollectionBase

Inheritance: Object

NameObjectCollectionBase
HttpCookieCollection

Examples

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>

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

    Protected Sub Page_Load(ByVal sender As Object, ByVal e As System.EventArgs)

        Dim sb As New StringBuilder()
        ' Check to see if cookies exist in HTTP request.
        If (Request.Cookies("userName") Is Nothing AndAlso _
            Request.Cookies("lastVisit") Is Nothing) Then
            Response.Cookies("userName").Value = "user name"
            Response.Cookies("userName").Expires = DateTime.Now.AddMinutes(20D)

            Dim aCookie As 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
            Dim cookies As HttpCookieCollection
            cookies = Request.Cookies
            For i As Integer = 0 To cookies.Count - 1
                sb.Append("Name: " & cookies(i).Name & "<br/>")
                sb.Append("Value: " & cookies(i).Value & "<br/>")
                sb.Append("Expires: " & cookies(i).Expires.ToString() & _
                          "<br/><br/>")
            Next

        End If
        Label1.Text = sb.ToString()
    End Sub
</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>

Constructors

HttpCookieCollection()

Initializes a new instance of the HttpCookieCollection class.

Properties

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)
IsReadOnly	Gets or sets a value indicating whether the NameObjectCollectionBase instance is read-only. (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)

Methods

Add(HttpCookie)	Adds the specified cookie to the cookie collection.
BaseAdd(String, Object)	Adds an entry with the specified key and value into the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseClear()	Removes all entries from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseGet(Int32)	Gets the value of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseGet(String)	Gets the value of the first entry with the specified key from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseGetAllKeys()	Returns a String array that contains all the keys in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseGetAllValues()	Returns an Object array that contains all the values in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseGetAllValues(Type)	Returns an array of the specified type that contains all the values in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseGetKey(Int32)	Gets the key of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseHasKeys()	Gets a value indicating whether the NameObjectCollectionBase instance contains entries whose keys are not `null`. (Inherited from NameObjectCollectionBase)
BaseRemove(String)	Removes the entries with the specified key from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseRemoveAt(Int32)	Removes the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseSet(Int32, Object)	Sets the value of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
BaseSet(String, Object)	Sets the value of the first entry with the specified key in the NameObjectCollectionBase instance, if found; otherwise, adds an entry with the specified key and value into the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase)
Clear()	Clears all cookies from the cookie collection.
CopyTo(Array, Int32)	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 the default hash function. (Inherited from Object)
GetKey(Int32)	Returns the key (name) of the cookie at the specified numerical index.
GetObjectData(SerializationInfo, StreamingContext)	Obsolete. 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)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
OnDeserialization(Object)	Implements the ISerializable interface and raises the deserialization event when the deserialization is complete. (Inherited from NameObjectCollectionBase)
Remove(String)	Removes the cookie with the specified name from the collection.
Set(HttpCookie)	Updates the value of an existing cookie in a cookie collection.
ToString()	Returns a string that represents the current object. (Inherited from Object)

Explicit Interface Implementations

ICollection.CopyTo(Array, Int32)	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)

Extension Methods

Cast<TResult>(IEnumerable)	Casts the elements of an IEnumerable to the specified type.
OfType<TResult>(IEnumerable)	Filters the elements of an IEnumerable based on a specified type.
AsParallel(IEnumerable)	Enables parallelization of a query.
AsQueryable(IEnumerable)	Converts an IEnumerable to an IQueryable.

Applies to