procedura dettagliata: Utilizzando un tasto di scelta rapida a un'estensione dell'editor

È possibile rispondere ai tasti di scelta rapida nell'estensione di editor. Di seguito viene illustrato procedura dettagliata viene illustrato come aggiungere un ornamento visivo a una visualizzazione di testo tramite un tasto di scelta rapida. In questa procedura dettagliata è basata sul modello di editor dell'area di controllo del riquadro di visualizzazione e consente di aggiungere l'area di controllo utilizzando + carattere.

Prerequisiti

Per completare questa procedura dettagliata, è necessario installare Visual Studio 2010 SDK.

Nota

per ulteriori informazioni su Visual Studio SDK, vedere Cenni preliminari sull'estensione di Visual Studio.Per ulteriori informazioni su come scaricare Visual Studio SDK, vedere Centro per sviluppatori di estensibilità di Visual Studio il sito Web MSDN.

Creare un progetto gestito Framework (MEF) di estensibilità

Per creare un progetto MEF

1. Creare un progetto dell'area di controllo del riquadro di visualizzazione dell'editor. Assegnare alla soluzione KeyBindingTest.

2. Aprire il file source.extension.vsixmanifest nell'editor del manifesto VSIX.

3. Assicurarsi che la direzione di Content contenga un tipo di contenuto componente MEF e che Path è impostato su KeyBindingTest.dll.

4. salvare e chiudere Source.extension.vsixmanifest.

5. Aggiungere i seguenti riferimenti e CopyLocal stabilito a false:

   Microsoft.VisualStudio.Editor

   Microsoft.VisualStudio.OLE.Interop

   Microsoft.VisualStudio.Shell

   Microsoft.VisualStudio.TextManager.Interop

6. Eliminare il file di classe di KeyBindingTestFactory.

Nel file di classe di KeyBindingTest, modificare il nome della classe PurpleCornerBox. modificare il costruttore anche. Nel costruttore, modificare la riga seguente:

_adornmentLayer = view.GetAdornmentLayer("KeyBindingTest")

_adornmentLayer = view.GetAdornmentLayer("KeyBindingTest");

in

_adornmentLayer = view.GetAdornmentLayer("PurpleCornerBox")

_adornmentLayer = view.GetAdornmentLayer("PurpleCornerBox");

Definizione del filtro di comando

Il filtro del comando è un'implementazione di IOleCommandTarget, che gestisce il comando crea un'istanza dell'area di controllo.

Per definire il filtro di comando

1. Aggiungere il file di classe e denominarlo KeyBindingCommandFilter.

2. Aggiungere le istruzioni using riportate di seguito.

   Imports System
   Imports System.Runtime.InteropServices
   Imports Microsoft.VisualStudio.OLE.Interop
   Imports Microsoft.VisualStudio
   Imports Microsoft.VisualStudio.Text.Editor
   

   using System;
   using System.Runtime.InteropServices;
   using Microsoft.VisualStudio.OLE.Interop;
   using Microsoft.VisualStudio;
   using Microsoft.VisualStudio.Text.Editor;
   

3. La classe denominata KeyBindingCommandFilter deve ereditare da IOleCommandTarget.

   Friend Class KeyBindingCommandFilter
       Implements IOleCommandTarget
   

   internal class KeyBindingCommandFilter : IOleCommandTarget
   

4. Aggiungere campi privati per la visualizzazione di testo, il comando seguente nella catena di comando e un flag non se il filtro del comando è già stato aggiunto.

   Private m_textView As IWpfTextView
   Friend m_nextTarget As IOleCommandTarget
   Friend m_added As Boolean 
   Friend m_adorned As Boolean
   

   private IWpfTextView m_textView;
   internal IOleCommandTarget m_nextTarget;
   internal bool m_added;
   internal bool m_adorned;
   

5. Aggiungere un costruttore che imposta la visualizzazione di testo.

   Public Sub New(ByVal textView As IWpfTextView)
       m_textView = textView
       m_adorned = False 
   End Sub
   

   public KeyBindingCommandFilter(IWpfTextView textView)
   {
       m_textView = textView;
       m_adorned = false;
   }
   

