//------------------------------------------------------------------------------
// <copyright file="DataGridViewElement.cs" company="Microsoft">
//     Copyright (c) Microsoft Corporation.  All rights reserved.
// </copyright>                                                                
//------------------------------------------------------------------------------
 
namespace System.Windows.Forms
{
    using System;
    using System.Drawing;
    using System.Diagnostics;
    using System.ComponentModel;
    using System.Diagnostics.CodeAnalysis;
    
    /// <include file='doc\DataGridViewElement.uex' path='docs/doc[@for="DataGridViewElement"]/*' />
    /// <devdoc>
    ///    <para>Identifies an element in the dataGridView (base class for TCell, TBand, TRow, TColumn.</para>
    /// </devdoc>
    public class DataGridViewElement 
    {
        private DataGridViewElementStates state; // enabled frozen readOnly resizable selected visible
        private DataGridView dataGridView;
 
        /// <include file='doc\DataGridViewElement.uex' path='docs/doc[@for="DataGridViewElement.DataGridViewElement"]/*' />
        /// <devdoc>
        ///    <para>
        ///       Initializes a new instance of the <see cref='System.Windows.Forms.DataGridViewElement'/> class.
        ///    </para>
        /// </devdoc>
        public DataGridViewElement()
        {
            this.state = DataGridViewElementStates.Visible;
        }
 
        internal DataGridViewElement(DataGridViewElement dgveTemplate)
        {
            // Selected and Displayed states are not inherited
            this.state = dgveTemplate.State & (DataGridViewElementStates.Frozen | DataGridViewElementStates.ReadOnly | DataGridViewElementStates.Resizable | DataGridViewElementStates.ResizableSet | DataGridViewElementStates.Visible);
        }
 
        /// <include file='doc\DataGridViewElement.uex' path='docs/doc[@for="DataGridViewElement.State"]/*' />
        [
            Browsable(false),
            EditorBrowsable(EditorBrowsableState.Advanced)
        ]
        public virtual DataGridViewElementStates State
        {
            get
            {
                return this.state;
            }
        }
 
        internal DataGridViewElementStates StateInternal
        {
            set
            {
                this.state = value;
            }
        }
 
        internal bool StateIncludes(DataGridViewElementStates elementState)
        {
            return (this.State & elementState) == elementState;
        }
 
        internal bool StateExcludes(DataGridViewElementStates elementState)
        {
            return (this.State & elementState) == 0;
        }
 
        /// <include file='doc\DataGridViewElement.uex' path='docs/doc[@for="DataGridViewElement.DataGridView"]/*' />
        [
            Browsable(false),
            DesignerSerializationVisibility(DesignerSerializationVisibility.Hidden)
        ]
        public DataGridView DataGridView
        {
            get
            {
                return this.dataGridView;
            }
        }
 
        internal DataGridView DataGridViewInternal
        {
            set
            {
                if (this.DataGridView != value)
                {
                    this.dataGridView = value;
                    OnDataGridViewChanged();
                }
            }
        }
 
        /// <include file='doc\DataGridViewElement.uex' path='docs/doc[@for="DataGridViewElement.OnDataGridViewChanged"]/*' />
        protected virtual void OnDataGridViewChanged()
        {
        }
 
        /// <include file='doc\DataGridViewElement.uex' path='docs/doc[@for="DataGridViewElement.RaiseCellClick"]/*' />
        [SuppressMessage("Microsoft.Design", "CA1030:UseEventsWhereAppropriate")] // Method raises an event for the grid control
        protected void RaiseCellClick(DataGridViewCellEventArgs e)
        {
            if (this.dataGridView != null)
            {
                this.dataGridView.OnCellClickInternal(e);
            }
        }
 
        /// <include file='doc\DataGridViewElement.uex' path='docs/doc[@for="DataGridViewElement.RaiseCellContentClick"]/*' />
        [SuppressMessage("Microsoft.Design", "CA1030:UseEventsWhereAppropriate")] // Method raises an event for the grid control
        protected void RaiseCellContentClick(DataGridViewCellEventArgs e)
        {
            if (this.dataGridView != null)
            {
                this.dataGridView.OnCellContentClickInternal(e);
            }
        }
 
        /// <include file='doc\DataGridViewElement.uex' path='docs/doc[@for="DataGridViewElement.RaiseCellContentDoubleClick"]/*' />
        [SuppressMessage("Microsoft.Design", "CA1030:UseEventsWhereAppropriate")] // Method raises an event for the grid control
        protected void RaiseCellContentDoubleClick(DataGridViewCellEventArgs e)
        {
            if (this.dataGridView != null)
            {
                this.dataGridView.OnCellContentDoubleClickInternal(e);
            }
        }
 
        /// <include file='doc\DataGridViewElement.uex' path='docs/doc[@for="DataGridViewElement.RaiseCellValueChanged"]/*' />
        [SuppressMessage("Microsoft.Design", "CA1030:UseEventsWhereAppropriate")] // Method raises an event for the grid control
        protected void RaiseCellValueChanged(DataGridViewCellEventArgs e)
        {
            if (this.dataGridView != null)
            {
                this.dataGridView.OnCellValueChangedInternal(e);
            }
        }
 
        /// <include file='doc\DataGridViewElement.uex' path='docs/doc[@for="DataGridViewElement.RaiseDataError"]/*' />
        [SuppressMessage("Microsoft.Design", "CA1030:UseEventsWhereAppropriate")] // Method raises an event for the grid control
        protected void RaiseDataError(DataGridViewDataErrorEventArgs e)
        {
            if (this.dataGridView != null)
            {
                this.dataGridView.OnDataErrorInternal(e);
            }
        }
 
        /// <include file='doc\DataGridViewElement.uex' path='docs/doc[@for="DataGridViewElement.RaiseMouseWheel"]/*' />
        [SuppressMessage("Microsoft.Design", "CA1030:UseEventsWhereAppropriate")] // Method raises an event for the grid control
        protected void RaiseMouseWheel(MouseEventArgs e)
        {
            if (this.dataGridView != null)
            {
                this.dataGridView.OnMouseWheelInternal(e);
            }
        }
    }
}