等待控件布局完成

Question

我正在将大量富文本加载到 RichTextBox (WPF) 中，并且我想滚动到内容末尾：

richTextBox.Document.Blocks.Add(...)
richTextBox.UpdateLayout();
richTextBox.ScrollToEnd();

这不起作用，ScrollToEnd 在以下情况下执行布局尚未完成，因此它不会滚动到末尾，而是滚动到文本的前三分之一左右。

有没有办法强制等待 RichTextBox 完成其绘制和布局操作，以便 ScrollToEnd 实际上滚动到文本的末尾？

谢谢。

不起作用的东西：

编辑： 我已经尝试过 LayoutUpdated 事件，但它立即被触发，同样的问题：当它被触发时，控件仍然在 Richtextbox 内布局更多文本，所以即使是 ScrollToEnd 也没有工作... 我尝试了这个：

richTextBox.Document.Blocks.Add(...)
richTextBoxLayoutChanged = true;
richTextBox.UpdateLayout();
richTextBox.ScrollToEnd();

在 richTextBox.LayoutUpdated 事件处理程序中：

if (richTextBoxLayoutChanged)
{
    richTextBoxLayoutChanged = false;
    richTextBox.ScrollToEnd();
}

该事件被正确触发，但太快了，richtextbox 在触发时仍在添加更多文本，布局尚未完成，因此 ScrollToEnd< /code> 再次失败。

编辑2： 按照 dowhilefor 的回答：MSDN on InvalidateArrange 说

失效后，元素的布局将更新，这将 异步发生，除非随后被 UpdateLayout 强制。

但甚至

richTextBox.InvalidateArrange();
richTextBox.InvalidateMeasure();
richTextBox.UpdateLayout();

不等待：在这些调用之后，richtextbox 仍在添加更多文本并将其异步放置在自身内部。 ARG！

Answer 1

我遇到过一个相关的情况：我有一个打印预览对话框，可以创建精美的渲染效果。通常，用户会单击一个按钮来实际打印它，但我也想用它来保存图像而无需用户参与。在这种情况下，创建图像必须等到布局完成。

我使用以下方法进行了管理：

Dispatcher.Invoke(new Action(() => {SaveDocumentAsImage(....);}), DispatcherPriority.ContextIdle);

关键是 DispatcherPriority.ContextIdle，它会等待后台任务完成。

编辑：根据扎克的要求，包括适用于这种特定情况的代码：

Dispatcher.Invoke(() => { richTextBox.ScrollToEnd(); }), DispatcherPriority.ContextIdle);

我应该注意到，我对这个解决方案并不满意，因为它感觉非常脆弱。然而，它似乎确实适用于我的具体情况。

Answer 2

特别看看 UpdateLayout

：

如果满足以下条件，调用此方法没有效果：
布局没有改变，或者如果两者都没有改变
的排列或测量状态
布局无效

因此根据您的需要调用 InvalidateMeasure 或 InvalidateArrange 应该可行。

但考虑到你的代码。我认为这行不通。许多 WPF 加载和创建都被延迟，因此向 Document.Blocks 添加某些内容并不一定会直接更改 UI。但我必须说，这只是一个猜测，也许我是错的。

Answer 3

您应该能够使用 Loaded 事件

如果您多次执行此操作，那么您应该查看 LayoutUpdated 事件

myRichTextBox.LayoutUpdated += (source,args)=> ((RichTextBox)source).ScrollToEnd();

Answer 4

使用 .net 4.5 或 async blc 包，您可以使用以下扩展方法

 /// <summary>
    /// Async Wait for a Uielement to be loaded
    /// </summary>
    /// <param name="element"></param>
    /// <returns></returns>
    public static Task WaitForLoaded(this FrameworkElement element)
    {
        var tcs = new TaskCompletionSource<object>();
        RoutedEventHandler handler = null;
        handler = (s, e) =>
        {
            element.Loaded -= handler;
            tcs.SetResult(null);
        };
        element.Loaded += handler;
        return tcs.Task;
    }

