File: UI\WebControls\CookieParameter.cs
Project: ndp\fx\src\xsp\system\Web\System.Web.csproj (System.Web)
//------------------------------------------------------------------------------
// <copyright file="CookieParameter.cs" company="Microsoft">
//     Copyright (c) Microsoft Corporation.  All rights reserved.
// </copyright>                                                                
//------------------------------------------------------------------------------
 
namespace System.Web.UI.WebControls {
 
    using System;
    using System.ComponentModel;
    using System.Data;
 
 
 
    /// <devdoc>
    /// Represents a Parameter that gets its value from the application's request parameters.
    /// </devdoc>
    [
    DefaultProperty("CookieName"),
    ]
    public class CookieParameter : Parameter {
 
        /// <devdoc>
        /// Creates an instance of the CookieParameter class.
        /// </devdoc>
        public CookieParameter() {
        }
 
 
        /// <devdoc>
        /// Creates an instance of the CookieParameter class with the specified parameter name and request field.
        /// </devdoc>
        public CookieParameter(string name, string cookieName) : base(name) {
            CookieName = cookieName;
        }
 
 
        /// <devdoc>
        /// Creates an instance of the CookieParameter class with the specified parameter name, database type, and
        /// request field.
        /// </devdoc>
        public CookieParameter(string name, DbType dbType, string cookieName)
            : base(name, dbType) {
            CookieName = cookieName;
        }
 
 
        /// <devdoc>
        /// Creates an instance of the CookieParameter class with the specified parameter name, type, and request field.
        /// </devdoc>
        public CookieParameter(string name, TypeCode type, string cookieName) : base(name, type) {
            CookieName = cookieName;
        }
 
 
        /// <devdoc>
        /// Used to clone a parameter.
        /// </devdoc>
        protected CookieParameter(CookieParameter original) : base(original) {
            CookieName = original.CookieName;
            ValidateInput = original.ValidateInput;
        }
 
 
 
        /// <devdoc>
        /// The name of the request parameter to get the value from.
        /// </devdoc>
        [
        DefaultValue(""),
        WebCategory("Parameter"),
        WebSysDescription(SR.CookieParameter_CookieName),
        ]
        public string CookieName {
            get {
                object o = ViewState["CookieName"];
                if (o == null)
                    return String.Empty;
                return (string)o;
            }
            set {
                if (CookieName != value) {
                    ViewState["CookieName"] = value;
                    OnParameterChanged();
                }
            }
        }
 
 
        /// <devdoc>
        /// Creates a new CookieParameter that is a copy of this CookieParameter.
        /// </devdoc>
        protected override Parameter Clone() {
            return new CookieParameter(this);
        }
 
 
        /// <devdoc>
        /// Returns the updated value of the parameter.
        /// </devdoc>
        protected internal override object Evaluate(HttpContext context, Control control) {
            if (context == null || context.Request == null) {
                return null;
            }
 
            HttpCookieCollection cookieCollection = ValidateInput ? context.Request.Cookies : context.Request.Unvalidated.Cookies;
            HttpCookie cookie = cookieCollection[CookieName];
            if (cookie == null) {
                return null;
            }
            return cookie.Value;
        }
 
        /// <summary>
        /// Determines whether the parameter's value is being validated or not.
        /// </summary>
        [
        WebCategory("Behavior"),
        WebSysDescription(SR.Parameter_ValidateInput),
        DefaultValue(true)
        ]
        public bool ValidateInput {
            get {
                object o = ViewState["ValidateInput"];
                if (o == null)
                    return true;
                return (bool)o;
            }
            set {
                if (ValidateInput != value) {
                    ViewState["ValidateInput"] = value;
                    OnParameterChanged();
                }
            }
        }
    }
}