Exemplarische Vorgehensweise: Erstellen einer Randglyphe

Sie können die Darstellung von Editor-Seitenrändern mithilfe von benutzerdefinierten Editorerweiterungen anpassen. In dieser exemplarischen Vorgehensweise wird eine benutzerdefinierte Glyphe am Indikatorrand platziert, wenn das Wort "todo" in einem Codekommentar angezeigt wird.

Erstellen eines MEF-Projekts

1. Erstellen Sie ein C#VSIX-Projekt. (Im Dialogfeld "Neues Projekt ", wählen Sie Visual C# / Erweiterbarkeit und dann VSIX-Projekt aus.) Benennen Sie die Lösung TodoGlyphTest.

2. Fügen Sie ein Editor-Klassifiziererprojektelement hinzu. Weitere Informationen finden Sie unter Erstellen einer Erweiterung mit einer Editorelementvorlage.

3. Löschen Sie die vorhandenen Klassendateien.

Definieren der Glyphe

Definieren Sie eine Glyphe, indem Sie die IGlyphFactory Schnittstelle ausführen.

So definieren Sie die Glyphe

1. Fügen Sie eine Klassendatei hinzu, und nennen Sie sie TodoGlyphFactory.

2. Fügen Sie den folgenden Code mithilfe von Deklarationen hinzu.

   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. Fügen Sie eine Klasse mit dem Namen TodoGlyphFactory hinzu, die implementiert IGlyphFactorywird.

   C#

   internal class TodoGlyphFactory : IGlyphFactory
   

   VB

   Friend Class TodoGlyphFactory
       Implements IGlyphFactory
   

4. Fügen Sie ein privates Feld hinzu, das die Dimensionen der Glyphe definiert.

   C#

   const double m_glyphSize = 16.0;
   

   VB

   Const m_glyphSize As Double = 16.0
   

5. Implementieren Sie GenerateGlyph das Glyphen-Benutzeroberflächenelement (UI). TodoTag wird weiter unten in dieser exemplarischen Vorgehensweise definiert.

   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. Fügen Sie eine Klasse mit dem Namen TodoGlyphFactoryProvider hinzu, die implementiert IGlyphFactoryProviderwird. Exportieren Sie diese Klasse mit einer NameAttribute von "TodoGlyph", einer OrderAttribute von "After VsTextMarker", einem ContentTypeAttribute "Code" und einem 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. Implementieren Sie die GetGlyphFactory Methode durch Instanziieren der TodoGlyphFactory.

   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
   

Definieren eines Todo-Tags und -Tags

Definieren Sie die Beziehung zwischen dem UI-Element, das Sie in den vorherigen Schritten und dem Indikatorrand definiert haben. Erstellen Sie einen Tagtyp und einen Tagger, und exportieren Sie ihn mithilfe eines Tagger-Anbieters.

So definieren Sie ein Todo-Tag und einen Tagger

1. Fügen Sie dem Projekt eine neue Klassendatei hinzu, und nennen Sie sie TodoTagger.

2. Fügen Sie die folgenden Importe hinzu.

   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. Fügen Sie eine Klasse namens TodoTaghinzu.

   C#

   internal class TodoTag : IGlyphTag
   

   VB

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

4. Ändern Sie die Klasse, TodoTagger die den Typ TodoTagimplementiertITagger<T>.

   C#

   internal class TodoTagger : ITagger<TodoTag>
   

   VB

   Friend Class TodoTagger
       Implements ITagger(Of TodoTag)
   

5. Fügen Sie der TodoTagger Klasse private Felder für ein IClassifier und für den Text hinzu, der in den Klassifizierungsbereichen zu finden ist.

   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. Fügen Sie einen Konstruktor hinzu, der den Klassifizierer festlegt.

   C#

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

   VB

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

7. Implementieren Sie die GetTags Methode, indem Sie nach allen Klassifizierungen suchen, deren Namen das Wort "Comment" enthalten und dessen Text den Suchtext enthält. Wenn der Suchtext gefunden wird, geben Sie einen neuen TagSpan<T> Typ TodoTagzurück.

   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. Deklarieren eines Ereignisses TagsChanged .

   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. Fügen Sie eine Klasse mit dem Namen TodoTaggerProvider hinzu, die sie implementiert ITaggerProvider, und exportieren Sie sie mit einem ContentTypeAttribute "Code" und einem 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. Importieren Sie IClassifierAggregatorService.

    C#

    [Import]
    internal IClassifierAggregatorService AggregatorService;
    

    VB

    <Import()>
    Friend AggregatorService As IClassifierAggregatorService
    

11. Implementieren Sie die CreateTagger Methode durch Instanziieren der TodoTagger.

    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
    

Erstellen und Testen des Codes

Um diesen Code zu testen, erstellen Sie die TodoGlyphTest-Lösung, und führen Sie sie in der experimentellen Instanz aus.

So erstellen und testen Sie die TodoGlyphTest-Lösung

1. Erstellen Sie die Projektmappe.

2. Führen Sie das Projekt aus, indem Sie F5 drücken. Eine zweite Instanz von Visual Studio wird gestartet.

3. Stellen Sie sicher, dass der Indikatorrand angezeigt wird. (Auf der Menü "Extras", klicken Sie auf "Optionen". Stellen Sie auf der Seite "Text-Editor" sicher, dass der Indikatorrand ausgewählt ist.)

4. Öffnen Sie eine Codedatei mit Kommentaren. Fügen Sie das Wort "Todo" zu einem der Kommentarabschnitte hinzu.

5. Ein hellblauer Kreis mit einem dunkelblauen Umriss wird links neben dem Codefenster im Indikatorrand angezeigt.