WPF中的文本格式化：自定义TextFormatter实现高级文本处理

原创 于 2025-09-10 06:46:42 发布 · 923 阅读 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。

WPF中的文本格式化：自定义TextFormatter实现高级文本处理

【免费下载链接】HandyControl Contains some simple and commonly used WPF controls 【免费下载链接】HandyControl 项目地址: https://gitcode.com/gh_mirrors/ha/HandyControl

引言：WPF文本格式化的痛点与解决方案

在WPF（Windows Presentation Foundation）开发中，文本格式化是构建现代UI的核心需求之一。开发者经常面临三大挑战：文本溢出处理繁琐、自定义格式实现复杂、性能优化困难。本文将深入探讨如何通过自定义TextFormatter（文本格式化器）解决这些痛点，并结合HandyControl开源项目的实践经验，提供一套完整的高级文本处理解决方案。

读完本文，您将掌握：

  • WPF文本渲染的底层工作原理
  • 自定义TextFormatter的实现步骤与最佳实践
  • 文本溢出、自动工具提示等常见问题的解决方案
  • HandyControl中TextBlockAttach的高级应用技巧

WPF文本渲染基础：从FormattedText到TextFormatter

WPF文本处理架构

WPF的文本渲染系统基于两个核心组件：FormattedText（格式化文本）和TextFormatter（文本格式化器）。它们的关系如下：

mermaid

FormattedText类用于创建具有特定格式的文本对象，支持字体、大小、颜色等基本样式设置。而TextFormatter则负责更复杂的文本布局计算，包括文本拆分、换行和对齐等高级功能。

FormattedText基础用法

创建基本格式化文本的代码示例：

var formattedText = new FormattedText(
    "Hello, WPF Text Formatting!",
    CultureInfo.CurrentCulture,
    FlowDirection.LeftToRight,
    new Typeface("Segoe UI"),
    14,
    Brushes.Black);

// 应用加粗效果
formattedText.SetFontWeight(FontWeights.Bold, 0, 5);

// 应用红色文本
formattedText.SetForegroundBrush(Brushes.Red, 7, 3);

TextFormatter工作原理

TextFormatter通过以下流程处理文本：

  1. 创建TextSource提供文本内容和格式信息
  2. 调用FormatLine方法获取TextLine对象
  3. 通过TextLine的Draw方法渲染文本

代码示例：

var textFormatter = TextFormatter.Create();
var textSource = new CustomTextSource("Sample text with custom formatting");
var textLine = textFormatter.FormatLine(
    textSource,
    0,
    400, // 最大宽度
    new TextParagraphProperties(new GenericTextRunProperties()),
    null);

textLine.Draw(drawingContext, new Point(0, 0), InvertAxes.None);

自定义TextFormatter：实现高级文本处理

自定义TextFormatter的核心组件

实现自定义TextFormatter需要创建以下关键类：

mermaid

步骤1：创建自定义TextRunProperties

TextRunProperties定义文本运行（Text Run）的格式属性：

public class CustomTextRunProperties : TextRunProperties
{
    private readonly Typeface _typeface;
    private readonly double _fontSize;
    private readonly Brush _foreground;
    private readonly TextDecorations _textDecorations;

    public CustomTextRunProperties(Typeface typeface, double fontSize, Brush foreground, TextDecorations textDecorations)
    {
        _typeface = typeface;
        _fontSize = fontSize;
        _foreground = foreground;
        _textDecorations = textDecorations;
    }

    // 实现必要的属性
    public override Typeface Typeface => _typeface;
    public override double FontRenderingEmSize => _fontSize;
    public override Brush ForegroundBrush => _foreground;
    public override TextDecorations TextDecorations => _textDecorations;
    
    // 其他属性实现...
}

步骤2：实现自定义TextSource

TextSource负责提供文本内容和对应的格式信息：

public class CustomTextSource : TextSource
{
    private readonly string _text;
    private readonly CustomTextRunProperties _defaultRunProperties;

    public CustomTextSource(string text, CustomTextRunProperties defaultRunProperties)
    {
        _text = text;
        _defaultRunProperties = defaultRunProperties;
    }

    public override TextRun GetTextRun(int textSourceCharacterIndex)
    {
        // 如果已到达文本末尾，返回文本结束标记
        if (textSourceCharacterIndex >= _text.Length)
        {
            return new TextEndOfParagraph(1);
        }

        // 查找格式变化的位置
        var formatChangeIndex = FindFormatChange(textSourceCharacterIndex);
        
        if (formatChangeIndex > textSourceCharacterIndex)
        {
            // 返回当前格式的文本运行
            return new TextCharacters(
                _text, 
                textSourceCharacterIndex, 
                formatChangeIndex - textSourceCharacterIndex, 
                _defaultRunProperties);
        }
        else
        {
            // 返回新格式的文本运行（示例）
            var newProperties = CreateNewFormatProperties();
            return new TextCharacters(
                _text, 
                textSourceCharacterIndex, 
                1, 
                newProperties);
        }
    }
    
