Przewodnik: Utworzenie glifu marginesu

Wygląd marginesów edytora można dostosować przy użyciu niestandardowych rozszerzeń edytora. Ten przewodnik umieszcza niestandardowy glyph na marginesie wskaźnika za każdym razem, gdy słowo "todo" pojawia się w komentarzu kodu.

Tworzenie projektu MEF

Utwórz projekt VSIX w języku C#. (W oknie dialogowym Nowy projekt wybierz pozycję Visual C# / Rozszerzalność, a następnie projekt VSIX). Nadaj rozwiązaniu TodoGlyphTestnazwę .
Dodaj element projektu Klasyfikator edytora. Aby uzyskać więcej informacji, zobacz Tworzenie rozszerzenia za pomocą szablonu elementu edytora.
Usuń istniejące pliki klas.

Definiowanie glifów

Zdefiniuj glif, uruchamiając IGlyphFactory interfejs.

Aby zdefiniować glif

Dodaj plik klasy i nadaj mu TodoGlyphFactorynazwę .

Dodaj następujący kod przy użyciu deklaracji.

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

Dodaj klasę o nazwie TodoGlyphFactory, która implementuje IGlyphFactory.

internal class TodoGlyphFactory : IGlyphFactory

Friend Class TodoGlyphFactory
    Implements IGlyphFactory

Dodaj pole prywatne, które definiuje wymiary glif.

const double m_glyphSize = 16.0;

Const m_glyphSize As Double = 16.0

Zaimplementuj GenerateGlyph , definiując element interfejsu użytkownika (UI). TodoTag zostanie zdefiniowany później w ramach tego przewodnika.

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

Dodaj klasę o nazwie TodoGlyphFactoryProvider, która implementuje IGlyphFactoryProvider. Wyeksportuj tę klasę z wartością NameAttribute "TodoGlyph", wartością OrderAttribute After VsTextMarker, znakiem "code" i elementem ContentTypeAttribute TagTypeAttribute 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

Zaimplementuj metodę GetGlyphFactory tworząc wystąpienie klasy 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

Definiowanie tagu Todo i oznaczacza.

Zdefiniuj relację między elementem interfejsu użytkownika zdefiniowanym w poprzednich krokach i marginesem wskaźnika. Utwórz typ tagu oraz narzędzie tagujące i wyeksportuj je za pomocą dostawcy narzędzi tagujących.

Aby zdefiniować tag do zadań i tagger

Dodaj nowy plik klasy do projektu i nadaj mu TodoTaggernazwę .

Dodaj następujące importy.

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

Dodaj klasę o nazwie TodoTag.

internal class TodoTag : IGlyphTag

Friend Class TodoTag
    Implements IGlyphTag

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

Zmodyfikuj klasę TodoTagger , która implementuje ITagger<T> typu TodoTag.

internal class TodoTagger : ITagger<TodoTag>

Friend Class TodoTagger
    Implements ITagger(Of TodoTag)

W klasie TodoTagger dodaj pola prywatne dla IClassifier oraz dla tekstu, który ma być znaleziony w zakresach klasyfikacji.

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

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

Dodaj konstruktor, który ustawia klasyfikator.

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

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

Zaimplementuj metodę GetTags , wyszukując wszystkie zakresy klasyfikacji, których nazwy zawierają wyraz "komentarz" i którego tekst zawiera tekst wyszukiwania. Za każdym razem, gdy tekst wyszukiwania zostanie znaleziony, wróć do nowego TagSpan<T> typu 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

Zadeklaruj TagsChanged zdarzenie.

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

Dodaj klasę o nazwie TodoTaggerProvider, która implementuje ITaggerProvider, i wyeksportuj ją z ContentTypeAttribute "code" oraz 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

Zaimportuj plik IClassifierAggregatorService.

[Import]
internal IClassifierAggregatorService AggregatorService;

<Import()>
Friend AggregatorService As IClassifierAggregatorService

Zaimplementuj metodę CreateTagger, tworząc wystąpienie klasy 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

Kompilowanie i testowanie kodu

Aby przetestować ten kod, skompiluj rozwiązanie TodoGlyphTest i uruchom je w wystąpieniu eksperymentalnym.

Aby skompilować i przetestować rozwiązanie TodoGlyphTest

Skompiluj rozwiązanie.
Uruchom projekt, naciskając F5. Druga instancja programu Visual Studio uruchamia się.
Upewnij się, że margines wskaźnika jest wyświetlany.

W okienku Narzędzia>Opcje, w sekcji wszystkie ustawienia>Edytor tekstu>Ogólne>Wyświetlanie, upewnij się, że zaznaczono pole wyboru Pokaż margines wskaźnika.

W oknie dialogowym Narzędzia>Opcje, w sekcji Edytor tekstu>Ogólne>Wyświetlanie, upewnij się, że zaznaczono pole wyboru Margines wskaźnika.
Otwórz plik kodu zawierający komentarze. Dodaj słowo "todo" do jednej z sekcji komentarzy.
Jasnoniebieski okrąg z ciemnoniebieskim konturem pojawia się na marginesie wskaźnika po lewej stronie okna kodu.

Last updated on 2025-12-12

Udostępnij przez