以编程方式设置 ListView.SelectedItem 后箭头键不起作用

Question

我有一个 WPF ListView 控件，ItemsSource 设置为以这种方式创建的 ICollectionView：

var collectionView = 
  System.Windows.Data.CollectionViewSource.GetDefaultView(observableCollection);
this.listView1.ItemsSource = collectionView;

...其中 observableCollection 是复杂类型的 ObservableCollection。 ListView 配置为对于每一项仅显示复杂类型的一个字符串属性。

用户可以刷新 ListView，此时我的逻辑存储当前所选项目的“键字符串”，重新填充底层的 observableCollection。然后将之前的排序和过滤应用于collectionView。此时，我想“重新选择”在请求刷新之前选择的项目。 observableCollection 中的项目是新实例，因此我比较各自的字符串属性，然后仅选择匹配的一个。就像这样：

private void SelectThisItem(string value)
{
    foreach (var item in collectionView) // for the ListView in question
    {
        var thing = item as MyComplexType;
        if (thing.StringProperty == value)
        {
            this.listView1.SelectedItem = thing;
            return;
        }
    }
}

这一切都有效。如果选择了第 4 个项目，并且用户按 F5，则重新构建列表，然后选择与前一个第 4 个项目具有相同字符串属性的项目。有时这是新的第四项，有时不是，但它提供了“最少惊讶行为”。

当用户随后使用箭头键在 ListView 中导航时，问题就出现了。刷新后的第一个向上或向下箭头会导致选择（新）列表视图中的第一个项目，无论先前的逻辑选择了哪个项目。任何进一步的箭头键都可以按预期工作。

为什么会发生这种情况？

这显然违反了“最少惊讶”规则。我怎样才能避免它？

---

编辑
经过进一步搜索，这似乎与未答复者描述的异常相同
WPF ListView 箭头导航和击键问题，除非我提供更多详细信息。

Answer 1

看起来这是由于某种ListView（可能还有其他一些 WPF 控件）的已知但未详细描述的问题行为。它要求应用程序在以编程方式设置 SelectedItem 后，对特定 ListViewItem 调用 Focus()。

但 SelectedItem 本身不是 UIElement。它是您在 ListView 中显示的任何内容的项目，通常是自定义类型。因此，您无法调用 this.listView1.SelectedItem.Focus()。那是行不通的。您需要获取显示该特定项目的 UIElement（或 Control）。 WPF 界面中有一个名为 ItemContainerGenerator 的黑暗角落，据说可以让您将获得在 ListView 中显示特定项目的控件。

是这样的：

this.listView1.SelectedItem = thing;
// *** WILL NOT WORK!
((UIElement)this.listView1.ItemContainerGenerator.ContainerFromItem(thing)).Focus();

但是还有第二个问题 - 设置 SelectedItem 后它无法立即工作。 ItemContainerGenerator.ContainerFromItem() 似乎总是返回 null。在 googlespace 的其他地方，人们报告说它返回 null 并设置了 GroupStyle。但它在我身上表现出了这种行为，没有分组。

ItemContainerGenerator.ContainerFromItem() 为列表中显示的所有对象返回 null。此外，ItemContainerGenerator.ContainerFromIndex() 为所有索引返回 null。必要的是仅在 ListView 呈现（或其他内容）后调用这些东西。

我尝试直接通过 Dispatcher.BeginInvoke() 执行此操作，但这也不起作用。

根据其他一些线程的建议，我在 ItemContainerGenerator 上的 StatusChanged 事件中使用了 Dispatcher.BeginInvoke()。是的，很简单吧？ （不是）

代码如下所示。

MyComplexType current;

private void SelectThisItem(string value)
{
    foreach (var item in collectionView) // for the ListView in question
    {
        var thing = item as MyComplexType;
        if (thing.StringProperty == value)
        {
            this.listView1.ItemContainerGenerator.StatusChanged += icg_StatusChanged;
            this.listView1.SelectedItem = thing;
            current = thing;
            return;
        }
    }
}


void icg_StatusChanged(object sender, EventArgs e)
{
    if (this.listView1.ItemContainerGenerator.Status
        == System.Windows.Controls.Primitives.GeneratorStatus.ContainersGenerated)
    {
        this.listView1.ItemContainerGenerator.StatusChanged
            -= icg_StatusChanged;
        Dispatcher.BeginInvoke(System.Windows.Threading.DispatcherPriority.Input,
                               new Action(()=> {
                                       var uielt = (UIElement)this.listView1.ItemContainerGenerator.ContainerFromItem(current);
                                       uielt.Focus();}));

    }
}

这是一些丑陋的代码。但是，以这种方式以编程方式设置 SelectedItem 允许后续箭头导航在 ListView 中工作。

Answer 2

我在使用 ListBox 控件时遇到了这个问题（这就是我最终找到这个问题的原因）。就我而言，SelectedItem 是通过绑定设置的，随后的键盘导航尝试将重置 ListBox 以选择第一个项目。我还通过添加/删除项目（而不是每次绑定到新集合）来同步我的底层 ObservableCollection。

根据接受的答案中给出的信息，我能够使用 ListBox 的以下子类来解决它：

internal class KeyboardNavigableListBox : ListBox
{
    protected override void OnSelectionChanged(SelectionChangedEventArgs e)
    {
        base.OnSelectionChanged(e);

        var container = (UIElement) ItemContainerGenerator.ContainerFromItem(SelectedItem);

        if(container != null)
        {
            container.Focus();
        }
    }
}

希望这可以帮助某人节省一些时间。