    // 辅助方法实现...
}

步骤3：构建自定义TextFormatter

public class AdvancedTextFormatter : TextFormatter
{
    public override TextLine FormatLine(
        TextSource textSource,
        int firstCharIndex,
        double paragraphWidth,
        TextParagraphProperties paragraphProperties,
        TextLineBreak previousLineBreak)
    {
        // 创建文本段落格式
        var textRunProperties = paragraphProperties.DefaultTextRunProperties;
        
        // 实现自定义文本布局逻辑
        var textLine = new CustomTextLine(
            textSource, 
            firstCharIndex, 
            paragraphWidth, 
            textRunProperties);
            
        return textLine;
    }
    
    public override double GetMaxTextWidthFromCharacterBufferRange(
        TextSource textSource,
        int firstCharIndex,
        int textLength)
    {
        // 实现文本宽度计算逻辑
        // ...
    }
}

HandyControl中的文本处理实践：TextBlockAttach解析

TextBlockAttach组件架构

HandyControl是一个流行的WPF开源控件库，其TextBlockAttach类提供了文本块的增强功能。类结构如下：

mermaid

自动工具提示实现原理

TextBlockAttach通过附加属性实现文本溢出时自动显示工具提示：

public class TextBlockAttach
{
    public static readonly DependencyProperty AutoTooltipProperty = DependencyProperty.RegisterAttached(
        "AutoTooltip", typeof(bool), typeof(TextBlockAttach), 
        new PropertyMetadata(ValueBoxes.FalseBox, OnAutoTooltipChanged));

    public static void SetAutoTooltip(DependencyObject element, bool value)
        => element.SetValue(AutoTooltipProperty, ValueBoxes.BooleanBox(value));

    public static bool GetAutoTooltip(DependencyObject element)
        => (bool)element.GetValue(AutoTooltipProperty);

    private static void OnAutoTooltipChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        if (d is TextBlock textBlock)
        {
            if ((bool)e.NewValue)
            {
                UpdateTooltip(textBlock);
                textBlock.SizeChanged += TextBlock_SizeChanged;
            }
            else
            {
                textBlock.SizeChanged -= TextBlock_SizeChanged;
                ToolTipService.SetToolTip(textBlock, null);
            }
        }
    }

    private static void TextBlock_SizeChanged(object sender, SizeChangedEventArgs e)
    {
        if (sender is TextBlock textBlock)
        {
            UpdateTooltip(textBlock);
        }
    }

    private static void UpdateTooltip(TextBlock textBlock)
    {
        textBlock.Measure(new Size(double.PositiveInfinity, double.PositiveInfinity));
        var desiredWidth = textBlock.DesiredSize.Width - textBlock.Margin.Left - textBlock.Margin.Right;

        // 检查文本是否溢出
        if (textBlock.ActualWidth < desiredWidth || 
            Math.Abs(CalcTextWidth(textBlock) - desiredWidth) > 1)
        {
            ToolTipService.SetToolTip(textBlock, textBlock.Text);
        }
        else
        {
            ToolTipService.SetToolTip(textBlock, null);
        }
    }

    private static double CalcTextWidth(TextBlock textBlock)
    {
        // 使用FormattedText计算文本宽度
        var formattedText = new FormattedText(
            textBlock.Text,
            CultureInfo.CurrentCulture,
            textBlock.FlowDirection,
            new Typeface(textBlock.FontFamily, textBlock.FontStyle, textBlock.FontWeight, textBlock.FontStretch),
            textBlock.FontSize,
            Brushes.Black);

        return formattedText.WidthIncludingTrailingWhitespace;
    }
}

XAML中使用TextBlockAttach

<TextBlock Text="这是一段可能会溢出的长文本内容"
           hc:TextBlockAttach.AutoTooltip="True"
           Width="150" />

高级文本格式化技术与性能优化

文本溢出处理策略对比

方法优点缺点适用场景
截断 + 省略号实现简单，性能好丢失部分文本标题、标签等短文本
自动工具提示保留完整信息需要额外计算描述性文本
文本换行显示全部内容占用垂直空间段落文本
滚动文本节省空间分散用户注意力状态栏文本

实现自定义文本溢出效果

结合自定义TextFormatter和TextBlockAttach，实现高级溢出效果：

public class EllipsisTextFormatter : TextFormatter
{
    public override TextLine FormatLine(
        TextSource textSource,
        int firstCharIndex,
        double paragraphWidth,
        TextParagraphProperties paragraphProperties,
        TextLineBreak previousLineBreak)
    {
        // 调用基础实现
        var textLine = base.FormatLine(
            textSource, 
            firstCharIndex, 
            paragraphWidth, 
            paragraphProperties, 
            previousLineBreak);
            
        // 检查是否溢出
        if (textLine.HasOverflowed)
        {
            // 创建带省略号的文本行
            return CreateEllipsisTextLine(textLine, paragraphWidth);
        }
        
        return textLine;
    }
    
