[WPF]如何正确地用代码设置ListBox的当前选中项

有人可能会说这有什么好写的。不就是一行代码就能搞定的吗？而且为什么需要用代码设置SelectedItem呢？用户所点的Item不就自动是SelectedItem吗？在这里将要讨论我们的，就是ListBox自己没有能自己把SelectedItem设置正确的情况。本来想当作一个WPF Bug清单的一篇文章的，但是又感觉也许就是有这样变态的需求呢。

 

我们用一个非常简单的代码的XAML就可以重现这个问题。

 

 1<Window x:Class="SelectListBoxItem.DemoWindow"
 2    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
 3    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
 4    xmlns:s="clr-namespace:System;assembly=mscorlib"    
 5    Title="ListBox Selection Problem"
 6    SizeToContent="Height"
 7    Width="300">
 8    <ListBox>
 9        <ListBox.ItemTemplate>
            <DataTemplate>
                <TextBox Text="{Binding .}" Width="100"/>
            </DataTemplate>
        </ListBox.ItemTemplate>
        <s:String>a</s:String>
        <s:String>b</s:String>
        <s:String>c</s:String>
    </ListBox>
</Window>

 

运行的效果如下。

图1. TextBox得到焦点

 其实这就是个问题，一个ListBoxItem已经被MouseDown了，可是没有被选中。MouseDown已经被TextBox吃了。结果有可能出现下面的状况。 

图2. 焦点与选中项不一致 

这个问题在WPF里的其它控件也有，在智者千虑的【WPF】如何让TreeView实现右键选中的功能里就描述了TreeView上的相似问题。感觉很恶心。

 

一开始使用的是PreviewMouseDown解决，在MouseDown的时候，通过DataContext也好，通过FindAncestor也好，反正是在获得焦点的同时选择上了。

 

但是随着项目的进行，这种方法造成DataBinding的Validation出现了问题。Validation应该是在LostFocus是对DataContext进行验证；但是使用PreviewMouseDown更改选中项，这个LostFocus就是在别的项被选中之后发现，结果就是用一个无关的数据在新的DataContext上进行验证。

 

这个问题又普遍存在于项目各个DataBinding中，分别修改肯定是不行的。只能是不用PreviewMouseDown。用GotFocus，用它的Item的GotFocus来设置选中项。

 

为了在现有系统中方便应用，使用了AttachedProperty来实现这个功能。代码如下：

 

 1using System.Diagnostics;
 2using System.Windows;
 3using System.Windows.Controls;
 4
 5namespace SelectListBoxItem
 6{
 7    /**//// <summary>
 8    /// 
 9    /// </summary>
    public class ListBoxService
    {
        AutoSelect Property#region AutoSelect Property

        public static readonly DependencyProperty AutoSelectProperty = DependencyProperty.RegisterAttached("AutoSelect", typeof(bool), typeof(ListBoxService), new PropertyMetadata(OnAutoSelectPropertyChanged));

        public static bool GetAutoSelect(DependencyObject element)
        {
            if (element == null)
                return false;

            return (bool)element.GetValue(AutoSelectProperty);
        }

        public static void SetAutoSelect(DependencyObject element, bool value)
        {
            if (element == null)
                return;

            element.SetValue(AutoSelectProperty, value);
        }

        #endregion

        private static void OnAutoSelectPropertyChanged(DependencyObject element, DependencyPropertyChangedEventArgs e)
        {
            if (!(element is UIElement))
                return;

            if ((bool)e.NewValue)
                (element as UIElement).GotFocus += new RoutedEventHandler(OnElementGotFocus);
            else
                (element as UIElement).GotFocus -= new RoutedEventHandler(OnElementGotFocus);
        }

        private static void OnElementGotFocus(object sender, RoutedEventArgs e)
        {
            Debug.Assert(e.OriginalSource is DependencyObject);

            ListBoxItem item = (e.OriginalSource as DependencyObject).FindAncestor<ListBoxItem>();
            if (item != null)
                item.IsSelected = true;
            else
                Debug.WriteLine(string.Format("Cannot find ListBoxItem from {0}", sender));
        }
    }
}

 

其中FindAncestor是自己定义的一个方法，因为单纯地使用VisualTreeHelper是不足以在所有情况下找到Parent的。代码可参见源代码。 

写好了怎么用呢？我们说了，要以对现有代码最小的变动实现这个功能。可能有人已经想到了，用Style，那个Window的代码根本不用动。只要在App.xaml里加上一个Resource就OK了。代码如下，简单吧。 

 1<Application x:Class="SelectListBoxItem.App"
 2    xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
 3    xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
 4    xmlns:l="clr-namespace:SelectListBoxItem"
 5    StartupUri="DemoWindow.xaml">
 6    <Application.Resources>
 7        <Style TargetType="{x:Type ListBox}">
 8            <Setter Property="l:ListBoxService.AutoSelect" Value="True"/>
 9        </Style>
    </Application.Resources>
</Application>

 

到此，ListBox的行为算是正常些了。正常的运行截图就不发了。