WPF利用TextBlock实现查找结果高亮显示效果

更新时间：2023年08月28日 10:02:45 作者：czwy

在应用开发过程中,经常遇到这样的需求：通过关键字查找数据,把带有关键字的数据显示出来,同时在结果中高亮显示关键字,所以本文就来和大家介绍一下如何利用TextBlock实现查找结果高亮显示效果吧

前言

在应用开发过程中，经常遇到这样的需求：通过关键字查找数据，把带有关键字的数据显示出来，同时在结果中高亮显示关键字。在web开发中，只需在关键字上加一层标签，然后设置标签样式就可以轻松实现。

在WPF中显示文本内容通常采用TextBlock控件，也可以采用类似的方式，通过内联流内容元素Run达到同样的效果：

<TextBlock FontSize="20">
    <Run Text="Hel" /><Run Foreground="Red" Text="lo " /><Run Text="Word" />
</TextBlock>

需要注意的是每个Run之间不要换行，如果换行的话，每个Run之间会有间隙，看起来像增加了空格。

通过这种方式实现查找结果中高亮关键字，需要把查找结果拆分成三部分，然后绑定到Run元素的Text属性，或者在后台代码中使用TextBlock的Inlines属性添加Run元素

textBlock1.Inlines.Add(new Run("hel"));
textBlock1.Inlines.Add(new Run("lo ") { Foreground=new SolidColorBrush(Colors.Red)});
textBlock1.Inlines.Add(new Run("world"));

这种方法虽然可以达到效果，但显然与MVVM的思想不符。接下来本文介绍一种通过附加属性实现TextBlock中指定内容高亮。

技术要点与实现

通过TextEffect的PositionStart、PositionCount以及Foreground属性设置字符串中需要高亮内容的起始位置、长度以及高亮颜色。定义附加属性允许TextBlock设置需要高亮的内容位置以及颜色。

首先定义类ColoredLettering(并不要求继承DependencyObject)。
在ColoredLettering中注册自定义的附加属性，注册附加属性方式与注册依赖属性类似，不过附加属性是用DependencyProperty.RegisterAttached来注册。
给附加属性注册属性值变化事件，事件处理逻辑中设置TextEffect的PositionStart、PositionCount以及Foreground实现内容高亮。

public class ColoredLettering
{
    public static void SetColorStart(TextBlock textElement, int value)
    {
        textElement.SetValue(ColorStartProperty, value);
    }
    public static int GetColorStart(TextBlock textElement)
    {
        return (int)textElement.GetValue(ColorStartProperty);
    }
    // Using a DependencyProperty as the backing store for ColorStart.  This enables animation, styling, binding, etc...
    public static readonly DependencyProperty ColorStartProperty =
        DependencyProperty.RegisterAttached("ColorStart", typeof(int), typeof(ColoredLettering), new FrameworkPropertyMetadata(0, OnColorStartChanged));
    private static void OnColorStartChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        TextBlock textBlock = d as TextBlock;
        if (textBlock != null)
        {
            if (e.NewValue == e.OldValue) return;
                if (e.NewValue is int)
                {
                    int count = GetColorLength(textBlock);
                    Brush brush = GetForeColor(textBlock);
                    if ((int)e.NewValue <= 0 || count <= 0 || brush == TextBlock.ForegroundProperty.DefaultMetadata.DefaultValue) return;
                    if (textBlock.TextEffects.Count != 0)
                    {
                        textBlock.TextEffects.Clear();
                    }
                    TextEffect textEffect = new TextEffect()
                    {
                        Foreground = brush,
                        PositionStart = (int)e.NewValue,
                        PositionCount = count
                    };
                    textBlock.TextEffects.Add(textEffect);
                }
        }
    }
    public static void SetColorLength(TextBlock textElement, int value)
    {
        textElement.SetValue(ColorLengthProperty, value);
    }
    public static int GetColorLength(TextBlock textElement)
    {
        return (int)textElement.GetValue(ColorLengthProperty);
    }
    // Using a DependencyProperty as the backing store for ColorStart.  This enables animation, styling, binding, etc...
    public static readonly DependencyProperty ColorLengthProperty =
        DependencyProperty.RegisterAttached("ColorLength", typeof(int), typeof(ColoredLettering), new FrameworkPropertyMetadata(0, OnColorLengthChanged));
    private static void OnColorLengthChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        TextBlock textBlock = d as TextBlock;
            if (textBlock != null)
            {
                if (e.NewValue == e.OldValue) return;
                if (e.NewValue is int)
                {
                    int start = GetColorStart(textBlock);
                    Brush brush = GetForeColor(textBlock);
                    if ((int)e.NewValue <= 0 || start <= 0 || brush == TextBlock.ForegroundProperty.DefaultMetadata.DefaultValue) return;
                    if (textBlock.TextEffects.Count != 0)
                    {
                        textBlock.TextEffects.Clear();
                    }
                    TextEffect textEffect = new TextEffect()
                    {
                        Foreground = brush,
                        PositionStart = start,
                        PositionCount = (int)e.NewValue
                    };
                    textBlock.TextEffects.Add(textEffect);
                }
            }
    }
    public static void SetForeColor(TextBlock textElement, Brush value)
    {
        textElement.SetValue(ColorStartProperty, value);
    }
    public static Brush GetForeColor(TextBlock textElement)
    {
        return (Brush)textElement.GetValue(ForeColorProperty);
    }
    // Using a DependencyProperty as the backing store for ForeColor.  This enables animation, styling, binding, etc...
    public static readonly DependencyProperty ForeColorProperty =
        DependencyProperty.RegisterAttached("ForeColor", typeof(Brush), typeof(ColoredLettering), new PropertyMetadata(TextBlock.ForegroundProperty.DefaultMetadata.DefaultValue, OnForeColorChanged));
    private static void OnForeColorChanged(DependencyObject d, DependencyPropertyChangedEventArgs e)
    {
        TextBlock textBlock = d as TextBlock;
        if (textBlock != null)
        {
            if (e.NewValue == e.OldValue) return;
            if (e.NewValue is Brush)
            {
                int start = GetColorStart(textBlock);
                int count = GetColorLength(textBlock);
                if (start <= 0 || count <= 0) return;
                if (textBlock.TextEffects.Count != 0)
                {
                    textBlock.TextEffects.Clear();
                }
                TextEffect textEffect = new TextEffect()
                {
                    Foreground = (Brush)e.NewValue,
                    PositionStart = start,
                    PositionCount = count
                };
                textBlock.TextEffects.Add(textEffect);
            }
        }
    }
}

