Przewodnik: tworzenie glyph 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

1. Utwórz projekt VSIX w języku C#. (W Okno dialogowe Nowy projekt , wybierz pozycję Visual C# / Rozszerzalność, a następnie projekt VSIX. Nadaj rozwiązaniu TodoGlyphTestnazwę .

2. Dodaj element projektu Klasyfikator edytora. Aby uzyskać więcej informacji, zobacz Tworzenie rozszerzenia za pomocą szablonu elementu edytora.

3. Usuń istniejące pliki klas.

Definiowanie glifów

Zdefiniuj glif, uruchamiając IGlyphFactory interfejs.

Aby zdefiniować glif

1. Dodaj plik klasy i nadaj mu TodoGlyphFactorynazwę .

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

   C#

   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;
   

   VB

   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
   

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

   C#

   internal class TodoGlyphFactory : IGlyphFactory
   

   VB

   Friend Class TodoGlyphFactory
       Implements IGlyphFactory
   

4. Dodaj pole prywatne, które definiuje wymiary glif.

   C#

   const double m_glyphSize = 16.0;
   

   VB

   Const m_glyphSize As Double = 16.0
   

5. Zaimplementuj GenerateGlyph , definiując element interfejsu użytkownika (UI). TodoTag program jest zdefiniowany w dalszej części tego przewodnika.

   C#

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

   VB

   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
   

6. Dodaj klasę o nazwie TodoGlyphFactoryProvider , która implementuje IGlyphFactoryProviderelement . Wyeksportuj tę klasę z wartością NameAttribute "TodoGlyph", wartością OrderAttribute After VsTextMarker, znakiem "code" i elementem ContentTypeAttribute TagTypeAttribute TodoTag.

   C#

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

   VB

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

7. Zaimplementuj metodę GetGlyphFactory , tworząc TodoGlyphFactorywystąpienie klasy .

   C#

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

   VB

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

Definiowanie tagu zadań do wykonania i sztyletu

Zdefiniuj relację między elementem interfejsu użytkownika zdefiniowanym w poprzednich krokach i marginesem wskaźnika. Utwórz typ tagu i element tagger i wyeksportuj go przy użyciu dostawcy tagger.

Aby zdefiniować tag zadań do wykonania i sztylet

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

2. Dodaj następujące importy.

   C#

   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;
   

   VB

   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
   

3. Dodaj klasę o nazwie TodoTag.

   C#

   internal class TodoTag : IGlyphTag
   

   VB

   Friend Class TodoTag
       Implements IGlyphTag
   
       Public Sub New()
           MyBase.New()
       End Sub
   End Class
   

4. Zmodyfikuj klasę o nazwie TodoTagger , która implementuje ITagger<T> typ TodoTag.

   C#

   internal class TodoTagger : ITagger<TodoTag>
   

   VB

   Friend Class TodoTagger
       Implements ITagger(Of TodoTag)
   

5. TodoTagger W klasie dodaj pola prywatne dla elementu IClassifier i dla tekstu, aby znaleźć je w zakresach klasyfikacji.

   C#

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

   VB

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

6. Dodaj konstruktor, który ustawia klasyfikator.

   C#

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

   VB

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

7. 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.

   C#

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

   VB

   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
   

8. Zadeklaruj TagsChanged zdarzenie.

   C#

   public event EventHandler<SnapshotSpanEventArgs> TagsChanged;
   

   VB

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

9. Dodaj klasę o nazwie TodoTaggerProvider , która implementuje ITaggerProviderelement , i wyeksportuj go za pomocą ContentTypeAttribute elementu "code" i elementu TagTypeAttribute TodoTag.

   C#

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

   VB

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

10. Zaimportuj plik IClassifierAggregatorService.

    C#

    [Import]
    internal IClassifierAggregatorService AggregatorService;
    

    VB

    <Import()>
    Friend AggregatorService As IClassifierAggregatorService
    

11. Zaimplementuj metodę CreateTagger , tworząc TodoTaggerwystąpienie klasy .

    C#

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

    VB

    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

1. Stwórz rozwiązanie.

2. Uruchom projekt, naciskając klawisz F5. Zostanie uruchomione drugie wystąpienie programu Visual Studio.

3. Upewnij się, że margines wskaźnika jest wyświetlany. (Na stronie Menu Narzędzia , kliknij pozycję Opcje. Na stronie Edytor tekstów upewnij się, że wybrano margines wskaźnika).

4. Otwórz plik kodu zawierający komentarze. Dodaj słowo "todo" do jednej z sekcji komentarzy.

5. Jasnoniebieski okrąg z ciemnoniebieskim konturem pojawia się na marginesie wskaźnika po lewej stronie okna kodu.