6. implementare il metodo di QueryStatus() come segue.

   Private Function QueryStatus(ByRef pguidCmdGroup As Guid, ByVal cCmds As UInteger, ByVal prgCmds() As OLECMD, ByVal pCmdText As IntPtr) As Integer Implements IOleCommandTarget.QueryStatus
       Return m_nextTarget.QueryStatus(pguidCmdGroup, cCmds, prgCmds, pCmdText)
   End Function
   

   int IOleCommandTarget.QueryStatus(ref Guid pguidCmdGroup, uint cCmds, OLECMD[] prgCmds, IntPtr pCmdText)
   {
       return m_nextTarget.QueryStatus(ref pguidCmdGroup, cCmds, prgCmds, pCmdText);
   }
   

7. Implementare il metodo di Exec() in modo che aggiunge una casella viola alla visualizzazione se un oggetto + il carattere è tipizzata.

   Private Function Exec(ByRef pguidCmdGroup As Guid, ByVal nCmdID As UInteger, ByVal nCmdexecopt As UInteger, ByVal pvaIn As IntPtr, ByVal pvaOut As IntPtr) As Integer Implements IOleCommandTarget.Exec
       If m_adorned = False Then 
           Dim typedChar As Char = Char.MinValue
   
           If pguidCmdGroup = VSConstants.VSStd2K AndAlso nCmdID = CUInt(VSConstants.VSStd2KCmdID.TYPECHAR) Then
               typedChar = CChar(ChrW(Marshal.GetObjectForNativeVariant(pvaIn)))
               If typedChar.Equals("+"c) Then 
                   Dim TempPurpleCornerBox As PurpleCornerBox = New PurpleCornerBox(m_textView)
                   m_adorned = True 
               End If 
           End If 
       End If 
       Return m_nextTarget.Exec(pguidCmdGroup, nCmdID, nCmdexecopt, pvaIn, pvaOut)
   End Function
   

   int IOleCommandTarget.Exec(ref Guid pguidCmdGroup, uint nCmdID, uint nCmdexecopt, IntPtr pvaIn, IntPtr pvaOut)
   {
       if (m_adorned == false)
       {
           char typedChar = char.MinValue;
   
           if (pguidCmdGroup == VSConstants.VSStd2K && nCmdID == (uint)VSConstants.VSStd2KCmdID.TYPECHAR)
           {
               typedChar = (char)(ushort)Marshal.GetObjectForNativeVariant(pvaIn);
               if (typedChar.Equals('+'))
               {
                   new PurpleCornerBox(m_textView);
                   m_adorned = true;
               }
           }
       }
       return m_nextTarget.Exec(ref pguidCmdGroup, nCmdID, nCmdexecopt, pvaIn, pvaOut);
   }
   

Aggiunta del provider del filtro di comando

Il provider dell'area di controllo necessario aggiungere un filtro del comando nella visualizzazione di testo. In questo esempio, il provider implementa IVsTextViewCreationListener per ascoltare eventi di creazione della visualizzazione di testo. Questo provider area anche esporta il livello dell'area di controllo, che definisce l'ordine Z dell'area di controllo.

Per aggiungere il provider del filtro di comando

1. Aggiungere il file di classe e denominarlo KeyBindingFilterProvider.

2. Aggiungere le istruzioni using riportate di seguito.

   Imports System
   Imports System.Collections.Generic
   Imports System.ComponentModel.Composition
   Imports Microsoft.VisualStudio
   Imports Microsoft.VisualStudio.OLE.Interop
   Imports Microsoft.VisualStudio.Utilities
   Imports Microsoft.VisualStudio.Editor
   Imports Microsoft.VisualStudio.Text.Editor
   Imports Microsoft.VisualStudio.TextManager.Interop
   

   using System;
   using System.Collections.Generic;
   using System.ComponentModel.Composition;
   using Microsoft.VisualStudio;
   using Microsoft.VisualStudio.OLE.Interop;
   using Microsoft.VisualStudio.Utilities;
   using Microsoft.VisualStudio.Editor;
   using Microsoft.VisualStudio.Text.Editor;
   using Microsoft.VisualStudio.TextManager.Interop;
   

