//------------------------------------------------------------------------------
// <copyright file="DockingAttribute.cs" company="Microsoft">
//     Copyright (c) Microsoft Corporation.  All rights reserved.
// </copyright>                                                                
//------------------------------------------------------------------------------
 
namespace System.Windows.Forms {
 
    /// <include file='doc\DockingAttribute.uex' path='docs/doc[@for="DockingAttribute"]/*' />
    /// <devdoc>
    ///    <para>
    ///       Specifies how a control should be docked by default when added through the designer.
    ///    </para>
    /// </devdoc>
    [AttributeUsage(AttributeTargets.Class)]
    public sealed class DockingAttribute : Attribute {
        private DockingBehavior dockingBehavior;
 
        /// <include file='doc\DockingAttribute.uex' path='docs/doc[@for="DockingAttribute.DockingAttribute"]/*' />
        /// <devdoc>
        ///    <para>
        ///       Default constructor.
        ///    </para>
        /// </devdoc>
        public DockingAttribute() {
            this.dockingBehavior = DockingBehavior.Never;
        }
        
        /// <include file='doc\DockingAttribute.uex' path='docs/doc[@for="DockingAttribute.DockingAttribute1"]/*' />
        /// <devdoc>
        ///    <para>
        ///       Constructor.
        ///    </para>
        /// </devdoc>
        public DockingAttribute(DockingBehavior dockingBehavior) {
            this.dockingBehavior = dockingBehavior;
        }
 
        /// <include file='doc\DockingAttribute.uex' path='docs/doc[@for="DockingAttribute.Default"]/*' />
        /// <devdoc>
        /// <para>
        ///    Specifies the default value for the <see cref='System.ComponentModel.DockingAttribute'/>.
        ///    This <see langword='static '/>field is read-only.
        /// </para>
        /// </devdoc>
        public static readonly DockingAttribute Default = new DockingAttribute();
 
        /// <include file='doc\DockingAttribute.uex' path='docs/doc[@for="DockingAttribute.DockingBehavior"]/*' />
        /// <devdoc>
        ///    <para>
        ///       DockingBehavior property.
        ///    </para>
        /// </devdoc>
        public DockingBehavior DockingBehavior {
            get {
                return dockingBehavior;
            }
        }
 
        /// <include file='doc\DockingAttribute.uex' path='docs/doc[@for="DockingAttribute.Equals"]/*' />
        /// <internalonly/>
        /// <devdoc>
        /// </devdoc>
        public override bool Equals(object obj) {
            if (obj == this) {
                return true;
            }
 
            DockingAttribute other = obj as DockingAttribute;
 
            return (other != null) && other.DockingBehavior == this.dockingBehavior;
        }
 
        /// <include file='doc\DockingAttribute.uex' path='docs/doc[@for="DockingAttribute.GetHashCode"]/*' />
        /// <devdoc>
        ///    <para>[To be supplied.]</para>
        /// </devdoc>
        public override int GetHashCode() {
            return dockingBehavior.GetHashCode();
        }
 
        /// <include file='doc\DockingAttribute.uex' path='docs/doc[@for="DockingAttribute.IsDefaultAttribute"]/*' />
        /// <internalonly/>
        /// <devdoc>
        /// </devdoc>
        public override bool IsDefaultAttribute() {
            return (this.Equals(Default));
        }
    }
}