AnyLinkRichTextBox

• 如果我们希望控件检测链接，我们必须将 this.DetectUrls 设置为 true。

"但是等等！base.DetectUrls 和 this.DetectUrls 之间有什么区别？" - 您现在可能会问……

区别在于：前者是基类 (RichTextBox) 的 DetectUrls 属性，后者是覆盖它的一个属性。

^返回索引

属性

[Browsable(true),
DefaultValue(false)]
public new bool DetectUrls { get; set; }

此属性定义在此处，以确保不会修改基类 (RichTextBox) 的 DetectUrls 属性，但同时保留此控件不检测任何 URL 的可能性。

^返回索引

事件

我们在构造函数中添加了 4 个事件，还记得吗？现在，我将解释每一个。

RTBExCustomLinks_Protected

private void RTBExCustomLinks_Protected(object sender, EventArgs e)
{
    if (DetectUrls)
    {
        int i = 0;
        bool protectedBegin = true;
        bool protectedEnd = true;
        KeyValuePair<int, int> key;
        while (protectedBegin)
        {
            i++;
            int previous = this.SelectionStart - 1;
            this.Select(previous - 1, i);
            protectedBegin = this.SelectionProtected;
            this.Select(previous, i);
        }
        if (!(this.SelectionStart + this.SelectionLength == this.Text.Length))
        {
            while (protectedEnd && !(this.SelectionStart + this.SelectionLength == this.Text.Length))
            {
                i++;
                this.Select(this.SelectionStart, i);
                protectedEnd = this.SelectionProtected;
                this.Select(this.SelectionStart, i - 1);
            }
        }
        string text = this.SelectedText;
        this.SelectionProtected = false;
        key = new KeyValuePair<int, int>(this.SelectionStart, text.Length);
        this.SelectedText = String.Concat(spliters[0], text, spliters[1], spliters[2], hyperlinks[key]);
        hyperlinks.Remove(key);
    }
}

此事件用于使用户能够更改先前创建的自定义链接。

当创建自定义链接时，只会显示友好文本，而超链接将被隐藏（我将在解释 CheckCustomLinks 方法时专门讨论这一点）。因此，如果用户想修改超链接或友好文本，我们必须提供一种安全的方式来执行此操作。

RTBExCustomLinks_Protected 事件就是为此目的而设计的。

