Posted By

mecha on 10/28/10

Tagged

aspnet
c#

Versions (?)

Last Edited at 10/28/10 08:52am

Statistics

Viewed 831 times

Favorited by 1 user(s)

Related snippets

Server-side Cookie Helper Methods

/ Published in: C#

You should include these Cookie helpers in your base page class. Enjoy!

Highlighted TextExpand

#region - Cookies -

/// <summary>
        /// Reads the cookie.
        /// </summary>
        /// <param name="cookieName">Name of the cookie.</param>
        /// <returns></returns>
        public string ReadCookie(string cookieName)
        {
            HttpCookie httpCookie = Request.Cookies[cookieName];
            return httpCookie != null ? Server.HtmlEncode(httpCookie.Value).Trim() : string.Empty;
        }

/// <summary>
        /// Writes a cookie and auto sets the expire date to as current day plus one.
        /// </summary>
        /// <param name="cookieName">Name of the cookie.</param>
        /// <param name="cookieValue">The cookie value.</param>
        /// <param name="isHttpCookie">if set to <c>true</c> [is HTTP cookie].</param>
        public void WriteCookie(string cookieName, string cookieValue, bool isHttpCookie)
        {
            var aCookie = new HttpCookie(cookieName)
                              {Value = cookieValue, Expires = DateTime.Now.AddDays(1), HttpOnly = isHttpCookie};
            Response.Cookies.Add(aCookie);
        }

/// <summary>
        /// Writes a cookie.
        /// </summary>
        /// <param name="cookieName">Name of the cookie.</param>
        /// <param name="cookieValue">The cookie value.</param>
        /// <param name="isHttpCookie">if set to <c>true</c> [is HTTP cookie].</param>
        /// <param name="cookieExpireDate">The cookie expire date.</param>
        public void WriteCookie(string cookieName, string cookieValue, bool isHttpCookie, DateTime cookieExpireDate)
        {
            var aCookie = new HttpCookie(cookieName)
                              {Value = cookieValue, Expires = cookieExpireDate, HttpOnly = isHttpCookie};
            Response.Cookies.Add(aCookie);
        }

/// <summary>
        /// Deletes a single cookie.
        /// </summary>
        /// <param name="cookieName">Name of the cookie.</param>
        public void DeleteCookie(string cookieName)
        {
            var aCookie = new HttpCookie(cookieName) {Expires = DateTime.Now.AddDays(-1)};
            Response.Cookies.Add(aCookie);
        }

/// <summary>
        /// Deletes all the cookies available to the application.
        /// </summary>
        /// <remarks>The technique creates a new cookie with the same name as the cookie to be deleted, but to set the cookie's expiration to a date earlier than today.</remarks>
        public void DeleteAllCookies()
        {
            for (int i = 0; i <= Request.Cookies.Count - 1; i++)
            {
                Response.Cookies.Add(new HttpCookie(Request.Cookies[i].Name)
                                         {Expires = DateTime.Now.AddDays(-1)});
            }
        }

#endregion

Report this snippet Tweet

Comments

Subscribe to comments

Comment:

You need to login to post a comment.