Procedura dettagliata: Creare un glifo del margine

È possibile personalizzare l'aspetto dei margini dell'editor usando estensioni dell'editor personalizzate. Questa procedura dettagliata inserisce un glifo personalizzato sul margine dell'indicatore ogni volta che la parola "todo" viene visualizzata in un commento di codice.

Creare un progetto MEF

1. Creare un progetto VSIX C#. (In Finestra di dialogo Nuovo progetto , selezionare Visual C# / Estendibilità e quindi progetto VSIX. Assegnare alla soluzione TodoGlyphTestil nome .

2. Aggiungere un elemento di progetto Classificatore editor. Per altre informazioni, vedere Creare un'estensione con un modello di elemento dell'editor.

3. Eliminare i file di classe esistenti.

Definire il glifo

Definire un glifo eseguendo l'interfaccia IGlyphFactory .

Per definire il glifo

1. Aggiungere un file di classe e assegnargli il nome TodoGlyphFactory.

2. Aggiungere il codice seguente usando le dichiarazioni.

   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. Aggiungere una classe denominata TodoGlyphFactory che implementa IGlyphFactory.

   C#

   internal class TodoGlyphFactory : IGlyphFactory
   

   VB

   Friend Class TodoGlyphFactory
       Implements IGlyphFactory
   

4. Aggiungere un campo privato che definisce le dimensioni del glifo.

   C#

   const double m_glyphSize = 16.0;
   

   VB

   Const m_glyphSize As Double = 16.0
   

5. Implementare GenerateGlyph definendo l'elemento dell'interfaccia utente del glifo. TodoTag viene definito più avanti in questa procedura dettagliata.

   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. Aggiungere una classe denominata TodoGlyphFactoryProvider che implementa IGlyphFactoryProvider. Esportare questa classe con un NameAttribute valore di "TodoGlyph", di OrderAttribute After VsTextMarker, di ContentTypeAttribute "codice" e di 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. Implementare il GetGlyphFactory metodo creando un'istanza di 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
   

Definire un tag Todo e un tagger

Definire la relazione tra l'elemento dell'interfaccia utente definito nei passaggi precedenti e il margine dell'indicatore. Creare un tipo di tag e contrassegnarlo ed esportarlo usando un provider di tagger.

Per definire un tag todo e un tagger

1. Aggiungere un nuovo file di classe al progetto e denominarlo TodoTagger.

2. Aggiungere le importazioni seguenti.

   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. Aggiungere una classe denominata TodoTag.

   C#

   internal class TodoTag : IGlyphTag
   

   VB

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

4. Modificare la classe denominata TodoTagger che implementa ITagger<T> il tipo TodoTag.

   C#

   internal class TodoTagger : ITagger<TodoTag>
   

   VB

   Friend Class TodoTagger
       Implements ITagger(Of TodoTag)
   

5. Per la TodoTagger classe aggiungere campi privati per un oggetto IClassifier e per il testo da trovare negli intervalli di classificazione.

   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. Aggiungere un costruttore che imposta il classificatore.

   C#

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

   VB

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

7. Implementare il GetTags metodo trovando tutti gli intervalli di classificazione i cui nomi includono la parola "commento" e il cui testo include il testo di ricerca. Ogni volta che viene trovato il testo di ricerca, restituire un nuovo TagSpan<T> tipo 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. Dichiarare un TagsChanged evento.

   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. Aggiungere una classe denominata TodoTaggerProvider che implementa ITaggerProvidered esportarla con un ContentTypeAttribute di "codice" e un TagTypeAttribute di 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. Importare .IClassifierAggregatorService

    C#

    [Import]
    internal IClassifierAggregatorService AggregatorService;
    

    VB

    <Import()>
    Friend AggregatorService As IClassifierAggregatorService
    

11. Implementare il CreateTagger metodo creando un'istanza di 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
    

Compilare e testare il codice

Per testare questo codice, compilare la soluzione TodoGlyphTest ed eseguirla nell'istanza sperimentale.

Per compilare e testare la soluzione TodoGlyphTest

1. Compilare la soluzione.

2. Eseguire il progetto premendo F5. Viene avviata una seconda istanza di Visual Studio.

3. Assicurarsi che il margine dell'indicatore sia visualizzato. (In Scegliere Opzioni dal menu Strumenti. Nella pagina Editor di testo verificare che sia selezionato Margine indicatore.

4. Aprire un file di codice con commenti. Aggiungere la parola "todo" a una delle sezioni di commento.

5. Un cerchio blu chiaro con un contorno blu scuro viene visualizzato nel margine dell'indicatore a sinistra della finestra del codice.