演练：创建边距字形

  • 项目

可以使用自定义编辑器扩展自定义编辑器边距的外观。 每当代码注释中出现“todo”一词时，本演练都会将自定义标志符号放在指示器边距上。

创建 MEF 项目

  1. 创建 C# VSIX 项目。 （在 “新建项目 ”对话框，选择 Visual C# /扩展性，然后选择 VSIX Project。）将解决方案 TodoGlyphTest命名为 。

  2. 添加编辑器分类器项目项。 有关详细信息，请参阅使用编辑器项模板创建扩展。

  3. 删除现有的类文件。

定义字形

通过运行 IGlyphFactory 接口来定义字形。

定义字形

  1. 添加一个类文件并将其命名为 TodoGlyphFactory。

  2. 使用声明添加以下代码。

    using System.ComponentModel.Composition;
using System.Windows;
using System.Windows.Shapes;
using System.Windows.Media;
using System.Windows.Controls;
using Microsoft.VisualStudio.Text;
using Microsoft.VisualStudio.Text.Editor;
using Microsoft.VisualStudio.Text.Formatting;
using Microsoft.VisualStudio.Text.Tagging;
using Microsoft.VisualStudio.Utilities;

  3. 添加一个名为 TodoGlyphFactory 实现的 IGlyphFactory类。

    internal class TodoGlyphFactory : IGlyphFactory

  4. 添加一个专用字段，用于定义字形的尺寸。

    const double m_glyphSize = 16.0;

  5. 通过定义字形用户界面 （UI） 元素来实现 GenerateGlyph 。 TodoTag 在本演练的后面部分定义。

    public UIElement GenerateGlyph(IWpfTextViewLine line, IGlyphTag tag)
{
    // Ensure we can draw a glyph for this marker.
    if (tag == null || !(tag is TodoTag))
    {
        return null;
    }

    System.Windows.Shapes.Ellipse ellipse = new Ellipse();
    ellipse.Fill = Brushes.LightBlue;
    ellipse.StrokeThickness = 2;
    ellipse.Stroke = Brushes.DarkBlue;
    ellipse.Height = m_glyphSize;
    ellipse.Width = m_glyphSize;

    return ellipse;
}

  6. 添加一个名为 TodoGlyphFactoryProvider 实现的 IGlyphFactoryProvider类。 使用NameAttribute“TodoGlyph”、After VsTextMarkerContentTypeAttribute、OrderAttribute“code”和 TagTypeAttribute TodoTag 的类导出。

    [Export(typeof(IGlyphFactoryProvider))]
[Name("TodoGlyph")]
[Order(After = "VsTextMarker")]
[ContentType("code")]
[TagType(typeof(TodoTag))]
internal sealed class TodoGlyphFactoryProvider : IGlyphFactoryProvider

  7. GetGlyphFactory通过实例化TodoGlyphFactory方法实现该方法。

    public IGlyphFactory GetGlyphFactory(IWpfTextView view, IWpfTextViewMargin margin)
{
    return new TodoGlyphFactory();
}

定义 Todo 标记和标记器

定义在前面的步骤中定义的 UI 元素与指示器边距之间的关系。 使用标记器提供程序创建标记类型和标记器并将其导出。

定义待办事项标记和标记器

  1. 向项目添加新类文件并将其命名 TodoTagger。

  2. 添加以下 import 语句。

    using System;
using System.Collections.Generic;
using System.ComponentModel.Composition;
using Microsoft.VisualStudio.Text;
using Microsoft.VisualStudio.Text.Tagging;
using Microsoft.VisualStudio.Text.Editor;
using Microsoft.VisualStudio.Text.Classification;
using Microsoft.VisualStudio.Utilities;

  3. 添加名为的 TodoTag 的类。

    internal class TodoTag : IGlyphTag

  4. 修改名为 TodoTagger 实现 ITagger<T> 类型的 TodoTag类。

    internal class TodoTagger : ITagger<TodoTag>

  5. 在类中 TodoTagger ，为一个 IClassifier 和文本添加专用字段，以便在分类范围中找到这些字段。

    private IClassifier m_classifier;
private const string m_searchText = "todo";

  6. 添加设置分类器的构造函数。

    internal TodoTagger(IClassifier classifier)
{
    m_classifier = classifier;
}

  7. GetTags通过查找名称包括单词“comment”且其文本包括搜索文本的所有分类范围来实现该方法。 只要找到搜索文本，请返回新 TagSpan<T> 类型 TodoTag。

    IEnumerable<ITagSpan<TodoTag>> ITagger<TodoTag>.GetTags(NormalizedSnapshotSpanCollection spans)
{
    foreach (SnapshotSpan span in spans)
    {
        //look at each classification span \
        foreach (ClassificationSpan classification in m_classifier.GetClassificationSpans(span))
        {
            //if the classification is a comment
            if (classification.ClassificationType.Classification.ToLower().Contains("comment"))
            {
                //if the word "todo" is in the comment,
                //create a new TodoTag TagSpan
                int index = classification.Span.GetText().ToLower().IndexOf(m_searchText);
                if (index != -1)
                {
                    yield return new TagSpan<TodoTag>(new SnapshotSpan(classification.Span.Start + index, m_searchText.Length), new TodoTag());
                }
            }
        }
    }
}

  8. 声明事件 TagsChanged 。

    public event EventHandler<SnapshotSpanEventArgs> TagsChanged;

  9. 添加一个名为TodoTaggerProvider实现ITaggerProvider的类，并使用“代码”和 TagTypeAttribute TodoTag 导出它ContentTypeAttribute。

    [Export(typeof(ITaggerProvider))]
[ContentType("code")]
[TagType(typeof(TodoTag))]
class TodoTaggerProvider : ITaggerProvider

  10. 导入 IClassifierAggregatorService。

    [Import]
internal IClassifierAggregatorService AggregatorService;

  11. CreateTagger通过实例化TodoTagger方法实现该方法。

    public ITagger<T> CreateTagger<T>(ITextBuffer buffer) where T : ITag
{
    if (buffer == null)
    {
        throw new ArgumentNullException("buffer");
    }

    return new TodoTagger(AggregatorService.GetClassifier(buffer)) as ITagger<T>;
}

生成并测试代码

若要测试此代码，请生成 TodoGlyphTest 解决方案并在实验实例中运行它。

生成和测试 TodoGlyphTest 解决方案

  1. 生成解决方案。

  2. 按 F5 运行项目。 Visual Studio 的第二个实例启动。

  3. 确保显示指示器边距。 （On the 工具 菜单，单击“ 选项”。在 “文本编辑器” 页上，确保 已选择指示器边距 。

  4. 打开包含注释的代码文件。 将“todo”一词添加到注释部分之一。

  5. 带有深蓝色轮廓的浅蓝色圆圈显示在代码窗口左侧的指示器边距中。