xenadmin/XenAdmin/Controls/DataGridViewEnableableComboBoxCell.cs

/* Copyright (c) Citrix Systems, Inc. 
 * All rights reserved. 
 * 
 * Redistribution and use in source and binary forms, 
 * with or without modification, are permitted provided 
 * that the following conditions are met: 
 * 
 * *   Redistributions of source code must retain the above 
 *     copyright notice, this list of conditions and the 
 *     following disclaimer. 
 * *   Redistributions in binary form must reproduce the above 
 *     copyright notice, this list of conditions and the 
 *     following disclaimer in the documentation and/or other 
 *     materials provided with the distribution. 
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND 
 * CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, 
 * INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF 
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
 * DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR 
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
 * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, 
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING 
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 
 * SUCH DAMAGE.
 */

using System;
using System.ComponentModel;
using System.Windows.Forms;

namespace XenAdmin.Controls
{
    /// <summary>
    /// Bespoke ComboBoxCell which allows you to provide IEnableableComboBoxItems to it.
    /// If the item is displayed it will be painted grey and will be non-clickable as it 
    /// is a DataGridViewCell hosting a EnableableComboBox
    /// </summary>
    public class DataGridViewEnableableComboBoxCell : DataGridViewComboBoxCell
    {

        public override string ValueMember
        {
            get { return "IEnableableComboBoxItem"; }
        }

        public override string DisplayMember
        {
            get { return "ToStringProperty"; }
        }

        public override void InitializeEditingControl(int rowIndex, object initialFormattedValue, DataGridViewCellStyle dataGridViewCellStyle)
        {
            base.InitializeEditingControl(rowIndex, initialFormattedValue, dataGridViewCellStyle);

            //Transfer cell value to editing control (EnableableComboBox)
            EnableableComboBoxEditingControl ctl = DataGridView.EditingControl as EnableableComboBoxEditingControl;
            if(ctl != null)
            {
                ctl.SelectedItem = Value ?? DefaultNewRowValue;
            }
        }

        /// <summary>
        /// Type of class that proxies the hosted control
        /// </summary>
        public override Type EditType
        {
            get { return typeof(EnableableComboBoxEditingControl); }
        }

        /// <summary>
        /// Type of object stored by the control behind the selection
        /// </summary>
        public override Type ValueType
        {
            get { return typeof(IEnableableComboBoxItem); }
        }

        public override object DefaultNewRowValue
        {
            get { return null; }
        }

        /// <summary>
        /// Type to display on the UI
        /// </summary>
        public override Type FormattedValueType
        {
            get { return typeof(string); }
        }

        /// <summary>
        /// Parse the data being sent back to the cell from the EnableableComboBox to update the cell
        /// </summary>
        /// <param name="formattedValue"></param>
        /// <param name="cellStyle"></param>
        /// <param name="formattedValueTypeConverter"></param>
        /// <param name="valueTypeConverter"></param>
        /// <returns></returns>
        public override object ParseFormattedValue(object formattedValue, DataGridViewCellStyle cellStyle, 
                                                   TypeConverter formattedValueTypeConverter, TypeConverter valueTypeConverter)
        {
            return formattedValue as IEnableableComboBoxItem;
        }
    }

    /// <summary>
    /// The class providing the proxy for the hosted item in the combobox cell
    /// </summary>
    public class EnableableComboBoxEditingControl : EnableableComboBox, IDataGridViewEditingControl
    {
        private bool valueChanged;

        public object EditingControlFormattedValue
        {
            get { return SelectedItem; }
            set { SelectedItem = value; }
        }

        public object GetEditingControlFormattedValue(DataGridViewDataErrorContexts context)
        {
           return EditingControlFormattedValue;
        }

        public void ApplyCellStyleToEditingControl(DataGridViewCellStyle dataGridViewCellStyle)
        {
            Font = dataGridViewCellStyle.Font;
        }

        public int EditingControlRowIndex { get; set; }

        public bool EditingControlWantsInputKey(Keys key, bool dataGridViewWantsInputKey)
        {
            switch (key & Keys.KeyCode)
            {
                case Keys.Left:
                case Keys.Up:
                case Keys.Down:
                case Keys.Right:
                case Keys.Home:
                case Keys.End:
                case Keys.PageDown:
                case Keys.PageUp:
                    return true;
                default:
                    return !dataGridViewWantsInputKey;
            }
        }

        public void PrepareEditingControlForEdit(bool selectAll){}

        public bool RepositionEditingControlOnValueChange
        {
            get { return false; }
        }

        public DataGridView EditingControlDataGridView { get; set; }

        public bool EditingControlValueChanged
        {
            get { return valueChanged; }
            set { valueChanged = value; }
        }

        public Cursor EditingPanelCursor
        {
            get { return base.Cursor; }
        }

        protected override void OnSelectedValueChanged(EventArgs e)
        {
            valueChanged = true;
            EditingControlDataGridView.NotifyCurrentCellDirty(true);
            base.OnSelectedValueChanged(e);
        }
    }

    /// <summary>
    /// A column to host the bespoke DataGridViewEnableableComboBoxCell in the DataGridView
    /// </summary>
    public class EnableableComboBoxColumn : DataGridViewColumn
    {
        public EnableableComboBoxColumn()
            : base(new DataGridViewEnableableComboBoxCell())
        {
        }

        public override DataGridViewCell CellTemplate
        {
            get
            {
                return base.CellTemplate;
            }
            set
            {
                if (value != null &&
                    !value.GetType().IsAssignableFrom(typeof(DataGridViewEnableableComboBoxCell)))
                {
                    throw new InvalidCastException("Must be a DataGridViewEnableableComboBoxCell");
                }
                base.CellTemplate = value;
            }
        }
    }

}