Export (0) Print
Expand All
1 out of 1 rated this helpful - Rate this topic

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

The HttpCookieCollection type exposes the following members.

  NameDescription
Public methodHttpCookieCollectionInitializes a new instance of the HttpCookieCollection class.
Top
  NameDescription
Public propertyAllKeysGets a string array containing all the keys (cookie names) in the cookie collection.
Public propertyCountGets the number of key/value pairs contained in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected propertyIsReadOnlyGets or sets a value indicating whether the NameObjectCollectionBase instance is read-only. (Inherited from NameObjectCollectionBase.)
Public propertyItem[Int32]Gets the cookie with the specified numerical index from the cookie collection.
Public propertyItem[String]Gets the cookie with the specified name from the cookie collection.
Public propertyKeysGets a NameObjectCollectionBase.KeysCollection instance that contains all the keys in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Top
  NameDescription
Public methodAddAdds the specified cookie to the cookie collection.
Protected methodBaseAddAdds an entry with the specified key and value into the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseClearRemoves all entries from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseGet(Int32)Gets the value of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseGet(String)Gets the value of the first entry with the specified key from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseGetAllKeysReturns a String array that contains all the keys in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseGetAllValues()Returns an Object array that contains all the values in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseGetAllValues(Type)Returns an array of the specified type that contains all the values in the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseGetKeyGets the key of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseHasKeysGets a value indicating whether the NameObjectCollectionBase instance contains entries whose keys are not null. (Inherited from NameObjectCollectionBase.)
Protected methodBaseRemoveRemoves the entries with the specified key from the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseRemoveAtRemoves the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseSet(Int32, Object)Sets the value of the entry at the specified index of the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Protected methodBaseSet(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.)
Public methodClearClears all cookies from the cookie collection.
Public methodCopyToCopies members of the cookie collection to an Array beginning at the specified index of the array.
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGet(Int32)Returns the HttpCookie item with the specified index from the cookie collection.
Public methodGet(String)Returns the cookie with the specified name from the cookie collection.
Public methodGetEnumeratorReturns an enumerator that iterates through the NameObjectCollectionBase. (Inherited from NameObjectCollectionBase.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetKeyReturns the key (name) of the cookie at the specified numerical index.
Public methodGetObjectDataImplements the ISerializable interface and returns the data needed to serialize the NameObjectCollectionBase instance. (Inherited from NameObjectCollectionBase.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodOnDeserializationImplements the ISerializable interface and raises the deserialization event when the deserialization is complete. (Inherited from NameObjectCollectionBase.)
Public methodRemoveRemoves the cookie with the specified name from the collection.
Public methodSetUpdates the value of an existing cookie in a cookie collection.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top
  NameDescription
Explicit interface implemetationPrivate methodICollection.CopyToCopies the entire NameObjectCollectionBase to a compatible one-dimensional Array, starting at the specified index of the target array. (Inherited from NameObjectCollectionBase.)
Explicit interface implemetationPrivate propertyICollection.IsSynchronizedGets a value indicating whether access to the NameObjectCollectionBase object is synchronized (thread safe). (Inherited from NameObjectCollectionBase.)
Explicit interface implemetationPrivate propertyICollection.SyncRootGets an object that can be used to synchronize access to the NameObjectCollectionBase object. (Inherited from NameObjectCollectionBase.)
Top

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

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.