    private TextLine CreateEllipsisTextLine(TextLine originalLine, double maxWidth)
    {
        // 实现自定义省略号逻辑
        // ...
    }
}

性能优化技巧

  1. 对象池化：重用FormattedText对象减少GC压力
public static class FormattedTextPool
{
    private static readonly ObjectPool<FormattedText> _pool = new ObjectPool<FormattedText>(
        () => new FormattedText("", CultureInfo.CurrentCulture, FlowDirection.LeftToRight, 
                                new Typeface("Segoe UI"), 12, Brushes.Black),
        ft => ft.SetText("", 0));
        
    public static FormattedText Get(string text, Typeface typeface, double fontSize)
    {
        var ft = _pool.Get();
        ft.SetText(text);
        ft.Typeface = typeface;
        ft.FontSize = fontSize;
        return ft;
    }
    
    public static void Release(FormattedText ft)
    {
        _pool.Release(ft);
    }
}
  1. 延迟计算：仅在必要时执行文本测量
private Lazy<double> _textWidth = new Lazy<double>(() => CalculateTextWidth());

public double TextWidth => _textWidth.Value;

// 当文本或样式变化时重置Lazy实例
private void OnTextChanged()
{
    _textWidth = new Lazy<double>(() => CalculateTextWidth());
}
  1. 虚拟化：对长文本采用UI虚拟化技术

实战案例：构建高级代码编辑器文本格式化器

需求分析

构建一个代码编辑器需要以下文本格式化功能：

  • 语法高亮显示
  • 行号显示
  • 折叠/展开代码块
  • 语法错误标记

实现架构

mermaid

核心代码实现

语法高亮文本源：

public class CodeTextSource : TextSource
{
    private readonly string _code;
    private readonly SyntaxHighlighting _highlighting;
    
    public CodeTextSource(string code, SyntaxHighlighting highlighting)
    {
        _code = code;
        _highlighting = highlighting;
    }
    
    public override TextRun GetTextRun(int textSourceCharacterIndex)
    {
        // 实现语法高亮逻辑
        var token = _highlighting.GetTokenAt(_code, textSourceCharacterIndex);
        var runProperties = CreateRunPropertiesForToken(token);
        
        return new TextCharacters(
            _code, 
            textSourceCharacterIndex, 
            token.Length, 
            runProperties);
    }
    
    private TextRunProperties CreateRunPropertiesForToken(Token token)
    {
        // 根据令牌类型返回相应的文本样式
        switch (token.Type)
        {
            case TokenType.Keyword:
                return new KeywordTextRunProperties();
            case TokenType.String:
                return new StringTextRunProperties();
            // 其他令牌类型...
            default:
                return new DefaultTextRunProperties();
        }
    }
}

总结与展望

本文深入探讨了WPF文本格式化的核心技术，从基础的FormattedText使用到高级自定义TextFormatter实现，全面覆盖了WPF文本处理的关键知识点。通过HandyControl项目的TextBlockAttach组件实例，展示了如何将这些技术应用到实际项目中，解决文本溢出等常见问题。

随着.NET 5+和.NET MAUI的发展，WPF文本处理技术也在不断演进。未来，我们可以期待更强大的文本布局引擎和更丰富的格式化选项。同时，WebAssembly技术的发展也为WPF文本渲染带来了新的可能性，例如通过Blazor WebAssembly实现跨平台文本处理。

掌握自定义TextFormatter不仅能解决当前的文本处理难题，更能为未来UI技术发展打下坚实基础。建议开发者深入研究WPF文本渲染的底层原理，结合开源项目的优秀实践，构建更高性能、更美观的WPF应用程序。

扩展资源与学习路径

推荐学习资源

进阶学习路线

mermaid

通过这个学习路径，您将逐步掌握从基础到高级的WPF文本处理技术，为构建专业级WPF应用程序打下坚实基础。

结语

文本格式化是WPF开发中不可或缺的一环，而自定义TextFormatter则是实现高级文本处理的关键。本文详细介绍了从基础概念到高级实现的全过程，并结合HandyControl开源项目的实践经验，提供了实用的代码示例和最佳实践。

无论是解决文本溢出问题，还是实现复杂的语法高亮，掌握这些技术都将极大提升您的WPF应用程序质量。希望本文能成为您探索WPF文本格式化世界的起点，激发更多创新的文本处理解决方案。

如果您觉得本文有价值，请点赞、收藏并关注作者，获取更多WPF高级开发技巧。下一篇文章我们将探讨"WPF中的高级排版引擎：实现富文本编辑器"，敬请期待！

【免费下载链接】HandyControl Contains some simple and commonly used WPF controls 【免费下载链接】HandyControl 项目地址: https://gitcode.com/gh_mirrors/ha/HandyControl

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值