• 首先，它检查 DetectUrls 是否设置为 true。然后，它将找到链接文本的开头。
• 然后它检查我们是否在文本的末尾。如果不在，它将找到链接文本的结尾。
• 此时，它将已选中整个链接文本，因此现在，它将关闭保护。
• 最后，用原始格式替换链接文本，仅删除最后一个分隔符，例如 [链接文本](超链接文本
• 最后，它将从链接字典中删除该链接。

^返回索引

RTBExCustomLinks_MouseMove

private void RTBExCustomLinks_MouseMove(object sender, MouseEventArgs e)
{
    pt = e.Location;
}

这是控件中最简单的事件。它只是监控鼠标在控件上方的位置，并将该数据存储到点 pt 中。

^返回索引

RTBExCustomLinks_LinkClicked

private void RTBExCustomLinks_LinkClicked(object sender, LinkClickedEventArgs e)
{
    if (DetectUrls)
    {
        if (normalLinks.IsMatch(e.LinkText))
        {
            Process.Start(e.LinkText);
        }
        else if (mailLinks.IsMatch(e.LinkText))
        {
            Process.Start("mailto:" + e.LinkText);
        }
        else if (IPLinks.IsMatch(e.LinkText))
        {
            Process.Start("http://" + e.LinkText);
        }
        else
        {
            int mouseClick = this.GetCharIndexFromPosition(pt);
            try
            {
                var linkClicked = hyperlinks.Where(k => IsInRange(mouseClick, k.Key.Key, k.Key.Value));
                string hyperlinkClicked = linkClicked.Select(k => k.Value).ToList().First();
                this.SelectionStart = linkClicked.Select(k => k.Key.Key).First() + linkClicked.Select(k => k.Key.Value).First();
                Process.Start(hyperlinkClicked);
            }
            catch (Exception)
            {
                MessageBox.Show("The link is not valid!");
            }
        }
    }
}

此事件将启动每种链接的正确过程。
首先，它会检查 DetectUrls 是否设置为 true，如果设置为 true，则事件将检查点击的链接文本是否与正则表达式匹配，直到找到正确的类型。

• 如果它是一个普通链接，即以普通协议（http://|https://|等）或www.开头。
• 如果它是一个类似邮件的链接，例如user@company.com 或 mailto:user@company.com
  • ^{（注意：为了使邮件链接生效，协议mailto:必须位于链接的开头。但是 mailLinks 正则表达式将任何格式为user@company.com 的文本（无论是否有协议）识别为邮件链接，因此用户拥有更多的自由。我们在这里处理了可能缺少协议的情况）。}
• 如果它是一个类似 IP 的链接，例如255.255.255.255
  • ^{（注意：为了使IP 链接生效，协议http://必须位于链接的开头。但是 IPLinks 正则表达式将任何格式为###.###.###.### 的文本识别为IP 链接，其中# = [0-255]。如果用户带协议写入，normalLinks 正则表达式将处理它。）}
• 最后，如果链接文本不匹配任何其他正则表达式，我们将尝试从友好文本中解析超链接。
  • 首先，我们使用点 pt 从鼠标位置获取字符索引。
  • 然后，我们根据该字符索引在 hyperlinks 字典中定位超链接。如何？很简单，我们使用 IsInRange 方法（本文未显示，如果您好奇，请查看源代码）来检查字符索引是否位于友好文本的第一个和最后一个字符之间，针对每个 hyperlinks key。当此方法返回 true 时，我们将 hyperlinks KeyValuePair 存储在局部变量 linkClicked 中。
  • 然后，我们将 hyperlinkClicked 变量设置为存储在 linkClicked value 中的超链接。
  • 最后，我们以 hyperlinkClicked 作为参数启动该过程。
  • 如果该过程中有任何问题，我们将假定超链接无效，并通知用户。

^返回索引

RTBExCustomLinks_TextChanged

private void RTBExCustomLinks_TextChanged(object sender, EventArgs e)
{
    if (DetectUrls)
    {
        SuspendDrawing();
        int pos = this.SelectionStart;

        pos = CheckCustomLinks(pos);
        MoveCustomLinks();
        RemoveLinks();
        
        CheckNormalLinks();
        CheckMailLinks();
        CheckIPLinks();

        RefreshCustomLinks();

        if (pos > 0)
        {
            this.Select(pos, 0);
        }
        else
        {
            this.Select(0, 0);
        }
        ResumeDrawing();
    }
}

这是整个过程的核心。在该事件中，我们识别所有链接以及其中可能存在的任何更改。

使用 TextChanged 事件，我们可以在运行时创建、修改或删除链接。

它将检查 DetectUrls 是否设置为 true，如果设置为 true，它将继续搜索链接。首先要做的是**暂停绘制**，原因如前所述。

然后，我们需要存储插入符号的位置，因此如果文本发生任何更改，我们可以将插入符号设置回之前的位置。这样用户就可以继续编写而不会有问题。

现在我将解释该事件的每个方法。

^返回索引

TextChanged 事件的方法

CheckCustomLinks

private int CheckCustomLinks(int pos)
{
    if (customLinks.Matches(this.Text).Cast<Match>().Any())
    {
        var linksCustom = customLinks.Matches(this.Text).Cast<Match>().Select(n => n).ToList();
        foreach (var item in linksCustom)
        {
            var parsedLink = item.Value.Split(spliters, StringSplitOptions.RemoveEmptyEntries);
            string text = parsedLink[0];
            string hyperlink = parsedLink[1];
            int start = item.Index;
            int length = item.Length;
            KeyValuePair<int, int> key = new KeyValuePair<int, int>(start, text.Length);
            if (hyperlinks.ContainsKey(key) || hyperlinks.Keys.Any(k => k.Key == key.Key))
            {
                hyperlinks.Remove(key);
                hyperlinks.Add(key, hyperlink);
            }
            else
            {
                hyperlinks.Add(key, hyperlink);
            };

            this.SelectionStart = start;
            this.Select(start, length);
            this.SelectedText = text;
            this.Select(start, text.Length);
            this.SetSelectionStyle(CFM_LINK, CFE_LINK);
            this.SelectionProtected = true;
            int pos2 = (pos - length) + text.Length;
            if (pos2 > 0)
            {
                this.Select(pos2, 0);
                pos = pos2;
            }
            else this.Select(0, 0);
        }
    }
    return pos;
}

此方法解析文本以查找匹配 customLinks 正则表达式的任何文本。

• 如果找到，它将把任何 Match 存储在局部变量（List）linksCustom 中，并为 linksCustom 的每个元素，它将分隔友好文本和超链接。
• 接下来，它将为 hyperlinks 字典创建一个 KeyValuePair key。
• 然后，它将检查创建的 key 是否已存在于字典 hyperlinks 中，**或者**字典 hyperlinks 中是否有任何条目的 KeyValuePair key 与创建的 KeyValuePair key 具有相同的key。如果其中任何一个条件为真，它将从字典中移除 entry 并添加一个新条目。
  • 第二个条件是必需的，因为如果友好文本的长度（即字典中 KeyValuePair key 的value）发生变化，但起始索引没有变化，我们仍然需要更新字典中的该数据。
• 如果两个条件都为 false，它将仅添加新的 entry。
• 现在，它将选择整个文本，例如 [友好文本](超链接) 并将其替换为友好文本。
  • 当我们为 SelectedText 属性设置新值时，选定的文本变为 ""，因此我们需要重新选择友好文本。
• 然后，我们使用 SetSelectionStyle 方法使其成为链接。最后，我们保护友好文本，以便能够识别用户何时想要更改/删除链接。
• 最后要做的是根据文本中的更改计算插入符号的新位置，并返回该位置。

^返回索引

MoveCustomLinks

private void MoveCustomLinks()
{
    int lengthDiff = 0;
    if (OldLength != 0)
    {
        lengthDiff = this.Text.Length - OldLength;
    }

    if (hyperlinks.Any() && lengthDiff != 0)
    {
        var keysToUpdate = new List<KeyValuePair<int, int>>();

        foreach (var entry in hyperlinks)
        {
            keysToUpdate.Add(entry.Key);
        }

        foreach (var keyToUpdate in keysToUpdate)
        {
            var value = hyperlinks[keyToUpdate];
            int newKey;
            if (this.SelectionStart <= keyToUpdate.Key + lengthDiff)
            {
                newKey = keyToUpdate.Key + lengthDiff;
            }
            else
            {
                newKey = keyToUpdate.Key;
            }

            hyperlinks.Remove(keyToUpdate);
            hyperlinks.Add(new KeyValuePair<int, int>(newKey, keyToUpdate.Value), value);
        }
    }
    OldLength = this.Text.Length;
}

现在我们已经通过用友好文本替换自定义链接的完整格式来更改了文本的长度，因此有必要重新计算每个自定义链接的位置。

此方法执行此操作。

• 首先，它使用变量 OldLength 作为参考来计算替换引起的差异。
  • ^{（注意：如果 OldLength 为零，则表示之前没有文本，现在有文本，因此我们不更改 lengthDiff 的默认值。）}
  • 我们仅在以下情况下进行任何重新计算：

1. 存在任何自定义链接
2. lengthDiff 不为零，即文本已更改。

• 我们将每个 hyperlinks key（此处每个key都是一个 KeyValuePair）的副本复制到一个列表（keysToUpdate）。
• 然后，对于 keysToUpdate 中的每个项目，我们将重新计算该项目的key，但前提是文本中的更改是在项目**之前**的位置进行的（考虑到 lengthDiff）。
• 最后，我们从字典中移除过时的 entry，并添加一个具有重新计算值的新条目，并将文本的当前长度设置为 OldLength 值。

^返回索引

RemoveLinks

private void RemoveLinks()
{
    this.SelectAll();
    this.SelectionProtected = false;
    this.SetSelectionStyle(CFM_LINK, 0);
}

此方法非常简单。它只是选择所有文本，移除可能存在的任何保护（即，如果存在任何自定义链接），并移除所有文本的链接效果。

这样，所有链接都消失了。所以现在，我们需要再次搜索链接。

^返回索引

CheckNormalLinks

private void CheckNormalLinks()
{
    if (normalLinks.Matches(this.Text).Cast<Match>().Any())
    {
        var linksNormal = normalLinks.Matches(this.Text).Cast<Match>().Select(n => n).ToList();
        foreach (var item in linksNormal)
        {
            this.Select(item.Index, item.Length);
            this.SetSelectionStyle(CFM_LINK, CFE_LINK);
        }
    }
}

此方法解析文本以查找匹配 normalLinks 正则表达式的任何文本。

• 如果找到，它将把任何 Match 存储在局部变量（List）linksNormal 中。
• 对于 linksNormal 的每个元素，它会：
  • 选择文本
  • 使用 SetSelectionStyle 方法设置链接效果。

^返回索引

CheckMailLinks

private void CheckMailLinks()
{
    if (mailLinks.Matches(this.Text).Cast<Match>().Any())
    {
        var linksMail = mailLinks.Matches(this.Text).Cast<Match>().Select(n => n).ToList();
        foreach (var item in linksMail)
        {
            this.Select(item.Index, item.Length);
            this.SetSelectionStyle(CFM_LINK, CFE_LINK);
        }
    }
}

此方法解析文本以查找匹配 mailLinks 正则表达式的任何文本。

• 如果找到，它将把任何 Match 存储在局部变量（List）linksMail 中。
• 对于 linksMail 的每个元素，它会：
  • 选择文本
  • 使用 SetSelectionStyle 方法设置链接效果。

^返回索引

CheckIPLinks

private void CheckIPLinks()
{
    if (IPLinks.Matches(this.Text).Cast<Match>().Any())
    {
        var linksIP = IPLinks.Matches(this.Text).Cast<Match>().Select(n => n).ToList();
        foreach (var item in linksIP)
        {
            this.Select(item.Index, item.Length);
            this.SetSelectionStyle(CFM_LINK, CFE_LINK);
        }
    }
}

此方法解析文本以查找匹配 IPLinks 正则表达式的任何文本。

• 如果找到，它将把任何 Match 存储在局部变量（List）linksIP 中。
• 对于 linksIP 的每个元素，它会：
  • 选择文本
  • 使用 SetSelectionStyle 方法设置链接效果。

^返回索引

RefreshCustomLinks

private void RefreshCustomLinks()
{
    foreach (var item in hyperlinks.Keys)
    {
        this.Select(item.Key, item.Value);
        this.SetSelectionStyle(CFM_LINK, CFE_LINK);
        this.SelectionProtected = true;
    }
}

此方法将恢复自定义链接。

• 它会查看 hyperlinks 字典，并为每个 entry 使用 key 来选择链接文本。
• 然后它使用 SetSelectionStyle 方法设置链接效果。
• 最后，它将选择设置为受保护文本，以便我们知道用户何时想要修改/删除自定义链接。

^返回索引

结论

这就是我的解决方案。我知道可能还有更好的方法来做我在这里做的事情。毕竟，我不是 C# 编程专家。

而且我知道肯定有更好的方法来解释它！但我的英语不是母语，而且我比老师更擅长编程（略有）。

所以，如果您有任何评论或建议，或者如果您发现任何错误（英语语法/句法 || C# 语法/句法 :）），请告诉我！在下面的评论区发表评论，或在 GitHub 上的项目页面打开一个 issue。

历史

• 08/10/2014

          初始版本。