TreeView の仮想化でノードを手動で選択して表示する方法はありますか?
TreeView で使用しているデータ モデルは、VM-MV モデルに基づいて実装されています。各 TreeViewItem の IsSelected プロパティは、ViewModel の対応するプロパティにバインドされます。また、選択した TreeViewItem に対して BringIntoView() を呼び出す TreeView の ItemSelected イベントのリスナーも作成しました。
このアプローチの問題は、実際の TreeViewItem が作成されるまで ItemSelected イベントが発生しないことです。そのため、仮想化が有効になっていると、ノードの選択は TreeView が十分にスクロールされるまで何も実行されず、イベントが最終的に発生したときに選択されたノードに「魔法のように」ジャンプします。
ツリーに何千ものノードがあり、仮想化を有効にするとパフォーマンスが大幅に向上することをすでに確認しているため、仮想化を使用したいと思っています。
Estifanos Kidane が提供したリンクは壊れています。彼はおそらく、「仮想化された TreeView で選択を変更する」MSDN サンプルを意味していました。ただし、このサンプルはツリー内のノードを選択する方法を示していますが、MVVM とバインディングではなくコード ビハインドを使用しているため、バインドされた SelectedItem が変更されたときに不足しているSelectedItemChanged イベントも処理しません。
私が考えることができる唯一の解決策は、MVVM パターンを壊すことです。SelectedItem プロパティにバインドされている ViewModel プロパティが変更されたら、View を取得し、新しい値を確認するコード ビハインド メソッド (MSDN サンプルと同様) を呼び出します。ツリーで実際に選択されます。
これを処理するために書いたコードを次に示します。データ項目がプロパティNodeを持つタイプであるとします。Parent
public class Node
{
public Node Parent { get; set; }
}
次の動作クラスを作成しました。
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.Reflection;
using System.Windows;
using System.Windows.Controls;
using System.Windows.Interactivity;
public class NodeTreeSelectionBehavior : Behavior<TreeView>
{
public Node SelectedItem
{
get { return (Node)GetValue(SelectedItemProperty); }
set { SetValue(SelectedItemProperty, value); }
}
public static readonly DependencyProperty SelectedItemProperty =
DependencyProperty.Register("SelectedItem", typeof(Node), typeof(NodeTreeSelectionBehavior),
new FrameworkPropertyMetadata(null, FrameworkPropertyMetadataOptions.BindsTwoWayByDefault, OnSelectedItemChanged));
private static void OnSelectedItemChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
var newNode = e.NewValue as Node;
if (newNode == null) return;
var behavior = (NodeTreeSelectionBehavior)d;
var tree = behavior.AssociatedObject;
var nodeDynasty = new List<Node> { newNode };
var parent = newNode.Parent;
while (parent != null)
{
nodeDynasty.Insert(0, parent);
parent = parent.Parent;
}
var currentParent = tree as ItemsControl;
foreach (var node in nodeDynasty)
{
// first try the easy way
var newParent = currentParent.ItemContainerGenerator.ContainerFromItem(node) as TreeViewItem;
if (newParent == null)
{
// if this failed, it's probably because of virtualization, and we will have to do it the hard way.
// this code is influenced by TreeViewItem.ExpandRecursive decompiled code, and the MSDN sample at http://code.msdn.microsoft.com/Changing-selection-in-a-6a6242c8/sourcecode?fileId=18862&pathId=753647475
// see also the question at http://stackoverflow.com/q/183636/46635
currentParent.ApplyTemplate();
var itemsPresenter = (ItemsPresenter)currentParent.Template.FindName("ItemsHost", currentParent);
if (itemsPresenter != null)
{
itemsPresenter.ApplyTemplate();
}
else
{
currentParent.UpdateLayout();
}
var virtualizingPanel = GetItemsHost(currentParent) as VirtualizingPanel;
CallEnsureGenerator(virtualizingPanel);
var index = currentParent.Items.IndexOf(node);
if (index < 0)
{
throw new InvalidOperationException("Node '" + node + "' cannot be fount in container");
}
CallBringIndexIntoView(virtualizingPanel, index);
newParent = currentParent.ItemContainerGenerator.ContainerFromIndex(index) as TreeViewItem;
}
if (newParent == null)
{
throw new InvalidOperationException("Tree view item cannot be found or created for node '" + node + "'");
}
if (node == newNode)
{
newParent.IsSelected = true;
newParent.BringIntoView();
break;
}
newParent.IsExpanded = true;
currentParent = newParent;
}
}
protected override void OnAttached()
{
base.OnAttached();
AssociatedObject.SelectedItemChanged += OnTreeViewSelectedItemChanged;
}
protected override void OnDetaching()
{
base.OnDetaching();
AssociatedObject.SelectedItemChanged -= OnTreeViewSelectedItemChanged;
}
private void OnTreeViewSelectedItemChanged(object sender, RoutedPropertyChangedEventArgs<object> e)
{
SelectedItem = e.NewValue as Node;
}
#region Functions to get internal members using reflection
// Some functionality we need is hidden in internal members, so we use reflection to get them
#region ItemsControl.ItemsHost
static readonly PropertyInfo ItemsHostPropertyInfo = typeof(ItemsControl).GetProperty("ItemsHost", BindingFlags.Instance | BindingFlags.NonPublic);
private static Panel GetItemsHost(ItemsControl itemsControl)
{
Debug.Assert(itemsControl != null);
return ItemsHostPropertyInfo.GetValue(itemsControl, null) as Panel;
}
#endregion ItemsControl.ItemsHost
#region Panel.EnsureGenerator
private static readonly MethodInfo EnsureGeneratorMethodInfo = typeof(Panel).GetMethod("EnsureGenerator", BindingFlags.Instance | BindingFlags.NonPublic);
private static void CallEnsureGenerator(Panel panel)
{
Debug.Assert(panel != null);
EnsureGeneratorMethodInfo.Invoke(panel, null);
}
#endregion Panel.EnsureGenerator
#region VirtualizingPanel.BringIndexIntoView
private static readonly MethodInfo BringIndexIntoViewMethodInfo = typeof(VirtualizingPanel).GetMethod("BringIndexIntoView", BindingFlags.Instance | BindingFlags.NonPublic);
private static void CallBringIndexIntoView(VirtualizingPanel virtualizingPanel, int index)
{
Debug.Assert(virtualizingPanel != null);
BringIndexIntoViewMethodInfo.Invoke(virtualizingPanel, new object[] { index });
}
#endregion VirtualizingPanel.BringIndexIntoView
#endregion Functions to get internal members using reflection
}
このクラスを使用すると、次のように XAML を記述できます。
<UserControl xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
xmlns:i="clr-namespace:System.Windows.Interactivity;assembly=System.Windows.Interactivity"
xmlns:local="clr-namespace:MyProject">
<Grid>
<TreeView ItemsSource="{Binding MyItems}"
ScrollViewer.CanContentScroll="True"
VirtualizingStackPanel.IsVirtualizing="True"
VirtualizingStackPanel.VirtualizationMode="Recycling">
<i:Interaction.Behaviors>
<local:NodeTreeSelectionBehavior SelectedItem="{Binding MySelectedItem}" />
</i:Interaction.Behaviors>
</TreeView>
<Grid>
<UserControl>
TreeView、TreeViewItemおよびのカスタム コントロールを作成することで、この問題を解決しましたVirtualizingStackPanel。ソリューションの一部はhttp://code.msdn.microsoft.com/Changing-selection-in-a-6a6242c8からのものです。
各 TreeItem (バインドされたアイテム) は、その親を知る必要があります (によって強制されITreeItemます)。
public interface ITreeItem {
ITreeItem Parent { get; }
IList<ITreeItem> Children { get; }
bool IsSelected { get; set; }
bool IsExpanded { get; set; }
}
がIsSelected任意の TreeItem に設定されると、ビュー モデルに通知され、イベントが発生します。ビュー内の対応するイベント リスナーが を呼び出しBringItemIntoViewますTreeView。
は、選択したアイテムへのパス上のTreeViewすべてを検索TreeViewItemsし、それらをビューに表示します。
残りのコードは次のとおりです。
public class SelectableVirtualizingTreeView : TreeView {
public SelectableVirtualizingTreeView() {
VirtualizingStackPanel.SetIsVirtualizing(this, true);
VirtualizingStackPanel.SetVirtualizationMode(this, VirtualizationMode.Recycling);
var panelfactory = new FrameworkElementFactory(typeof(SelectableVirtualizingStackPanel));
panelfactory.SetValue(Panel.IsItemsHostProperty, true);
var template = new ItemsPanelTemplate { VisualTree = panelfactory };
ItemsPanel = template;
}
public void BringItemIntoView(ITreeItem treeItemViewModel) {
if (treeItemViewModel == null) {
return;
}
var stack = new Stack<ITreeItem>();
stack.Push(treeItemViewModel);
while (treeItemViewModel.Parent != null) {
stack.Push(treeItemViewModel.Parent);
treeItemViewModel = treeItemViewModel.Parent;
}
ItemsControl containerControl = this;
while (stack.Count > 0) {
var viewModel = stack.Pop();
var treeViewItem = containerControl.ItemContainerGenerator.ContainerFromItem(viewModel);
var virtualizingPanel = FindVisualChild<SelectableVirtualizingStackPanel>(containerControl);
if (virtualizingPanel != null) {
var index = viewModel.Parent != null ? viewModel.Parent.Children.IndexOf(viewModel) : Items.IndexOf(treeViewItem);
virtualizingPanel.BringIntoView(index);
Focus();
}
containerControl = (ItemsControl)treeViewItem;
}
}
protected override DependencyObject GetContainerForItemOverride() {
return new SelectableVirtualizingTreeViewItem();
}
protected override void PrepareContainerForItemOverride(DependencyObject element, object item) {
base.PrepareContainerForItemOverride(element, item);
((TreeViewItem)element).IsExpanded = true;
}
private static T FindVisualChild<T>(Visual visual) where T : Visual {
for (var i = 0; i < VisualTreeHelper.GetChildrenCount(visual); i++) {
var child = (Visual)VisualTreeHelper.GetChild(visual, i);
if (child == null) {
continue;
}
var correctlyTyped = child as T;
if (correctlyTyped != null) {
return correctlyTyped;
}
var descendent = FindVisualChild<T>(child);
if (descendent != null) {
return descendent;
}
}
return null;
}
}
public class SelectableVirtualizingTreeViewItem : TreeViewItem {
public SelectableVirtualizingTreeViewItem() {
var panelfactory = new FrameworkElementFactory(typeof(SelectableVirtualizingStackPanel));
panelfactory.SetValue(Panel.IsItemsHostProperty, true);
var template = new ItemsPanelTemplate { VisualTree = panelfactory };
ItemsPanel = template;
SetBinding(IsSelectedProperty, new Binding("IsSelected"));
SetBinding(IsExpandedProperty, new Binding("IsExpanded"));
}
protected override DependencyObject GetContainerForItemOverride() {
return new SelectableVirtualizingTreeViewItem();
}
protected override void PrepareContainerForItemOverride(DependencyObject element, object item) {
base.PrepareContainerForItemOverride(element, item);
((TreeViewItem)element).IsExpanded = true;
}
}
public class SelectableVirtualizingStackPanel : VirtualizingStackPanel {
public void BringIntoView(int index) {
if (index < 0) {
return;
}
BringIndexIntoView(index);
}
}
public abstract class TreeItemBase : ITreeItem {
protected TreeItemBase() {
Children = new ObservableCollection<ITreeItem>();
}
public ITreeItem Parent { get; protected set; }
public IList<ITreeItem> Children { get; protected set; }
public abstract bool IsSelected { get; set; }
public abstract bool IsExpanded { get; set; }
public event EventHandler DescendantSelected;
protected void RaiseDescendantSelected(TreeItemViewModel newItem) {
if (Parent != null) {
((TreeItemViewModel)Parent).RaiseDescendantSelected(newItem);
} else {
var handler = DescendantSelected;
if (handler != null) {
handler.Invoke(newItem, EventArgs.Empty);
}
}
}
}
public class MainViewModel : INotifyPropertyChanged {
private TreeItemViewModel _selectedItem;
public MainViewModel() {
TreeItemViewModels = new List<TreeItemViewModel> { new TreeItemViewModel { Name = "Item" } };
for (var i = 0; i < 30; i++) {
TreeItemViewModels[0].AddChildInitial();
}
TreeItemViewModels[0].IsSelected = true;
TreeItemViewModels[0].DescendantSelected += OnDescendantSelected;
}
public event EventHandler DescendantSelected;
public event PropertyChangedEventHandler PropertyChanged;
public List<TreeItemViewModel> TreeItemViewModels { get; private set; }
public TreeItemViewModel SelectedItem {
get {
return _selectedItem;
}
set {
if (_selectedItem == value) {
return;
}
_selectedItem = value;
var handler = PropertyChanged;
if (handler != null) {
handler.Invoke(this, new PropertyChangedEventArgs("SelectedItem"));
}
}
}
private void OnDescendantSelected(object sender, EventArgs eventArgs) {
var handler = DescendantSelected;
if (handler != null) {
handler.Invoke(sender, eventArgs);
}
}
}
public partial class MainWindow {
public MainWindow() {
InitializeComponent();
var mainViewModel = (MainViewModel)DataContext;
mainViewModel.DescendantSelected += OnMainViewModelDescendantSelected;
}
private void OnAddButtonClick(object sender, RoutedEventArgs e) {
var mainViewModel = (MainViewModel)DataContext;
var treeItemViewModel = mainViewModel.SelectedItem;
if (treeItemViewModel != null) {
treeItemViewModel.AddChild();
}
}
private void OnMainViewModelDescendantSelected(object sender, EventArgs eventArgs) {
_treeView.BringItemIntoView(sender as TreeItemViewModel);
}
private void OnTreeViewSelectedItemChanged(object sender, RoutedPropertyChangedEventArgs<object> e) {
if (e.OldValue == e.NewValue) {
return;
}
var treeView = (TreeView)sender;
var treeItemviewModel = treeView.SelectedItem as TreeItemViewModel;
var mainViewModel = (MainViewModel)DataContext;
mainViewModel.SelectedItem = treeItemviewModel;
}
}
XAML では次のようになります。
<controls:SelectableVirtualizingTreeView x:Name="_treeView" ItemsSource="{Binding TreeItemViewModels}" Margin="8"
SelectedItemChanged="OnTreeViewSelectedItemChanged">
<controls:SelectableVirtualizingTreeView.ItemTemplate>
<HierarchicalDataTemplate ... />
</controls:SelectableVirtualizingTreeView.ItemTemplate>
</controls:SelectableVirtualizingTreeView>
この問題を解決するために、添付プロパティを使用しました。
public class TreeViewItemBehaviour
{
#region IsBroughtIntoViewWhenSelected
public static bool GetIsBroughtIntoViewWhenSelected(TreeViewItem treeViewItem)
{
return (bool)treeViewItem.GetValue(IsBroughtIntoViewWhenSelectedProperty);
}
public static void SetIsBroughtIntoViewWhenSelected(
TreeViewItem treeViewItem, bool value)
{
treeViewItem.SetValue(IsBroughtIntoViewWhenSelectedProperty, value);
}
public static readonly DependencyProperty IsBroughtIntoViewWhenSelectedProperty =
DependencyProperty.RegisterAttached(
"IsBroughtIntoViewWhenSelected",
typeof(bool),
typeof(TreeViewItemBehaviour),
new UIPropertyMetadata(false, OnIsBroughtIntoViewWhenSelectedChanged));
static void OnIsBroughtIntoViewWhenSelectedChanged(
DependencyObject depObj, DependencyPropertyChangedEventArgs e)
{
TreeViewItem item = depObj as TreeViewItem;
if (item == null)
return;
if (e.NewValue is bool == false)
return;
if ((bool)e.NewValue)
{
item.Loaded += item_Loaded;
}
else
{
item.Loaded -= item_Loaded;
}
}
static void item_Loaded(object sender, RoutedEventArgs e)
{
TreeViewItem item = e.OriginalSource as TreeViewItem;
if (item != null)
item.BringIntoView();
}
#endregion // IsBroughtIntoViewWhenSelected
}
そして、TreeViewItemのXAMLスタイルでは、プロパティをtrueに設定するだけです。
<Setter Property="Behaviours:TreeViewItemBehaviour.IsBroughtIntoViewWhenSelected" Value="True" />
HTH
MSDN Question public void ScrollToItem(int index)からの例を次に示します。
{
Dispatcher.BeginInvoke(System.Windows.Threading.DispatcherPriority.Background,
(System.Windows.Threading.DispatcherOperationCallback)delegate(object arg)
{
int N = fileList.Items.Count;
if (N == 0)
return null;
if (index < 0)
{
fileList.ScrollIntoView(fileList.Items[0]); // scroll to first
}
else
{
if (index < N)
{
fileList.ScrollIntoView(fileList.Items[index]); // scroll to item
}
else
{
fileList.ScrollIntoView(fileList.Items[N - 1]); // scroll to last
}
}
return null;
}, null);
}