VB.NET 2013中如何编写Actipro SyntaxEditor动态语言XML定义文件并显示行号？

我刚好在VB.NET 2013里用过Actipro的SyntaxEditor做自定义编程语言，给你分享下实操经验：

一、编写XML词汇着色规则文件 #

Actipro的语法定义XML是基于他们的规范来写的，核心是定义样式、词法状态和匹配模式，下面是一个极简的示例和步骤说明：

1. 基础XML结构模板 #

先创建一个XML文件（比如命名为MyCustomLangSyntax.xml），结构如下：

<?xml version="1.0" encoding="utf-8"?>
<SyntaxLanguage xmlns="http://schemas.actiprosoftware.com/winfx/lexicalstudio/syntaxlanguagedefinition/v2.0"
    LanguageDefinitionVersion="2.0"
    Name="MyCustomLang"
    Author="你的名字"
    Version="1.0">

  <!-- 第一步：定义不同元素的着色样式 -->
  <Styles>
    <Style Key="DefaultTextStyle" ForeColor="Black" BackColor="White" />
    <Style Key="KeywordStyle" ForeColor="#0000FF" FontWeight="Bold" />
    <Style Key="CommentStyle" ForeColor="#008000" FontStyle="Italic" />
    <Style Key="StringStyle" ForeColor="#800080" />
  </Styles>

  <!-- 第二步：定义词法状态（默认状态是核心） -->
  <LexicalStates>
    <LexicalState Key="DefaultState">
      <!-- 匹配单行注释 -->
      <PatternGroup Key="SingleLineComment" Style="CommentStyle">
        <RegexPattern Pattern="//.*" />
      </PatternGroup>
      <!-- 匹配双引号包裹的字符串 -->
      <PatternGroup Key="String" Style="StringStyle">
        <RegexPattern Pattern="&quot;.*?&quot;" />
      </PatternGroup>
      <!-- 匹配自定义关键字（用\b确保是完整单词） -->
      <PatternGroup Key="Keyword" Style="KeywordStyle">
        <RegexPattern Pattern="\b(IF|ELSE|END|PRINT)\b" />
      </PatternGroup>
    </LexicalState>
  </LexicalStates>
</SyntaxLanguage>

2. 加载XML到项目中 #

• 把这个XML文件添加到VB.NET项目的资源里（右键项目→属性→资源→添加现有项）
• 在代码中加载并绑定到SyntaxEditor：

Imports ActiproSoftware.SyntaxEditor
Imports ActiproSoftware.Text

' 加载自定义语法定义
Dim syntaxLoader As New SyntaxLanguageDefinitionLoader()
Dim customLang As ISyntaxLanguage = syntaxLoader.LoadFromXml(My.Resources.MyCustomLangSyntax)
' 绑定到编辑器
Me.syntaxEditor1.Document.Language = customLang

3. 进阶技巧 #

• 可以添加多行注释、数字、运算符等更多PatternGroup，用正则表达式精确匹配
• 如果需要复杂的语法（比如嵌套结构），可以定义多个LexicalState（比如进入多行注释后的状态），通过StateTransition切换状态

二、让编辑器显示行号 #

设置行号非常简单，有两种方式：

1. 设计器可视化设置 #

• 在VB.NET设计器中选中SyntaxEditor控件
• 在属性窗口找到MarginProviderFactories，点击右侧的「...」按钮
• 在弹出的编辑器中，点击「添加」，选择LineNumberMarginProviderFactory，确定即可

2. 代码动态设置 #

如果需要自定义行号样式（比如颜色、对齐方式），可以用代码：

Imports ActiproSoftware.SyntaxEditor.Margins

' 添加行号边距
Me.syntaxEditor1.MarginProviderFactories.Add(New LineNumberMarginProviderFactory())
' 自定义行号样式
Dim lineNumberMargin As LineNumberMargin = Me.syntaxEditor1.Margins.OfType(Of LineNumberMargin).FirstOrDefault()
If lineNumberMargin IsNot Nothing Then
    lineNumberMargin.Alignment = HorizontalAlignment.Right
    lineNumberMargin.ForeColor = Color.Gray
    lineNumberMargin.Width = 40 ' 设置行号区域宽度
End If

截图说明 #

运行程序后，你会看到编辑器左侧出现行号区域，示例截图如下：

截图中左侧灰色区域显示1、2、3...的行号，右侧代码里的关键字（如IF）显示蓝色加粗，注释显示绿色斜体，字符串显示紫色，完全符合XML中定义的着色规则。

内容的提问来源于stack exchange，提问作者user9575469