如何创建一个附加行为以实现FlowDocumentScrollViewer的自动滚动

Question

我的目标是创建一个可重用的Attached Behavior，用于FlowDocumentScrollViewer，以便每当FlowDocument被更新（追加）时，视图自动滚动到末尾。

至今遇到的问题：

• 在可用状态改变之前调用OnEnabledChanged，因此找不到ScrollViewer
• 我不知道如何附加到包含FlowDocument的DependencyProperty。我的计划是使用它的changed事件初始化ManagedRange属性。(如果需要，手动触发第一次)
• 我不知道如何从range_Changed方法中访问ScrollViewer属性，因为它没有DependencyObject。

我意识到这些可能是三个单独的问题（也就是问题）。然而，它们彼此依存，并且取决于我对此行为所尝试的整体设计。如果是的话，什么是正确的方式？

/// Attached Dependency Properties not shown here:
///   bool Enabled
///   DependencyProperty DocumentProperty
///   TextRange MonitoredRange
///   ScrollViewer ScrollViewer

public static void OnEnabledChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
    if (d == null || System.ComponentModel.DesignerProperties.GetIsInDesignMode(d))
        return;

    DependencyProperty documentProperty = null;
    ScrollViewer scrollViewer = null;

    if (e.NewValue is bool && (bool)e.NewValue)
    {
        // Using reflection so that this will work with similar types.
        FieldInfo documentFieldInfo = d.GetType().GetFields().FirstOrDefault((m) => m.Name == "DocumentProperty");
        documentProperty = documentFieldInfo.GetValue(d) as DependencyProperty;

        // doesn't work.  the visual tree hasn't been built yet
        scrollViewer = FindScrollViewer(d);
    }

    if (documentProperty != d.GetValue(DocumentPropertyProperty) as DependencyProperty)
        d.SetValue(DocumentPropertyProperty, documentProperty);

    if (scrollViewer != d.GetValue(ScrollViewerProperty) as ScrollViewer)
        d.SetValue(ScrollViewerProperty, scrollViewer);
}

private static ScrollViewer FindScrollViewer(DependencyObject obj)
{
    do
    {
        if (VisualTreeHelper.GetChildrenCount(obj) > 0)
            obj = VisualTreeHelper.GetChild(obj as Visual, 0);
        else
            return null;
    }
    while (!(obj is ScrollViewer));

    return obj as ScrollViewer;
}

public static void OnDocumentPropertyPropertyChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
    if (e.OldValue != null)
    {
        DependencyProperty dp = e.OldValue as DependencyProperty;
        // -= OnFlowDocumentChanged
    }

    if (e.NewValue != null)
    {
        DependencyProperty dp = e.NewValue as DependencyProperty;
        // += OnFlowDocumentChanged

        // dp.AddOwner(typeof(AutoScrollBehavior), new PropertyMetadata(OnFlowDocumentChanged));
        //   System.ArgumentException was unhandled by user code Message='AutoScrollBehavior' 
        //   type must derive from DependencyObject.
    }
}

public static void OnFlowDocumentChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
    TextRange range = null;

    if (e.NewValue != null)
    {
        FlowDocument doc = e.NewValue as FlowDocument;

        if (doc != null)
            range = new TextRange(doc.ContentStart, doc.ContentEnd);
    }

    if (range != d.GetValue(MonitoredRangeProperty) as TextRange)
        d.SetValue(MonitoredRangeProperty, range);
}


public static void OnMonitoredRangeChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
{
    if (e.OldValue != null)
    {
        TextRange range = e.OldValue as TextRange;
        if (range != null)
            range.Changed -= new EventHandler(range_Changed);
    }

    if (e.NewValue != null)
    {
        TextRange range = e.NewValue as TextRange;
        if (range != null)
            range.Changed -= new EventHandler(range_Changed);
    }
}

static void range_Changed(object sender, EventArgs e)
{
    // need ScrollViewer!!
}

- chilltemp

Answer 1

在可视树构建完成之前，OnEnabledChanged会被调用，因此无法找到ScrollViewer。