3. Aggiungere KeyBindingFilterProvider classe denominata che eredita da IVsTextViewCreationListenere esportarlo con un tipo di contenuto “testo„ e TextViewRoleAttribute di Editable.

   <Export(GetType(IVsTextViewCreationListener)), ContentType("text"), TextViewRole(PredefinedTextViewRoles.Editable)>
   Friend Class KeyBindingCommandFilterProvider
       Implements IVsTextViewCreationListener
   

   [Export(typeof(IVsTextViewCreationListener))]
   [ContentType("text")]
   [TextViewRole(PredefinedTextViewRoles.Editable)]
   internal class KeyBindingCommandFilterProvider : IVsTextViewCreationListener
   

4. Aggiungere la definizione del livello dell'area di controllo.

   <Export(GetType(AdornmentLayerDefinition)), Name("PurpleCornerBox"), Order(), TextViewRole(PredefinedTextViewRoles.Editable)>
   Friend keybindingAdornmentLayer As AdornmentLayerDefinition
   

   [Export(typeof(AdornmentLayerDefinition))]
   [Name("PurpleCornerBox")]
   [Order()]
   [TextViewRole(PredefinedTextViewRoles.Editable)]
   internal AdornmentLayerDefinition keybindingAdornmentLayer;
   

5. Per ottenere l'adattatore della visualizzazione di testo, è necessario includere IVsEditorAdaptersFactoryService.

   <Import(GetType(IVsEditorAdaptersFactoryService))>
   Friend editorFactory As IVsEditorAdaptersFactoryService = Nothing
   

   [Import(typeof(IVsEditorAdaptersFactoryService))]
   internal IVsEditorAdaptersFactoryService editorFactory = null;
   

6. Implementare il metodo di VsTextViewCreated in modo che venga KeyBindingCommandFilter.

   Public Sub VsTextViewCreated(ByVal textViewAdapter As IVsTextView) Implements IVsTextViewCreationListener.VsTextViewCreated
       Dim textView As IWpfTextView = editorFactory.GetWpfTextView(textViewAdapter)
       If textView Is Nothing Then 
           Return 
       End If
   
       AddCommandFilter(textViewAdapter, New KeyBindingCommandFilter(textView))
   End Sub
   

   public void VsTextViewCreated(IVsTextView textViewAdapter)
   {
       IWpfTextView textView = editorFactory.GetWpfTextView(textViewAdapter);
       if (textView == null)
           return;
   
       AddCommandFilter(textViewAdapter, new KeyBindingCommandFilter(textView));
   }
   

7. Il gestore di AddCommandFilter ottiene adattatore della visualizzazione di testo e aggiunge il filtro del comando.

   Private Sub AddCommandFilter(ByVal viewAdapter As IVsTextView, ByVal commandFilter As KeyBindingCommandFilter)
       If commandFilter.m_added = False Then 
           'get the view adapter from the editor factory 
           Dim [next] As IOleCommandTarget
           Dim hr As Integer = viewAdapter.AddCommandFilter(commandFilter, [next])
   
           If hr = VSConstants.S_OK Then
               commandFilter.m_added = True 
               'you'll need the next target for Exec and QueryStatus 
               If [next] IsNot Nothing Then
                   commandFilter.m_nextTarget = [next]
               End If 
           End If 
       End If 
   End Sub
   

   void AddCommandFilter(IVsTextView viewAdapter, KeyBindingCommandFilter commandFilter)
   {
       if (commandFilter.m_added == false)
       {
           //get the view adapter from the editor factory
           IOleCommandTarget next;
           int hr = viewAdapter.AddCommandFilter(commandFilter, out next);
   
           if (hr == VSConstants.S_OK)
           {
               commandFilter.m_added = true;
               //you'll need the next target for Exec and QueryStatus 
               if (next != null)
                   commandFilter.m_nextTarget = next;
           }
       }
   }
   

Compilazione e test del codice

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

Per compilare e testare la soluzione di KeyBindingTest

1. Compilare la soluzione.

2. Quando si esegue il progetto nel debugger, una seconda istanza di Visual Studio viene creata un'istanza.

3. Creare o aprire un file di testo e fare clic su un punto qualsiasi della visualizzazione di testo.

4. tipo +.

   Ridimensionare la visualizzazione di testo.

   Un quadrato viola viene visualizzata nell'angolo superiore destro della visualizzazione di testo.

Vedere anche

Attività

procedura dettagliata: Collegare un tipo di contenuto a un'estensione di file