CookieCollection

Wisej.Base.CookieCollection

Namespace: Wisej.Base

Assembly: Wisej.Framework (2.5.0.0)

Manages the collection of cookies for the current application.

C#

public class CookieCollection : IList<Cookie>, ICollection<Cookie>, IEnumerable<Cookie>, IEnumerable

VB.NET

Public Class CookieCollection
    Inherits IList(Of Cookie)
    Implements ICollection(Of Cookie), IEnumerable(Of Cookie), IEnumerable

Properties

Count

Int32: Returns the number of Cookie items in the collection.

Item(name)

String: Returns the Cookie with a specific name from a CookieCollection.

Throws:

• ArgumentNullException name is null.

Item(index)

Cookie: Returns the Cookie with a specific name from a CookieCollection.

Throws:

• IndexOutOfRangeException index is out of range.

Methods

Add(cookie)

Adds a cookie to the collection.

Parameter	Type	Description
cookie	Cookie	The cookie to add.

Add(name, value)

Adds a new cookie to the collection.

Parameter	Type	Description
name	String	The case-sensitive name of the cookie.
value	String	The value of the new cookie to add.

Returns: Cookie.

Add(name, value, domain)

Adds a new cookie to the collection.

Parameter	Type	Description
name	String	The case-sensitive name of the cookie.
value	String	The value of the new cookie to add.
domain	String	The domain, or partial domain, associated with the cookie.

Returns: Cookie.

Add(name, value, expires)

Adds a new cookie to the collection.

Parameter	Type	Description
name	String	The case-sensitive name of the cookie.
value	String	The value of the new cookie.
expires	DateTime	The expiration date/time of the new cookie.

Returns: Cookie.

Add(name, value, domain, expires)

Adds a new cookie to the collection.

Parameter	Type	Description
name	String	The case-sensitive name of the cookie.
value	String	The value of the new cookie.
domain	String	The value of the new cookie.
expires	DateTime	The expiration date/time of the new cookie.

Returns: Cookie.

Clear()

Delete all cookies from the collection. NOTE: Cookies are only removed from the collection, not from the client. You need to set the expiration date to remove it from the client.

Contains(cookie)

Determines whether the cookie is present in the collection.

Parameter	Type	Description
cookie	Cookie	The cookie to locate.

Returns: Boolean.

CopyTo(array, index)

Copies the cookie collection to a compatible one-dimensional array, starting at the specified index of the target array.

Parameter	Type	Description
array	Cookie[]	The one-dimensional System.Array that is the destination of the elements copied.
index	Int32	The zero-based index in array at which copying begins.

Get(name)

Returns the cookie with the specified name.

Parameter	Type	Description
name	String	The case-sensitive name of the cookie to locate.

Returns: Cookie.

GetEnumerator()

Returns: IEnumerator<Cookie>.

IndexOf(cookie)

Searches for the specified cookie and returns the zero-based index of the first occurrence.

Parameter	Type	Description
cookie	Cookie	The cookie to locate.

Returns: Int32.

IndexOf(name)

Searches for the specified cookie by name and returns the zero-based index of the first occurrence.

Parameter	Type	Description
name	String	The case-sensitive name cookie to locate.

Returns: Int32.

Remove(cookie)

Removes the specified cookie from the collection. NOTE: Cookies are only removed from the collection, not from the client. You need to set the expiration date to remove it from the client.

Parameter	Type	Description
cookie	Cookie	The cookie to remove from the collection.

Returns: Boolean. true if item is successfully removed; otherwise, false.

Remove(name)

Removes the specified cookie from the collection. NOTE: Cookies are only removed from the collection, not from the client. You need to set the expiration date to remove it from the client.

Parameter	Type	Description
name	String	The case-sensitive name of the cookie to remove from the collection.

Returns: Boolean. true if item is successfully removed; otherwise, false.

RemoveAt(index)

Removes the cookie at the specified index. NOTE: Cookies are only removed from the collection, not from the client. You need to set the expiration date to remove it from the client.

Parameter	Type	Description
index	Int32	The zero-based index of the element to remove.