使用Dispatcher.BeginInvoke将其余的工作排队，以便在可视树构建完成后异步进行。您还需要调用ApplyTemplate以确保模板已实例化：

d.Dispatcher.BeginInvoke(new Action(() =>
{
    ((FrameworkElement)d).ApplyTemplate();
    d.SetValue(ScrollViewerProperty, FindScrollViewer(d));
}));

请注意，在设置依赖属性时，您无需检查新值是否与旧值不同。框架会为您处理此事。

您也可以使用FrameworkTemplate.FindName从FlowDocumentScrollViewer中获取ScrollViewer。FlowDocumentScrollViewer具有名为PART_ContentHost的类型为ScrollViewer的命名模板部分，该部分实际上是托管内容的位置。如果查看器重新模板化并且有多个ScrollViewer作为子项，则这可能更准确。

var control = d as Control;
if (control != null)
{
    control.Dispatcher.BeginInvoke(new Action(() =>
    {
        control.ApplyTemplate();
        control.SetValue(ScrollViewerProperty,
            control.Template.FindName("PART_ContentHost", control)
                as ScrollViewer);
    }));
}

我不知道如何连接到包含FlowDocument的DependencyProperty。我的计划是使用它的更改事件来初始化ManagedRange属性（如果需要，手动触发第一次）。

框架中没有内置的方法可以从任意依赖属性获取属性更改通知。但是，您可以创建自己的DependencyProperty，并将其绑定到要监视的属性。有关更多信息，请参见更改依赖属性的通知。

创建一个依赖属性：

private static readonly DependencyProperty InternalDocumentProperty = 
    DependencyProperty.RegisterAttached(
        "InternalDocument",
        typeof(FlowDocument),
        typeof(YourType),
        new PropertyMetadata(OnFlowDocumentChanged));

并且在OnEnabledChanged中，将您的反射代码替换为：

BindingOperations.SetBinding(d, InternalDocumentProperty, 
    new Binding("Document") { Source = d });

当FlowDocumentScrollViewer的Document属性更改时，绑定将更新InternalDocument，并调用OnFlowDocumentChanged。

“我不知道如何从range_Changed方法中访问ScrollViewer属性，因为它没有DependencyObject。”

发送方属性将是TextRange，因此您可以使用((TextRange)sender).Start.Parent获取DependencyObject，然后向上遍历可视树。

更简单的方法是使用lambda表达式通过在OnMonitoredRangeChanged中捕获d变量来执行此操作：

range.Changed += (sender, args) => range_Changed(d);

然后创建一个重载的range_Changed方法，接受一个DependencyObject参数。这样做会使在完成后删除处理程序有点困难。

此外，尽管检测FlowDocument更改和滚动的答案说TextRange.Changed可以工作，但我在测试时并没有看到它实际触发。如果它对您不起作用，并且您愿意使用反射，那么似乎确实会触发TextContainer.Changed事件：

var container = doc.GetType().GetProperty("TextContainer", 
    BindingFlags.Instance | BindingFlags.NonPublic).GetValue(doc, null);
var changedEvent = container.GetType().GetEvent("Changed", 
    BindingFlags.Instance | BindingFlags.NonPublic);
EventHandler handler = range_Changed;
var typedHandler = Delegate.CreateDelegate(changedEvent.EventHandlerType, 
    handler.Target, handler.Method);
changedEvent.GetAddMethod(true).Invoke(container, new object[] { typedHandler });

sender 参数将是 TextContainer，您可以再次使用反射返回到 FlowDocument：

var document = sender.GetType().GetProperty("Parent", 
    BindingFlags.Instance | BindingFlags.NonPublic)
    .GetValue(sender, null) as FlowDocument;
var viewer = document.Parent;

- Quartermeister

---

很棒，谢谢。我会在接下来的一两天里仔细研究这个。 - chilltemp

感谢所有的帮助。我使用TextContainer反射逻辑使其正常工作了。遗憾的是，MS将ITextContainer作为内部接口。这可能会在未来的.NET版本中出现问题，但不会影响我的第一个黑客攻击。 - chilltemp

Answer 2

这个有帮助吗？

至少是一个好的开始（也许？）。

- TheSoftwareJedi