调用时只需在TextBlock指定需要高亮内容的开始位置，内容长度以及高亮颜色即可。

<TextBlock local:ColoredLettering.ColorLength="{Binding Count}"
           local:ColoredLettering.ColorStart="{Binding Start}"
           local:ColoredLettering.ForeColor="{Binding ForeColor}"
           FontSize="20"
           Text="Hello World" />

总结

本文介绍的方法只是高亮第一个匹配到的关键字，如果需要高亮匹配到的所有内容，只需要对附加属性进行改造，以支持传入一组位置和颜色信息。
最后分享一个可以解析一组有限的HTML标记并显示它们的WPF控件HtmlTextBlock ，通过这个控件也可以实现查找结果中高亮关键字，甚至支持指定内容触发事件做一些逻辑操作。

到此这篇关于WPF利用TextBlock实现查找结果高亮显示效果的文章就介绍到这了,更多相关WPF TextBlock内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

C#调用webservice接口的最新方法教程
webservice 可以用于分布式应用程序之间的交互，和不同程序之间的交互。下面这篇文章主要给大家介绍了关于C#调用webservice接口的相关资料，文中通过图文介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友下面随着小编来一起看看吧。
2017-11-11
一文带你快速学会C#中WinForm框架的使用详解
WinForm是一门非常经济实惠的技术，就是说，可以在短时间内学会，并迅速借此进行项目开发。本文就来和大家聊聊WinForm框架的使用方法，希望对大家有所帮助
2023-02-02
C#实现简单学生信息管理系统
这篇文章主要为大家详细介绍了C#实现简单学生信息管理系统，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2019-06-06
详解C# 网络编程系列：实现类似QQ的即时通信程序
本篇主要介绍了c#实现类似QQ的即时通信程序，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。
2016-12-12
c# 数据标注与数据校验
这篇文章主要介绍了c# 数据标注与数据校验的相关资料,帮助大家更好的理解和学习c#，感兴趣的朋友可以了解下
2020-10-10
关于System.Convert的那些事儿
本篇文章是对System.Convert的那些事儿，进行了详细的分析介绍，需要的朋友参考下
2013-05-05
c#操作xml帮助类分享(xml增删改查)
c#操作xml帮助类XMLHelper源码分享，实现对XML文档的创建,及节点和属性的增、删、改、查
2014-01-01
Visual Studio连接unity编辑器的实现步骤
unity编辑器中打开C#脚本的时候发现Visual Studio没有连接unity编辑器,本文主要介绍了Visual Studio连接unity编辑器的实现步骤,感兴趣的可以了解一下
2023-11-11
基于Unity3D实现3D迷宫小游戏的示例代码
迷宫游戏作为经典的小游戏，一直深受大家的喜爱。本文小编将为大家详细介绍一下如何用Unity实现一个3D版的迷宫小游戏，感兴趣的可以动手试一试
2022-03-03
C#给图片添加水印完整实例
这篇文章主要介绍了C#给图片添加水印的方法,以完整实例形式分析了C#实现文字及图像水印、缩略图、图片剪切等相关技巧,需要的朋友可以参考下
2015-12-12

WPF利用TextBlock实现查找结果高亮显示效果

目录

前言

技术要点与实现

总结

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具