将WPF ListBox滚动到视图模型中的代码中设置的SelectedItem

Question

我有一个带有列表框的XAML视图：

<control:ListBoxScroll ItemSource="{Binding Path=FooCollection}"
                       SelectedItem="{Binding SelectedFoo, Mode=TwoWay}"
                       ScrollSelectedItem="{Binding SelectedFoo}">
    <!-- data templates, etc. -->
</control:ListBoxScroll>

所选项目绑定到我视图中的属性。 当用户在列表框中选择一个项目时，视图模型中的SelectedFoo属性将得到更新。 当我在视图模型中设置SelectedFoo属性时，将在列表框中选择正确的项目。

问题是，如果当前在代码中设置的SelectedFoo不可见，则需要在列表框中另外调用ScrollIntoView 。 由于我的ListBox在视图内，而我的逻辑在视图模型内……我找不到方便的方法。 因此，我扩展了ListBoxScroll：

class ListBoxScroll : ListBox
{
    public static readonly DependencyProperty ScrollSelectedItemProperty = DependencyProperty.Register(
        "ScrollSelectedItem",
        typeof(object),
        typeof(ListBoxScroll),
        new FrameworkPropertyMetadata(
            null,
            FrameworkPropertyMetadataOptions.AffectsRender, 
            new PropertyChangedCallback(onScrollSelectedChanged)));
    public object ScrollSelectedItem
    {
        get { return (object)GetValue(ScrollSelectedItemProperty); }
        set { SetValue(ScrollSelectedItemProperty, value); }
    }

    private static void onScrollSelectedChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        var listbox = d as ListBoxScroll;
        listbox.ScrollIntoView(e.NewValue);
    }
}

它基本上公开了一个新的依赖项属性ScrollSelectedItem ，我将其绑定到视图模型上的SelectedFoo属性。 然后，我将钩接到从属属性的属性更改回调中，并将新选择的项目滚动到视图中。

还有其他人知道一种更简便的方法来调用由视图模型支持的XAML视图上的用户控件上的函数吗？ 可以尝试以下操作：

1. 创建一个依赖属性
2. 向属性更改的回调添加回调
3. 处理静态回调中的函数调用

