VSIX开发求助：DTE实现光标处单词高亮选中（非暗淡）

我在维护一个VSIX扩展，尝试通过DTE实现光标所在单词的选中功能。当前编写的SelectWordAtCursor函数虽能选中目标单词，但选中状态呈暗淡显示，几乎难以辨识，无法达到鼠标选中时的高亮效果，期望实现与鼠标选中一致的正常高亮选中状态。

当前代码：

public static void SelectWordAtCursor()
{
  Microsoft.VisualStudio.Shell.ThreadHelper.ThrowIfNotOnUIThread();

  Document doc = Distributor.m_dte.ActiveDocument;
  if (doc == null)
      throw new Exception("No open document found");

  TextSelection selection = (TextSelection)doc.Selection;
  if (selection == null)
      throw new Exception("No selection found");

  // Move the cursor to the beginning of the word
  selection.WordLeft();
  int startOffset = selection.AnchorPoint.AbsoluteCharOffset;

  // Move the cursor to the end of the word
  selection.WordRight();
  int endOffset = selection.ActivePoint.AbsoluteCharOffset;

  // Set the selection to the word
  selection.MoveToAbsoluteOffset(startOffset);
  selection.MoveToAbsoluteOffset(endOffset,true);
}

解决方案 #

方案1：优化DTE代码逻辑，触发正确的UI高亮

原有代码通过计算偏移量设置选择的方式，可能没有正确触发编辑器的主选择状态，导致显示为暗淡的临时高亮。可以直接使用TextSelection的带选中参数的方法，并确保编辑器获得焦点：

public static void SelectWordAtCursor()
{
    Microsoft.VisualStudio.Shell.ThreadHelper.ThrowIfNotOnUIThread();

    Document doc = Distributor.m_dte.ActiveDocument;
    if (doc == null)
        throw new Exception("No open document found");

    TextSelection selection = (TextSelection)doc.Selection;
    if (selection == null)
        throw new Exception("No selection found");

    // 直接选中当前光标所在的单词
    selection.WordLeft(true); // true参数表示移动时选中内容
    selection.WordRight(true);

    // 激活文档确保编辑器聚焦，触发高亮更新
    doc.Activate();
}

方案2：使用现代Visual Studio编辑器API（MEF）

DTE是较旧的兼容性API，在UI同步上可能存在局限。使用基于MEF的现代编辑器API可以直接操作编辑器的主选择，完全匹配鼠标选中的高亮效果：

using Microsoft.VisualStudio.Text;
using Microsoft.VisualStudio.Text.Editor;
using Microsoft.VisualStudio.Shell;

public static void SelectWordAtCursor()
{
    ThreadHelper.ThrowIfNotOnUIThread();

    ITextView textView = GetActiveTextView();
    if (textView == null)
        throw new Exception("No active text view found");

    SnapshotPoint caretPos = textView.Caret.Position.BufferPosition;
    // 获取光标所在单词的范围
    TextExtent wordExtent = caretPos.GetWordExtent(WordExtentOptions.IncludeWord);
    if (!wordExtent.IsSignificant)
        return;

    // 设置编辑器主选择
    textView.Selection.Select(wordExtent.Span, false);
    // 将光标移动到选择末尾，匹配鼠标选中行为
    textView.Caret.MoveTo(wordExtent.Span.End);
    // 确保视图获得焦点
    textView.VisualElement.Focus();
}

private static ITextView GetActiveTextView()
{
    ThreadHelper.ThrowIfNotOnUIThread();
    var dte = Package.GetGlobalService(typeof(EnvDTE.DTE)) as EnvDTE.DTE;
    return dte?.ActiveDocument?.Object("TextDocument") as ITextView;
}

说明 #

• 方案1基于原有DTE逻辑调整，无需引入新的依赖，适合简单场景。
• 方案2使用现代编辑器API，能完全对齐原生选中的高亮状态，是更推荐的长期解决方案。

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