WPF TreeView 虚拟化-设置滚动到选中项

前言

列表滚动到具体的数据项？

ListBox提供了简易快捷的滚动定位函数ScrollIntoView。

TreeView树状结构列表，则没有此类方法，无法与ListBox一样，直接设置滚动到具体的数据项。

同时，SelectedItem也是只读的，无法设置SelectedItem来间接的设置滚动项。

TreeView滚动定位

1. 对TreeViewItem添加一个附加属性IsScrolledToViewWhenSelected，在属性变更事件中，添加对Loaded事件的订阅和注销

     static void OnIsScrolledToViewWhenSelectedChanged(
         DependencyObject depObj, DependencyPropertyChangedEventArgs e)
     {
         if (depObj is TreeViewItem treeViewItem && e.NewValue is bool isIntoViewWhenSelected)
         {
             treeViewItem.Loaded -= TreeViewItem_Loaded;
             if (isIntoViewWhenSelected)
             {
                 treeViewItem.Loaded += TreeViewItem_Loaded;
             }
         }
     }

2. 在Loaded事件中，根据当前TreeViewItem是否选中，调用是否滚动到视图区域的逻辑

     static void TreeViewItem_Loaded(object sender, RoutedEventArgs e)
     {
         var treeViewItem = e.OriginalSource as TreeViewItem;
         if (treeViewItem != null)
         {
             treeViewItem.Loaded -= TreeViewItem_Loaded;
             if (treeViewItem.IsSelected)
             {
                 treeViewItem.BringIntoView();
             }
         }
     }

此处，对TreeView添加附加属性处理，也是可以的

虚拟化后的TreeView滚动定位

因开启了虚拟化，界面上不在当前视觉内的数据项，没有生成相应的视觉树，即无法找到TreeViewItem。

所以虚拟化后，使用TreeViewItem添加附加属性，而不是TreeView。因为TreeView无法对视觉树外的项，查找并定位；而TreeViewItem...emmm~可以使用黑科技处理，详情如下

1. 在上面逻辑的基础上，添加对虚拟化的处理。

此处添加了对虚拟化的判断，虚拟化时如果已经完成了滚动定位，则对后续的逻辑直接跳过，避免选中项的定位被干扰。

     static void OnIsScrolledToViewWhenSelectedChanged(
         DependencyObject depObj, DependencyPropertyChangedEventArgs e)
     {
         if (depObj is TreeViewItem treeViewItem && e.NewValue is bool isIntoViewWhenSelected)
         {
             treeViewItem.Loaded -= TreeViewItem_Loaded;
             //获取父控件TreeView
             var treeView = treeViewItem.FindVisualParent<TreeView>();
             if (isIntoViewWhenSelected)
             {
                 //开启了虚拟化且未完成滚动，直接返回
                 var isOpeningVitualizing = ScrollViewer.GetCanContentScroll(treeView) && VirtualizingPanel.GetIsVirtualizing(treeView);
                 if (isOpeningVitualizing && GetHasSetSelectedItemVisible(treeView))
                 {
                     return;
                 }
                 treeViewItem.Loaded += TreeViewItem_Loaded;
             }
         }
     }

2. 在之前逻辑的基础上，添加虚拟化的判断

如果开启了虚拟化，

• 列表项未选中时，设置滚动到视图中
• 列表项选中时，设置已完成，并滚动到视图中

黑科技：

列表数据加载时，每项都滚动到视图中。

而虚拟化列表实际上初始化的项个数，在默认设置下，比可视化区域的项个数要多很一部分。

所以在单个数据加载时，设置滚动视图，会带动更多原本不在视图内的数据项，生成视觉树。

     static void TreeViewItem_Loaded(object sender, RoutedEventArgs e)
     {
         var treeViewItem = e.OriginalSource as TreeViewItem;
         if (treeViewItem != null)
         {
             treeViewItem.Loaded -= TreeViewItem_Loaded;
             //获取父控件TreeView
             var treeView = treeViewItem.FindVisualParent<TreeView>();
             //是否开启了虚拟化
             var isOpeningVirtualizing = ScrollViewer.GetCanContentScroll(treeView) && VirtualizingPanel.GetIsVirtualizing(treeView);
             if (isOpeningVirtualizing)
             {
                 if (treeViewItem.IsSelected)
                 {
                     //设置已完成滚动，减少剩余项的加载判断
                     SetHasSetSelectedItemVisible(treeView, true);
                     treeViewItem.BringIntoView();
                 }
                 else
                 {
                     treeViewItem.BringIntoView();
                 }
             }
             else if(treeViewItem.IsSelected)
             {
                 treeViewItem.BringIntoView();
             }
         }
     }

WPF 列表开启虚拟化的方式

关键字：TreeView虚拟化、滚动到选中项