最好将逻辑放在ScrollSelectedItem { set {方法中，但是依赖项框架似乎可以偷偷摸摸地运行并且无需实际调用即可工作。

Answer 1

您是否尝试过使用行为...这是ScrollInViewBehavior。 我已经将它用于ListView和DataGrid .....我认为它应该适用于ListBox ......

您必须添加对System.Windows.Interactivity的引用才能使用Behavior<T> class

行为

public class ScrollIntoViewForListBox : Behavior<ListBox>
{
    /// <summary>
    ///  When Beahvior is attached
    /// </summary>
    protected override void OnAttached()
    {
        base.OnAttached();
        this.AssociatedObject.SelectionChanged += AssociatedObject_SelectionChanged;
    }

    /// <summary>
    /// On Selection Changed
    /// </summary>
    /// <param name="sender"></param>
    /// <param name="e"></param>
    void AssociatedObject_SelectionChanged(object sender,
                                           SelectionChangedEventArgs e)
    {
        if (sender is ListBox)
        {
            ListBox listBox = (sender as ListBox);
            if (listBox .SelectedItem != null)
            {
                listBox.Dispatcher.BeginInvoke(
                    (Action) (() =>
                                  {
                                      listBox.UpdateLayout();
                                      if (listBox.SelectedItem !=
                                          null)
                                          listBox.ScrollIntoView(
                                              listBox.SelectedItem);
                                  }));
            }
        }
    }
    /// <summary>
    /// When behavior is detached
    /// </summary>
    protected override void OnDetaching()
    {
        base.OnDetaching();
        this.AssociatedObject.SelectionChanged -=
            AssociatedObject_SelectionChanged;

    }
}

用法

将别名作为xmlns:i="clr-namespace:System.Windows.Interactivity;assembly=System.Windows.Interactivity"添加到XAML

然后在您的Control

        <ListBox ItemsSource="{Binding Path=MyList}"
                  SelectedItem="{Binding Path=MyItem,
                                         Mode=TwoWay}"
                  SelectionMode="Single">
            <i:Interaction.Behaviors>
                <Behaviors:ScrollIntoViewForListBox />
            </i:Interaction.Behaviors>
        </ListBox>

现在，如果在ViewModel设置了“ MyItem”属性，则在重新选择更改后将滚动列表。

Answer 2

在查看了答案之后，出现了一个通用主题：外部类，侦听ListBox的SelectionChanged事件。 这让我意识到，依赖财产的方法是过大的，我可以让子类自己听一听：

class ListBoxScroll : ListBox
{
    public ListBoxScroll() : base()
    {
        SelectionChanged += new SelectionChangedEventHandler(ListBoxScroll_SelectionChanged);
    }

    void ListBoxScroll_SelectionChanged(object sender, SelectionChangedEventArgs e)
    {
        ScrollIntoView(SelectedItem);
    }
}

我觉得这是我想要的最简单的解决方案。

值得一提的是adcool2007提出的行为。 以下是一些有兴趣的人的文章：

http://blogs.msdn.com/b/johngossman/archive/2008/05/07/the-attached-behavior-pattern.aspx
http://www.codeproject.com/KB/WPF/AttachedBehaviors.aspx

我认为对于将添加到几个不同用户控件中的常规行为（例如，点击行为，拖动行为，动画行为等），然后附加的行为很有意义。 我不想在这种特殊情况下使用它们的原因是，行为的实现（调用ScrollIntoView ）不是除ListBox之外的任何控件都可以发生的通用操作。

Answer 3

因为严格来说这是一个View问题，所以没有理由为此目的在视图背后的代码中没有事件处理程序。 侦听ListBox.SelectionChanged并使用它来将新选择的项目滚动到视图中。

private void ListBox_SelectionChanged(object sender, SelectionChangedEventArgs e)
{
    ((ListBox)sender).ScrollIntoView(e.AddedItems[0]);
}

您也不需要派生的ListBox来执行此操作。 只需使用一个标准控件，当ListBox.SelectedItem值更改时（如您的原始问题中所述），将执行上述处理程序，并将该项目滚动到视图中。

    <ListBox
        ItemsSource="{Binding Path=FooCollection}"
        SelectedItem="{Binding Path=SelectedFoo}"
        SelectionChanged="ListBox_SelectionChanged"
        />

另一种方法是编写一个附加属性，该属性侦听ICollectionView.CurrentChanged ，然后为新的当前项目调用ListBox.ScrollIntoView 。 如果您需要多个列表框使用此功能，则这是一种“可重用”的方法。 您可以在此处找到一个很好的示例来入门： http : //michlg.wordpress.com/2010/01/16/listbox-automatically-scroll-currentitem-into-view/

Answer 4

我知道这是一个老问题，但是我最近对同一问题的搜索使我想到了这个问题。 我想使用行为方法，但不想仅仅为了给我Behavior<T>而依赖Blend SDK，所以这是我的解决方案：

public static class ListBoxBehavior
{
    public static bool GetScrollSelectedIntoView(ListBox listBox)
    {
        return (bool)listBox.GetValue(ScrollSelectedIntoViewProperty);
    }

    public static void SetScrollSelectedIntoView(ListBox listBox, bool value)
    {
        listBox.SetValue(ScrollSelectedIntoViewProperty, value);
    }

    public static readonly DependencyProperty ScrollSelectedIntoViewProperty =
        DependencyProperty.RegisterAttached("ScrollSelectedIntoView", typeof (bool), typeof (ListBoxBehavior),
                                            new UIPropertyMetadata(false, OnScrollSelectedIntoViewChanged));

    private static void OnScrollSelectedIntoViewChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        var selector = d as Selector;
        if (selector == null) return;

        if (e.NewValue is bool == false)
            return;

        if ((bool) e.NewValue)
        {
            selector.AddHandler(Selector.SelectionChangedEvent, new RoutedEventHandler(ListBoxSelectionChangedHandler));
        }
        else
        {
            selector.RemoveHandler(Selector.SelectionChangedEvent, new RoutedEventHandler(ListBoxSelectionChangedHandler));
        }
    }

    private static void ListBoxSelectionChangedHandler(object sender, RoutedEventArgs e)
    {
        if (!(sender is ListBox)) return;

        var listBox = (sender as ListBox);
        if (listBox.SelectedItem != null)
        {
            listBox.Dispatcher.BeginInvoke(
                (Action)(() =>
                    {
                        listBox.UpdateLayout();
                        if (listBox.SelectedItem !=null)
                            listBox.ScrollIntoView(listBox.SelectedItem);
                    }));
        }
    }
}

然后用法就是

<ListBox ItemsSource="{Binding Path=MyList}"
         SelectedItem="{Binding Path=MyItem, Mode=TwoWay}"
         SelectionMode="Single" 
         behaviors:ListBoxBehavior.ScrollSelectedIntoView="True">

Answer 5

尝试这个：

private void lstBox_SelectionChanged(object sender, SelectionChangedEventArgs e)
{
    lstBox.ScrollIntoView(lstBox.SelectedItem);
}

Answer 6

我正在使用这个（我认为）清晰易用的解决方案

listView.SelectionChanged += (s, e) => 
    listView.ScrollIntoView(listView.SelectedItem);

其中listView是xaml中ListView控件的名称， SelectedItem受我的MVVM影响，并且代码已插入 xaml.cs文件的构造函数中。

Answer 7

捆绑各种方法后，我发现以下是最简单，最好的方法

lstbox.Items.MoveCurrentToLast();
lstbox.ScrollIntoView(lstbox.Items.CurrentItem);

Answer 8

我接受了Ankesh的回答，并使其不依赖于Blend SDK。 我的解决方案的缺点是它将应用于您应用程序中的所有列表框。 但是好处是不需要自定义类。

当您的应用正在初始化时...

    internal static void RegisterFrameworkExtensionEvents()
    {
        EventManager.RegisterClassHandler(typeof(ListBox), ListBox.SelectionChangedEvent, new RoutedEventHandler(ScrollToSelectedItem));
    }

    //avoid "async void" unless used in event handlers (or logical equivalent)
    private static async void ScrollToSelectedItem(object sender, RoutedEventArgs e)
    {
        if (sender is ListBox)
        {
            var lb = sender as ListBox;
            if (lb.SelectedItem != null)
            {
                await lb.Dispatcher.BeginInvoke((Action)delegate
                {
                    lb.UpdateLayout();
                    if (lb.SelectedItem != null)
                        lb.ScrollIntoView(lb.SelectedItem);
                });
            }
        }
    }

这使您所有的列表框滚动到选中状态（我喜欢将其作为默认行为）。