[C1] C1ComboBox 的非编辑状态优化

一、前言

先看看 WPF 自带的 ComboBox 在非编辑状态，自定义 ItemTemplate 的情况下，效果如下图所示：

其当前选中的项（红框内）与自定义的 ItemTemplate 一样；

但是 C1ComboBox 的非编辑状态（IsEditable="False"）：

总感觉它的非编辑状态并没有完成，虽然数字和英文无法输入，但在红框内依旧可以输入中文文本（QQ拼音输入法的中文输入状态）；并且在非编辑状态下并非像 Combobox 的非编辑状态可以显示自定义的 ItemTemplate 效果；这篇文章就介绍如何使用 C1ComboBox 模仿 ComboBox 的非编辑状态效果。

二、解决方案

先分析 C1ComboBox 的控件结构：

其中 ComboHeader 部分是由两个控件来回切换显示的，

internal C1TextBoxBase _elementEditControl;
internal ContentPresenter _elementContentControl;

_elementEditControl 则是编辑状态下显示的控件，_elementContentControl 则是非编辑状态下显示的控件（可显示自定义的 ItemTemplate）；

而这两个控件转换显示的方法如下（C1TextEditableContentControl）：

protected internal void UpdateVisualState()
{
    if (this.EditControl == null || this.ContentControl == null)
    {
        return;
    }
    if (this.IsInEditMode || this.IsDropDownOpen)
    {
        this.EditControl.Opacity = 1.0;
        this.EditControl.IsTabStop = true;
        this.EditControl.IsHitTestVisible = true;
        this.ContentControl.Visibility = Visibility.Collapsed;
        this.ContentControl.Content = null;
    }
    else
    {
        this.EditControl.Opacity = 1.4012984643248171E-45;
        this.EditControl.IsTabStop = false;
        this.EditControl.IsHitTestVisible = false;
        this.ContentControl.Visibility = Visibility.Visible;
        this.ContentControl.Content = this.ActualContent;
    }
    base.Cursor = (this.IsEditable ? Cursors.IBeam : Cursors.Arrow);
}
// 注：EditControl对应_elementEditControl，ContentControl对应_elementContentControl；

即，当 this.IsInEditMode || this.IsDropDownOpen 为 false 时，方可显示自定义的 Itemplate ；

所以，当 ScrollViewer 收缩时（IsDropDownOpen 为 false），设置 ComboHeader 的 IsInEditMode 为 false， 即可保证下拉选择项后，在 ComboHeader 显示自定义的 ItemTemplate；

Loaded += (sender, e) =>
{
    C1TextEditableContentControl editBox = GetChildObjects<C1TextEditableContentControl>(cmb, typeof(C1TextEditableContentControl))[0];
    cmb.IsDropDownOpenChanged += (sender2, e2) =>
    {
        editBox.IsInEditMode = false;
    };
};

public List<T> GetChildObjects<T>(DependencyObject obj, Type typename) where T : FrameworkElement
{
    DependencyObject child = null;
    List<T> childList = new List<T>();

    for (int i = 0; i <= VisualTreeHelper.GetChildrenCount(obj) - 1; i++)
    {
        child = VisualTreeHelper.GetChild(obj, i);

        if (child is T && (((T)child).GetType() == typename))
        {
            childList.Add((T)child);
        }
        childList.AddRange(GetChildObjects<T>(child, typename));
    }
    return childList;
}

但是，当 ComboHeader 获取焦点，仍然会显示 EditControl ，而不是 ContentControl，所以添加如下代码：

editBox.IsEditable = false;
editBox.GotFocus += (sender2, e2) =>
{
    editBox.IsInEditMode = false;
};

需要注意的是，如果不设置 editBox.IsEditable = false; ，点击两次 ComboHeader 还是会进入编辑状态，显示 EditControl 的……

继续但是，当点击 ArrowToggle 按钮展开 ScrollViewer 时，仍旧会显示编辑状态，这个就麻烦了，查看源码可知，该操作时会触发 UpdateSwappedOut 方法以修改 _elementComboHeader 的 ActualContent ，进而触发上面的 UpdateVisualState 方法，而此时 ScrollViewer 的 IsDropDownOpen 属性为 true，导致显示编辑状态，而非自定义的 ItemTemplate；

