HttpCookieCollection Class

 

Provides a type-safe way to manipulate HTTP cookies.

Namespace:   System.Web
Assembly:  System.Web (in System.Web.dll)


public sealed class HttpCookieCollection : NameObjectCollectionBase

NameDescription
System_CAPS_pubmethodHttpCookieCollection()

Initializes a new instance of the HttpCookieCollection class.

NameDescription
System_CAPS_pubpropertyAllKeys

Gets a string array containing all the keys (cookie names) in the cookie collection.

System_CAPS_pubpropertyCount

Gets the number of key/value pairs contained in the NameObjectCollectionBase instance.(Inherited from NameObjectCollectionBase.)

System_CAPS_pubpropertyItem[Int32]

Gets the cookie with the specified numerical index from the cookie collection.

System_CAPS_pubpropertyItem[String]

Gets the cookie with the specified name from the cookie collection.

System_CAPS_pubpropertyKeys

Gets a NameObjectCollectionBase.KeysCollection instance that contains all the keys in the NameObjectCollectionBase instance.(Inherited from NameObjectCollectionBase.)

NameDescription
System_CAPS_pubmethodAdd(HttpCookie)

Adds the specified cookie to the cookie collection.

System_CAPS_pubmethodClear()

Clears all cookies from the cookie collection.

System_CAPS_pubmethodCopyTo(Array, Int32)

Copies members of the cookie collection to an Array beginning at the specified index of the array.

System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGet(Int32)

Returns the HttpCookie item with the specified index from the cookie collection.

System_CAPS_pubmethodGet(String)

Returns the cookie with the specified name from the cookie collection.

System_CAPS_pubmethodGetEnumerator()

Returns an enumerator that iterates through the NameObjectCollectionBase.(Inherited from NameObjectCollectionBase.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetKey(Int32)

Returns the key (name) of the cookie at the specified numerical index.

System_CAPS_pubmethodGetObjectData(SerializationInfo, StreamingContext)

Implements the ISerializable interface and returns the data needed to serialize the NameObjectCollectionBase instance.(Inherited from NameObjectCollectionBase.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodOnDeserialization(Object)

Implements the ISerializable interface and raises the deserialization event when the deserialization is complete.(Inherited from NameObjectCollectionBase.)

System_CAPS_pubmethodRemove(String)

Removes the cookie with the specified name from the collection.

System_CAPS_pubmethodSet(HttpCookie)

Updates the value of an existing cookie in a cookie collection.

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodICollection.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.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.IsSynchronized

Gets a value indicating whether access to the NameObjectCollectionBase object is synchronized (thread safe).(Inherited from NameObjectCollectionBase.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyICollection.SyncRoot

Gets an object that can be used to synchronize access to the NameObjectCollectionBase object.(Inherited from NameObjectCollectionBase.)

NameDescription
System_CAPS_pubmethodAsParallel()

Overloaded. Enables parallelization of a query.(Defined by ParallelEnumerable.)

System_CAPS_pubmethodAsQueryable()

Overloaded. Converts an IEnumerable to an IQueryable.(Defined by Queryable.)

System_CAPS_pubmethodCast<TResult>()

Casts the elements of an IEnumerable to the specified type.(Defined by Enumerable.)

System_CAPS_pubmethodOfType<TResult>()

Filters the elements of an IEnumerable based on a specified type.(Defined by Enumerable.)

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>

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: