Passo a passo: criar um glifo de margem

Você pode personalizar a aparência das margens do editor usando extensões personalizadas do editor. Este passo a passo coloca um glifo personalizado na margem do indicador sempre que a palavra "todo" aparece em um comentário de código.

Criar um projeto do MEF

Crie um projeto VSIX em C#. (Na caixa de diálogo Novo Projeto , selecione Visual C#/Extensibilidade e, em seguida, Projeto VSIX.) Nomeie a solução TodoGlyphTest.
Adicionar um item de projeto do Classificador de Editor. Para obter mais informações, consulte Criar uma extensão com um modelo de item do editor.
Exclua os arquivos de classe existentes.

Definir o glifo

Defina um glifo executando a IGlyphFactory interface.

Para definir o glifo

Adicione um arquivo de classe e nomeie-o TodoGlyphFactory.

Adicione o código a seguir usando declarações.

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;

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

Adicione uma classe chamada TodoGlyphFactory que implementa IGlyphFactory.

internal class TodoGlyphFactory : IGlyphFactory

Friend Class TodoGlyphFactory
    Implements IGlyphFactory

Adicione um campo privado que define as dimensões do glifo.

const double m_glyphSize = 16.0;

Const m_glyphSize As Double = 16.0

Implemente GenerateGlyph definindo o elemento de interface do usuário do glifo. TodoTag é definido posteriormente neste passo a passo.

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;
}

Public Function GenerateGlyph(ByVal line As IWpfTextViewLine, ByVal tag As IGlyphTag) As System.Windows.UIElement Implements IGlyphFactory.GenerateGlyph
    ' Ensure we can draw a glyph for this marker.
    If tag Is Nothing OrElse Not (TypeOf tag Is TodoTag) Then
        Return Nothing
    End If

    Dim ellipse As Ellipse = New Ellipse()
    ellipse.Fill = Brushes.LightBlue
    ellipse.StrokeThickness = 2
    ellipse.Stroke = Brushes.DarkBlue
    ellipse.Height = m_glyphSize
    ellipse.Width = m_glyphSize

    Return ellipse

End Function

Adicione uma classe chamada TodoGlyphFactoryProvider que implementa IGlyphFactoryProvider. Exporte esta classe com um NameAttribute de "TodoGlyph", um OrderAttribute de After VsTextMarker, um ContentTypeAttribute de "code" e um TagTypeAttribute de TodoTag.

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

<Export(GetType(IGlyphFactoryProvider)), Name("TodoGlyph"), Order(After:="VsTextMarker"), ContentType("code"), TagType(GetType(TodoTag))>
Friend NotInheritable Class TodoGlyphFactoryProvider
    Implements IGlyphFactoryProvider

Implemente o GetGlyphFactory método criando uma instância do TodoGlyphFactory.

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

Public Function GetGlyphFactory(ByVal view As IWpfTextView, ByVal margin As IWpfTextViewMargin) As IGlyphFactory Implements IGlyphFactoryProvider.GetGlyphFactory
    Return New TodoGlyphFactory()
End Function

Definir uma tag Todo e um marcador

Defina a relação entre o elemento de interface do usuário que você definiu nas etapas anteriores e a margem do indicador. Crie um tipo de marca e um marcador e exporte-o usando um provedor de marcação.

Para definir uma etiqueta de tarefas e uma ferramenta de marcação

Adicione um novo arquivo de classe ao projeto e nomeie-o TodoTagger.

Adicione as seguintes importações.

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;

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

Adicionar uma classe chamada TodoTag.

internal class TodoTag : IGlyphTag

Friend Class TodoTag
    Implements IGlyphTag

    Public Sub New()
        MyBase.New()
    End Sub
End Class

Modifique a classe nomeada TodoTagger que implementa ITagger<T> do tipo TodoTag.

internal class TodoTagger : ITagger<TodoTag>

Friend Class TodoTagger
    Implements ITagger(Of TodoTag)

Para a classe TodoTagger, adicione campos privados para IClassifier e para o texto a ser localizado nos intervalos de classificação.

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