Answer 3

我发现了一种有些不同的方法。我使用数据绑定来确保代码中突出显示正确的项目，然后我只需将预事件处理程序添加到后面的代码中以进行键盘导航，而不是在每次重新绑定上设置焦点。像这样。

    public MainWindow()
    {
         ...
         this.ListView.PreviewKeyDown += this.ListView_PreviewKeyDown;
    }

    private void ListView_PreviewKeyDown(object sender, KeyEventArgs e)
    {
        UIElement selectedElement = (UIElement)this.ListView.ItemContainerGenerator.ContainerFromItem(this.ListView.SelectedItem);
        if (selectedElement != null)
        {
            selectedElement.Focus();
        }

        e.Handled = false;
    }

这只是确保在让 WPF 处理按键之前设置正确的焦点

Answer 4

通过指定优先级找到某个项目后，可以使用 BeginInvoke 将其聚焦：

Dispatcher.CurrentDispatcher.BeginInvoke(DispatcherPriority.Loaded, new Action(() =>
{
    var lbi = AssociatedObject.ItemContainerGenerator.ContainerFromIndex(existing) as ListBoxItem;
    lbi.Focus();
}));

Answer 5

以编程方式选择项目不会为其提供键盘焦点。您必须明确地执行此操作... ((Control)listView1.SelectedItem).Focus()

Answer 6

Cheeso，在您的之前的回答中您说过：

但是还有第二个问题 - 它无法正常工作
设置 SelectedItem 后。
ItemContainerGenerator.ContainerFromItem() 似乎总是返回
空。

一个简单的解决方案是根本不设置 SelectedItem。当您聚焦该元素时，这会自动发生。所以只需调用以下行即可：

((UIElement)this.listView1.ItemContainerGenerator.ContainerFromItem(thing)).Focus();

Answer 7

这一切似乎有点侵扰......我自己重写了逻辑：

public class CustomListView : ListView
{
            protected override void OnPreviewKeyDown(KeyEventArgs e)
            {
                // Override the default, sloppy behavior of key up and down events that are broken in WPF's ListView control.
                if (e.Key == Key.Up)
                {
                    e.Handled = true;
                    if (SelectedItems.Count > 0)
                    {
                        int indexToSelect = Items.IndexOf(SelectedItems[0]) - 1;
                        if (indexToSelect >= 0)
                        {
                            SelectedItem = Items[indexToSelect];
                            ScrollIntoView(SelectedItem);
                        }
                    }
                }
                else if (e.Key == Key.Down)
                {
                    e.Handled = true;
                    if (SelectedItems.Count > 0)
                    {
                        int indexToSelect = Items.IndexOf(SelectedItems[SelectedItems.Count - 1]) + 1;
                        if (indexToSelect < Items.Count)
                        {
                            SelectedItem = Items[indexToSelect];
                            ScrollIntoView(SelectedItem);
                        }
                    }
                }
                else
                {
                    base.OnPreviewKeyDown(e);
                }
            }
}

Answer 8

经过一番摆弄后，我无法让它在 MVVM 中工作。
我自己尝试了一下并使用了 DependencyProperty。这对我来说非常有用。

public class ListBoxExtenders : DependencyObject
{
    public static readonly DependencyProperty AutoScrollToCurrentItemProperty = DependencyProperty.RegisterAttached("AutoScrollToCurrentItem", typeof(bool), typeof(ListBoxExtenders), new UIPropertyMetadata(default(bool), OnAutoScrollToCurrentItemChanged));

    public static bool GetAutoScrollToCurrentItem(DependencyObject obj)
    {
        return (bool)obj.GetValue(AutoScrollToSelectedItemProperty);
    }

    public static void SetAutoScrollToCurrentItem(DependencyObject obj, bool value)
    {
        obj.SetValue(AutoScrollToSelectedItemProperty, value);
    }

    public static void OnAutoScrollToCurrentItemChanged(DependencyObject s, DependencyPropertyChangedEventArgs e)
    {
        var listBox = s as ListBox;
        if (listBox != null)
        {
            var listBoxItems = listBox.Items;
            if (listBoxItems != null)
            {
                var newValue = (bool)e.NewValue;

                var autoScrollToCurrentItemWorker = new EventHandler((s1, e2) => OnAutoScrollToCurrentItem(listBox, listBox.Items.CurrentPosition));

                if (newValue)
                    listBoxItems.CurrentChanged += autoScrollToCurrentItemWorker;
                else
                    listBoxItems.CurrentChanged -= autoScrollToCurrentItemWorker;
            }
        }
    }

    public static void OnAutoScrollToCurrentItem(ListBox listBox, int index)
    {
        if (listBox != null && listBox.Items != null && listBox.Items.Count > index && index >= 0)
            listBox.ScrollIntoView(listBox.Items[index]);
    }

}

在 XAML 中的用法

<ListBox IsSynchronizedWithCurrentItem="True" extenders:ListBoxExtenders.AutoScrollToCurrentItem="True" ..../>

Answer 9

Cheeso 的解决方案对我有用。只需设置一个 timer.tick 即可防止出现 null 异常，这样您就可以离开原来的例程。

var uiel = (UIElement)this.lv1.ItemContainerGenerator                        
           .ContainerFromItem(lv1.Items[ix]); 
if (uiel != null) uiel.Focus();

在 RemoveAt/Insert 之后调用计时器以及在 Window.Loaded 设置焦点并选择第一个项目时，问题得到解决。

我想回馈第一篇文章，因为我在 SE 获得了很多灵感和解决方案。快乐编码！