Answer 5

@Andreas 的回答效果很好。

但是，如果控件已经加载怎么办？该事件永远不会触发，并且等待可能会永远挂起。要解决此问题，如果表单已加载，请立即返回：

/// <summary>
/// Intent: Wait until control is loaded.
/// </summary>
public static Task WaitForLoaded(this FrameworkElement element)
{
    var tcs = new TaskCompletionSource<object>();
    RoutedEventHandler handler = null;
    handler = (s, e) =>
    {
        element.Loaded -= handler;
        tcs.SetResult(null);
    };
    element.Loaded += handler;

    if (element.IsLoaded == true)
    {
        element.Loaded -= handler;
        tcs.SetResult(null);
    }
        return tcs.Task;
}

其他提示

这些提示可能有用，也可能没用。

• 上面的代码在附加属性中非常有用。附加属性仅在值更改时才会触发。当切换附加属性来触发它时，使用 task.Yield() 将调用置于调度程序队列的后面：

  await Task.Yield(); // 将我们自己置于调度程序队列的末尾。
  PopWindowToForegroundNow = false;
  等待任务.Yield(); // 将我们自己置于调度程序队列的末尾。
  PopWindowToForegroundNow = false;
  

• 上面的代码在附加属性中非常有用。当切换附加属性来触发它时，您可以使用调度程序，并将优先级设置为Loaded：

  // 确保 PopWindowToForegroundNow 初始化为 true
  //（附加属性仅在值更改时触发）。
  Application.Current.Dispatcher.Invoke(
  异步 
     ()=>
  {
      if (PopWindowToForegroundNow == false)
      {
         // 已经可见！
      }
      别的
      {
          等待任务.Yield(); // 将我们自己置于调度程序队列的末尾。
          PopWindowToForegroundNow = false;
      }
  }, DispatcherPriority.Loaded);
  

Answer 6

尝试添加 richTextBox.ScrollToEnd();调用 RichTextBox 对象的 LayoutUpdated 事件处理程序。

Answer 7

试试这个：

richTextBox.CaretPosition = richTextBox.Document.ContentEnd;
richTextBox.ScrollToEnd(); // maybe not necessary

Answer 8

对我的 WPF 项目有效的唯一（kludge）解决方案是启动一个单独的线程，该线程休眠一段时间，然后要求滚动到末尾。

重要的是不要尝试在主 GUI 上调用这个“休眠”线程，以免用户被暂停。因此，调用一个单独的“休眠”线程并定期在主 GUI 线程上调用 Dispatcher.Invoke 并要求滚动到末尾。

运行完美，用户体验也不错：

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

try {

    richTextBox.ScrollToEnd();

    Thread thread       = new Thread(new ThreadStart(ScrollToEndThread));
    thread.IsBackground = true;
    thread.Start();

} catch (Exception e) {

    Logger.Log(e.ToString());
}

并且

private void ScrollToEndThread() {

// Using this thread to invoke scroll to bottoms on rtb
// rtb was loading for longer than 1 second sometimes, so need to 
// wait a little, then scroll to end
// There was no discernable function, ContextIdle, etc. that would wait
// for all the text to load then scroll to bottom
// Without this, on target machine, it would scroll to the bottom but the
// text was still loading, resulting in it scrolling only part of the way
// on really long text.
// Src: https://stackoverflow.com/questions/6614718/wait-until-control-layout-is-finished
    for (int i=1000; i <= 10000; i += 3000) {

        System.Threading.Thread.Sleep(i);

        this.richTextBox.Dispatcher.Invoke(
            new ScrollToEndDelegate(ScrollToEnd),
            System.Windows.Threading.DispatcherPriority.ContextIdle,
            new object[] {  }
            );
    }
}

private delegate void ScrollToEndDelegate();

private void ScrollToEnd() {

    richTextBox.ScrollToEnd();
}