Private m_classifier As IClassifier
Private Const m_searchText As String = "todo"

Adicione um construtor que define o classificador.

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

Friend Sub New(ByVal classifier As IClassifier)
    m_classifier = classifier
End Sub

Implemente o GetTags método encontrando todos os intervalos de classificação cujos nomes incluem a palavra "comentário" e cujo texto inclui o texto de pesquisa. Sempre que o texto da pesquisa for encontrado, retorne um novo TagSpan<T> tipo 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());
                }
            }
        }
    }
}

Private Function GetTags(ByVal spans As NormalizedSnapshotSpanCollection) As IEnumerable(Of ITagSpan(Of TodoTag)) Implements ITagger(Of TodoTag).GetTags
    Dim list As List(Of ITagSpan(Of TodoTag))
    list = New List(Of ITagSpan(Of TodoTag))()

    For Each span As SnapshotSpan In spans
        'look at each classification span \
        For Each classification As ClassificationSpan In m_classifier.GetClassificationSpans(span)
            'if the classification is a comment
            If classification.ClassificationType.Classification.ToLower().Contains("comment") Then
                'if the word "todo" is in the comment,
                'create a new TodoTag TagSpan
                Dim index As Integer = classification.Span.GetText().ToLower().IndexOf(m_searchText)
                If index <> -1 Then
                    list.Add(New TagSpan(Of TodoTag)(New SnapshotSpan(classification.Span.Start + index, m_searchText.Length), New TodoTag()))
                End If
            End If
        Next classification
    Next span

    Return list
End Function

Declare um evento TagsChanged.

public event EventHandler<SnapshotSpanEventArgs> TagsChanged;

Public Event TagsChanged(ByVal sender As Object, ByVal e As Microsoft.VisualStudio.Text.SnapshotSpanEventArgs) Implements Microsoft.VisualStudio.Text.Tagging.ITagger(Of TodoTag).TagsChanged

Adicione uma classe nomeada TodoTaggerProvider que implementa ITaggerProvider, e exporte-a com um ContentTypeAttribute "código" e um TagTypeAttribute TodoTag.

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

<Export(GetType(ITaggerProvider)), ContentType("code"), TagType(GetType(TodoTag))>
Friend Class TodoTaggerProvider
    Implements ITaggerProvider

Importe o IClassifierAggregatorService.

[Import]
internal IClassifierAggregatorService AggregatorService;

<Import()>
Friend AggregatorService As IClassifierAggregatorService

Implemente o método CreateTagger instanciando o 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>;
}

Public Function CreateTagger(Of T As Microsoft.VisualStudio.Text.Tagging.ITag)(ByVal buffer As Microsoft.VisualStudio.Text.ITextBuffer) As Microsoft.VisualStudio.Text.Tagging.ITagger(Of T) Implements Microsoft.VisualStudio.Text.Tagging.ITaggerProvider.CreateTagger
    If buffer Is Nothing Then
        Throw New ArgumentNullException("buffer")
    End If

    Return TryCast(New TodoTagger(AggregatorService.GetClassifier(buffer)), ITagger(Of T))
End Function

Compilar e testar o código

Para testar esse código, crie a solução TodoGlyphTest e execute-a na instância experimental.

Para criar e testar a solução TodoGlyphTest

Crie a solução.
Execute o projeto pressionando F5. Uma segunda instância do Visual Studio é iniciada.
Verifique se a margem do indicador está sendo exibida.

No painel Ferramentas >Opções, na seção Texto > Editor >Geral >Exibição de Todas as Configurações, confirme se a caixa de seleção Mostrar margem de indicador está selecionada.

Na caixa de diálogo Ferramentas>Opções, na seção Editor de Texto>Geral>Exibição, confirme se a caixa de seleção margem de indicador está marcada.
Abra um arquivo de código que tenha comentários. Adicione a palavra "todo" em uma das seções de comentários.
Um círculo azul claro com um contorno azul escuro aparece na margem indicadora à esquerda da janela de código.

Last updated on 2025-12-12

Compartilhar via