private void UpdateSwappedOut()
{
    if (this._elementComboHeader == null)
    {
        return;
    }
    this._elementComboHeader.IsDropDownOpen = this.IsDropDownOpen;
    C1ComboBoxItem c1ComboBoxItem = null;
    this._isHeaderUpdate = true;
    this._elementComboHeader.ActualContent = null;
    this._isHeaderUpdate = false;
    this._elementComboHeader.UpdateIsWatermarked();
    this._elementComboHeader.UpdateVisualState();
    if (this.SwappedOutItem != null)
    {
        this.SwappedOutItem.SwappedOut = false;
        this.SwappedOutItem = null;
    }
    if (this.SelectedItem == null)
    {
        return;
    }
    if (this.SelectedIndex != -1)
    {
        c1ComboBoxItem = (C1ComboBoxItem)base.ItemContainerGenerator.ContainerFromIndex(this.SelectedIndex);
        if (c1ComboBoxItem != null && !this.IsDropDownOpen)
        {
            this.SwappedOutItem = c1ComboBoxItem;
            c1ComboBoxItem.SwappedOut = true;
        }
    }
    if (c1ComboBoxItem == null)
    {
        c1ComboBoxItem = (this.SelectedItem as C1ComboBoxItem);
    }
    this._isHeaderUpdate = true;
    if (c1ComboBoxItem == null)
    {
        if (base.ItemStringFormat != null && !this.IsEditable && base.ItemTemplate == null)
        {
            this._elementComboHeader.ActualContent = this.FormattedString(base.ItemStringFormat, this.SelectedItem);
        }
        else
        {
            this._elementComboHeader.ActualContent = this.SelectedItem;
        }
    }
    else if (base.ItemStringFormat != null && !this.IsEditable && base.ItemTemplate == null)
    {
        this._elementComboHeader.ActualContent = this.FormattedString(base.ItemStringFormat, c1ComboBoxItem.Content);
    }
    else
    {
        this._elementComboHeader.ActualContent = c1ComboBoxItem.Content;
    }
    this._isHeaderUpdate = false;
    this._elementComboHeader.IsDirty = false;
}

没辙，没找到如何禁止触发 UpdateSwappedOut 方法，或者触发后如何设置 IsDropDownOpen 为 false，所以就把 EditControl 和 ContentControl 两个控件拿出来，再自己写一个 UpdateVisualState 来更新两个状态的转换；

private void UpdateVisualState()
{
    if (this.EditControl == null || this.ContentControl == null)
    {
        return;
    }
    this.EditControl.Opacity = 1.4012984643248171E-45;
    this.EditControl.IsTabStop = false;
    this.EditControl.IsHitTestVisible = false;
    this.ContentControl.Visibility = Visibility.Visible;
    C1ComboBoxItem cmbi = ((C1ComboBoxItem)cmb.ItemContainerGenerator.ContainerFromIndex(cmb.SelectedIndex));
    this.ContentControl.Content = cmbi.Content;
    base.Cursor = (EditBox.IsEditable ? Cursors.IBeam : Cursors.Arrow);
}

EditControl = GetChildObjects<Control>(cmb, "EditControl")[0];
ContentControl = GetChildObjects<ContentPresenter>(cmb, "ContentControl")[0];
cmb.IsDropDownOpenChanged += (sender2, e2) =>
{
    // EditBox.IsInEditMode = false;
    UpdateVisualState();
};

public List<T> GetChildObjects<T>(DependencyObject obj, string name) where T : FrameworkElement
{
    DependencyObject child = null;
    List<T> childList = new List<T>();

    for (int i = 0; i <= VisualTreeHelper.GetChildrenCount(obj) - 1; i++)
    {
        child = VisualTreeHelper.GetChild(obj, i);

        if (child is T && (((T)child).Name == name | string.IsNullOrEmpty(name)))
        {
            childList.Add((T)child);
        }
        childList.AddRange(GetChildObjects<T>(child, name));
    }
    return childList;
}

一切Over，效果如下：

初始状态：

展开状态：

选择项改变后状态：