从 C# 访问 ListBox 的 ScrollViewer

Question

我想从 C# 更改 ScrollViewer 和 ListBox 的属性。

我在 Stackoverflow 上找到了 this question。我接受了已接受答案的建议，并将 ScrollViewer 暴露为子类的属性。但是，这在下面显示的示例中似乎不起作用。该问题中的一些 cmets 还表示该技术无效。

XAML：

<Window x:Class="StackoverflowListBoxScrollViewer.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        Title="MainWindow" Height="350" Width="525">

</Window>

C#：

using System;
using System.Windows;
using System.Windows.Controls;

namespace StackoverflowListBoxScrollViewer
{
    public class MyListBox : ListBox
    {
        public ScrollViewer ScrollViewer
        { get { return (ScrollViewer)GetTemplateChild("ScrollViewer"); } }
    }

    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();

            var myListBox = new MyListBox();

            Content = myListBox;

            myListBox.Items.Add(new Button() { Content = "abc" });
            myListBox.Items.Add(new Button() { Content = "abc" });
            myListBox.Items.Add(new Button() { Content = "abc" });
            myListBox.Items.Add(new Button() { Content = "abc" });
            myListBox.Items.Add(new Button() { Content = "abc" });

            var button = new Button() { Content = "Check ScrollViewer" };
            button.Click += (s, e) =>
                {
                    if (myListBox.ScrollViewer == null)
                        Console.WriteLine("null");
                };
            myListBox.Items.Add(button);
        }
    }
}

当我单击“检查 ScrollViewer”按钮时，它会打印“null”。即，ScrollViewer 未被检索到。

我怎么去那个该死的ScrollViewer？ :-)

Answer 1

你可以试试这个小助手功能

用法

var scrollViewer = GetDescendantByType(yourListBox, typeof(ScrollViewer)) as ScrollViewer;

辅助函数

public static Visual GetDescendantByType(Visual element, Type type)
{
  if (element == null) {
    return null;
  }
  if (element.GetType() == type) {
    return element;
  }
  Visual foundElement = null;
  if (element is FrameworkElement) {
    (element as FrameworkElement).ApplyTemplate();
  }
  for (int i = 0; i < VisualTreeHelper.GetChildrenCount(element); i++) {
    Visual visual = VisualTreeHelper.GetChild(element, i) as Visual;
    foundElement = GetDescendantByType(visual, type);
    if (foundElement != null) {
      break;
    }
  }
  return foundElement;
}

希望对你有帮助

Answer 2

如果您将使用标准 ListBox，那么您可以将您的 getter 更改为这个：

public class MyListBox : ListBox
{
    public ScrollViewer ScrollViewer
    {
        get 
        {
            Border border = (Border)VisualTreeHelper.GetChild(this, 0);

            return (ScrollViewer)VisualTreeHelper.GetChild(border, 0);
        }
    }
}

Answer 3

我已经修改了@punker76 的最佳答案，为 Visual 创建了一个扩展方法并提供了明确的返回类型：

   public static class Extensions
   {
      public static T GetDescendantByType<T>(this Visual element) where T:class
      {
         if (element == null)
         {
            return default(T);
         }
         if (element.GetType() == typeof(T))
         {
            return element as T;
         }
         T foundElement = null;
         if (element is FrameworkElement)
         {
            (element as FrameworkElement).ApplyTemplate();
         }
         for (var i = 0; i < VisualTreeHelper.GetChildrenCount(element); i++)
         {
            var visual = VisualTreeHelper.GetChild(element, i) as Visual;
            foundElement = visual.GetDescendantByType<T>();
            if (foundElement != null)
            {
               break;
            }
         }
         return foundElement;
      }

   }

您现在可以通过 SomeVisual.GetDescendantByType 调用它，它返回已经是正确类型的 ScrollViewer 或 null（默认 (T)）

Answer 4

对我来说，将 ScrollViewer 作为属性公开是个坏主意。首先，不能保证 ScrollViewer 存在于模板中。其次，ScrollViewer 与 ItemsPanel 和 ItemContainerGenerator 同步工作。覆盖这是不常见行为的直接方法。

WPF 控件使用另一种模式。它们的类就像外部逻辑用法和内部视觉表示之间的中介。您的 ListBox 应该公开 ScrollViewer 可以在模板中使用的属性，但不能公开 ScrollViewer。这样一来，您就破坏了 WPF 标准，将您的控件限制在特定模板上，并允许用户代码破解内部 ListBox 实现。

Answer 5

ScrollViewer 的属性“附加”到 ListBox（参见https://docs.microsoft.com/en-us/dotnet/framework/wpf/advanced/attached-properties-overview）。您可以通过函数获取或设置它作为依赖属性：

public object GetValue (System.Windows.DependencyProperty dp);

和

public void SetValue (System.Windows.DependencyProperty dp, object value);

例如，对于列表框'lb'，你可以这样写：

lb.GetValue(ScrollViewer.ActualHeightProperty); 或者 lb.SetValue(ScrollViewer.HorizontalScrollBarVisibilityProperty, ScrollBarVisibility.Visible);

Answer 6

这是@punker76 对 C# 6 的回答的另一个经过修改的通用版本：

public static class VisualExtensions
{
    public static T FindVisualDescendant<T>(this Visual element) where T : Visual
    {
        if (element == null)
            return null;

        var e = element as T;

        if (e != null)
            return e;

        (element as FrameworkElement)?.ApplyTemplate();

        var childrenCount = VisualTreeHelper.GetChildrenCount(element);

        for (var i = 0; i < childrenCount; i++)
        {
            var visual = VisualTreeHelper.GetChild(element, i) as Visual;

            var foundElement = visual.FindVisualDescendant<T>();

            if (foundElement != null)
                return foundElement;
        }

        return null;
    }
}