Пошаговое руководство: QuickInfo отображение всплывающих подсказок

Кратких сведений функция IntelliSense, показывающая сигнатуры метода и описания когда пользователь перемещает указатель над именем метода. Можно реализовать язык-основанные функции в качестве кратких сведений, указав идентификаторы, для которых нужно предоставить описания кратких сведений, а затем создайте подсказку, в которой отображать содержимое. Можно указать кратких сведений в контексте языковой службы или можно определить собственные расширения имени файла и тип содержимого и отображения кратких сведений только для этого типа или отображения кратких сведений для существующего типа содержимого (например "текст"). В этом пошаговом руководстве показано, как отобразить кратких сведений для типа содержимого "text".

Пример кратких сведений в этом пошаговом руководстве отображает подсказки, когда пользователь перемещает указатель над именем метода. Такой подход требует реализации этих интерфейсов: 4

• интерфейс источника

• интерфейс поставщика источника

• интерфейс контроллера

• интерфейс поставщика контроллера

Поставщики источника и контроллера, управляемые части .NET Framework расширяемости (MEF) и компонентов, ответственные за экспортировать источник и классы контроллера и импортировать службы и маклеры как ITextBufferFactoryService, который создает текстовый буфер подсказки. IQuickInfoBroker, активировать сеанс кратких сведений.

В этом примере используется список источник кратких сведений жестко имен и описаний метода, но в полных реализациях служба языка и языка ответственны за обеспечение то содержимое.

Обязательные компоненты

Чтобы выполнить это пошаговое руководство, необходимо устанавливать SDK для Visual Studio 2010.

Примечание

Дополнительные сведения о пакете SDK для Visual Studio см. в разделе интеграция SDK Visual Studio.Чтобы узнать, как загрузить пакет SDK для Visual Studio см. в разделе Центр разработчиков расширяемости Visual Studio на веб-сайте MSDN.

Создание проекта MEF

Создание проекта MEF

1. Создайте проект классификатора редактора. Назовите решение QuickInfoTest.

2. Откройте файл Source.extension.vsixmanifest в редакторе манифеста VSIX.

3. Убедитесь, что Content заголовок содержит тип содержимого и компонент MEF Path имеет значение QuickInfoTest.dll.

4. Сохранить и закрыть Source.extension.vsixmanifest.

5. Добавьте следующую ссылку на проект и набору CopyLocal В false.

   Microsoft.VisualStudio.Language.Intellisense

6. Удалите существующие файлы классов.

Реализация источник кратких сведений

Источник кратких сведений отвечает за сбор набор идентификаторов и их описание и добавление содержимого к текстовому буферу подсказки при обнаружении идентификаторов. В этом примере идентификаторы и их описания просто добавляются в конструкторе источников.

Реализовать источник кратких сведений

1. Добавьте файл классов и назовите его TestQuickInfoSource.

2. Добавьте следующие ввозы.

   Imports System
   Imports System.Collections.Generic
   Imports System.Linq
   Imports System.Text
   Imports System.Collections.ObjectModel
   Imports System.ComponentModel.Composition
   Imports Microsoft.VisualStudio.Language.Intellisense
   Imports Microsoft.VisualStudio.Text
   Imports Microsoft.VisualStudio.Text.Editor
   Imports Microsoft.VisualStudio.Text.Operations
   Imports Microsoft.VisualStudio.Text.Tagging
   Imports Microsoft.VisualStudio.Utilities
   

   using System;
   using System.Collections.Generic;
   using System.Collections.ObjectModel;
   using System.ComponentModel.Composition;
   using Microsoft.VisualStudio.Language.Intellisense;
   using Microsoft.VisualStudio.Text;
   using Microsoft.VisualStudio.Text.Editor;
   using Microsoft.VisualStudio.Text.Operations;
   using Microsoft.VisualStudio.Text.Tagging;
   using Microsoft.VisualStudio.Utilities;
   

3. Объявите класс, реализующий IQuickInfoSourceи присвойте ему имя TestQuickInfoSource.

   Friend Class TestQuickInfoSource
       Implements IQuickInfoSource
   

   internal class TestQuickInfoSource : IQuickInfoSource
   

4. Добавьте поля для поставщика источника кратких сведений, текстового буфера и набора имен и сигнатур метода. В этом примере имена и инициализируются в подписи метода TestQuickInfoSource конструктор.

   Private m_provider As TestQuickInfoSourceProvider
   Private m_subjectBuffer As ITextBuffer
   Private m_dictionary As Dictionary(Of String, String)
   

   private TestQuickInfoSourceProvider m_provider;
   private ITextBuffer m_subjectBuffer;
   private Dictionary<string, string> m_dictionary;
   

5. Добавьте конструктор, который задает поставщика источника кратких сведений и текстовый буфер и заполнить набор имен метода и сигнатур метода и описаниями.

   Public Sub New(ByVal provider As TestQuickInfoSourceProvider, ByVal subjectBuffer As ITextBuffer)
       m_provider = provider
       m_subjectBuffer = subjectBuffer
   
       'these are the method names and their descriptions
       m_dictionary = New Dictionary(Of String, String)()
       m_dictionary.Add("add", "int add(int firstInt, int secondInt)" & vbLf & "Adds one integer to another.")
       m_dictionary.Add("subtract", "int subtract(int firstInt, int secondInt)" & vbLf & "Subtracts one integer from another.")
       m_dictionary.Add("multiply", "int multiply(int firstInt, int secondInt)" & vbLf & "Multiplies one integer by another.")
       m_dictionary.Add("divide", "int divide(int firstInt, int secondInt)" & vbLf & "Divides one integer by another.")
   End Sub
   

   public TestQuickInfoSource(TestQuickInfoSourceProvider provider, ITextBuffer subjectBuffer)
   {
       m_provider = provider;
       m_subjectBuffer = subjectBuffer;
   
       //these are the method names and their descriptions
       m_dictionary = new Dictionary<string, string>();
       m_dictionary.Add("add", "int add(int firstInt, int secondInt)\nAdds one integer to another.");
       m_dictionary.Add("subtract", "int subtract(int firstInt, int secondInt)\nSubtracts one integer from another.");
       m_dictionary.Add("multiply", "int multiply(int firstInt, int secondInt)\nMultiplies one integer by another.");
       m_dictionary.Add("divide", "int divide(int firstInt, int secondInt)\nDivides one integer by another.");
   }
   

6. Реализуйте метод AugmentQuickInfoSession. В этом примере метод находит текущее машинное слово или предыдущее машинное слово если курсор находится в конце линии или текстового буфера. Если машинное слово одно из имен метода, описание, имя метода добавляется к содержимому кратких сведений.

   Public Sub AugmentQuickInfoSession(ByVal session As IQuickInfoSession, ByVal qiContent As IList(Of Object), ByRef applicableToSpan As ITrackingSpan) Implements IQuickInfoSource.AugmentQuickInfoSession
       ' Map the trigger point down to our buffer. 
       Dim subjectTriggerPoint As System.Nullable(Of SnapshotPoint) = session.GetTriggerPoint(m_subjectBuffer.CurrentSnapshot)
       If Not subjectTriggerPoint.HasValue Then
           applicableToSpan = Nothing 
           Exit Sub 
       End If 
   
       Dim currentSnapshot As ITextSnapshot = subjectTriggerPoint.Value.Snapshot
       Dim querySpan As New SnapshotSpan(subjectTriggerPoint.Value, 0)
   
       'look for occurrences of our QuickInfo words in the span 
       Dim navigator As ITextStructureNavigator = m_provider.NavigatorService.GetTextStructureNavigator(m_subjectBuffer)
       Dim extent As TextExtent = navigator.GetExtentOfWord(subjectTriggerPoint.Value)
       Dim searchText As String = extent.Span.GetText()
   
       For Each key As String In m_dictionary.Keys
           Dim foundIndex As Integer = searchText.IndexOf(key, StringComparison.CurrentCultureIgnoreCase)
           If foundIndex > -1 Then
               applicableToSpan = currentSnapshot.CreateTrackingSpan(querySpan.Start.Add(foundIndex).Position, 9, SpanTrackingMode.EdgeInclusive)
   
               Dim value As String = ""
               m_dictionary.TryGetValue(key, value)
               If value IsNot Nothing Then
                   qiContent.Add(value)
               Else
                   qiContent.Add("")
               End If 
   
               Exit Sub 
           End If 
       Next
   
       applicableToSpan = Nothing 
   End Sub
   

   public void AugmentQuickInfoSession(IQuickInfoSession session, IList<object> qiContent, out ITrackingSpan applicableToSpan)
   {
       // Map the trigger point down to our buffer.
       SnapshotPoint? subjectTriggerPoint = session.GetTriggerPoint(m_subjectBuffer.CurrentSnapshot);
       if (!subjectTriggerPoint.HasValue)
       {
           applicableToSpan = null;
           return;
       }
   
       ITextSnapshot currentSnapshot = subjectTriggerPoint.Value.Snapshot;
       SnapshotSpan querySpan = new SnapshotSpan(subjectTriggerPoint.Value, 0);
   
       //look for occurrences of our QuickInfo words in the span
       ITextStructureNavigator navigator = m_provider.NavigatorService.GetTextStructureNavigator(m_subjectBuffer);
       TextExtent extent = navigator.GetExtentOfWord(subjectTriggerPoint.Value);
       string searchText = extent.Span.GetText();
   
       foreach (string key in m_dictionary.Keys)
       {
           int foundIndex = searchText.IndexOf(key, StringComparison.CurrentCultureIgnoreCase);
           if (foundIndex > -1)
           {
               applicableToSpan = currentSnapshot.CreateTrackingSpan
                   (
                   querySpan.Start.Add(foundIndex).Position, 9, SpanTrackingMode.EdgeInclusive
                   );
   
               string value;
               m_dictionary.TryGetValue(key, out value);
               if (value != null)
                   qiContent.Add(value);
               else
                   qiContent.Add("");
   
               return;
           }
       }
   
       applicableToSpan = null;
   }
   

7. Кроме того, необходимо реализовать метод dispose () с тех пор IQuickInfoSource реализует IDisposable.

   Private m_isDisposed As Boolean 
   Public Sub Dispose() Implements IDisposable.Dispose
       If Not m_isDisposed Then
           GC.SuppressFinalize(Me)
           m_isDisposed = True 
       End If 
   End Sub
   

   private bool m_isDisposed;
   public void Dispose()
   {
       if (!m_isDisposed)
       {
           GC.SuppressFinalize(this);
           m_isDisposed = true;
       }
   }
   

Реализация поставщика источника кратких сведений

Поставщик источника кратких сведений служит главным образом экспортировать как часть и создает экземпляр MEF компонент источника кратких сведений. Так как часть компонентов, MEF, она может импортировать другие части компонент MEF.

Реализация поставщика источника кратких сведений

1. Объявите именованный поставщик кратких сведений TestQuickInfoSourceProvider, реализующий IQuickInfoSourceProviderи экспортировать его a NameAttribute "источника кратких сведений подсказки" OrderAttribute Before= " default" и " a " ContentTypeAttribute "text".

   <Export(GetType(IQuickInfoSourceProvider))> _
   <Name("ToolTip QuickInfo Source")> _
   <Order(Before:=" Default Quick Info Presenter")> _
   <ContentType("text")> _
   Friend Class TestQuickInfoSourceProvider
       Implements IQuickInfoSourceProvider
   

   [Export(typeof(IQuickInfoSourceProvider))]
   [Name("ToolTip QuickInfo Source")]
   [Order(Before = "Default Quick Info Presenter")]
   [ContentType("text")]
   internal class TestQuickInfoSourceProvider : IQuickInfoSourceProvider
   

2. Службы редактора импорта 2 ITextStructureNavigatorSelectorService и ITextBufferFactoryService, как свойства TestQuickInfoSourceProvider.

   Private _NavigatorService As ITextStructureNavigatorSelectorService
   <Import()> _
   Friend Property NavigatorService() As ITextStructureNavigatorSelectorService
       Get 
           Return _NavigatorService
       End Get 
       Set(ByVal value As ITextStructureNavigatorSelectorService)
           _NavigatorService = value
       End Set 
   End Property 
   
   Private _TextBufferFactoryService As ITextBufferFactoryService
   <Import()> _
   Friend Property TextBufferFactoryService() As ITextBufferFactoryService
       Get 
           Return _TextBufferFactoryService
       End Get 
       Set(ByVal value As ITextBufferFactoryService)
           _TextBufferFactoryService = value
       End Set 
   End Property
   

   [Import]
   internal ITextStructureNavigatorSelectorService NavigatorService { get; set; }
   
   [Import]
   internal ITextBufferFactoryService TextBufferFactoryService { get; set; }
   

3. Реализация TryCreateQuickInfoSource затем вернув новую TestQuickInfoSource.

   Public Function TryCreateQuickInfoSource(ByVal textBuffer As ITextBuffer) As IQuickInfoSource Implements IQuickInfoSourceProvider.TryCreateQuickInfoSource
       Return New TestQuickInfoSource(Me, textBuffer)
   End Function
   

   public IQuickInfoSource TryCreateQuickInfoSource(ITextBuffer textBuffer)
   {
       return new TestQuickInfoSource(this, textBuffer);
   }
   

Реализация контроллер кратких сведений

Контроллеры кратких сведений определяют, когда кратких сведений должно быть отображено. В этом примере кратких сведений отображается, когда указатель находится над машинным словом, соответствующий одному из имен метода. Контроллер кратких сведений реализует обработчик события наведения указателя мыши, активировать сеанс кратких сведений.

Реализовать контроллер кратких сведений

1. Объявите класс, реализующий IIntellisenseControllerи присвойте ему имя TestQuickInfoController.

   Friend Class TestQuickInfoController
       Implements IIntellisenseController
   

   internal class TestQuickInfoController : IIntellisenseController
   

2. Добавьте закрытые поля для представления текста, текстовых буферов, представленных в представлении текста кратких сведений сеанса и поставщика контроллера кратких сведений.

   Private m_textView As ITextView
   Private m_subjectBuffers As IList(Of ITextBuffer)
   Private m_provider As TestQuickInfoControllerProvider
   Private m_session As IQuickInfoSession
   

   private ITextView m_textView;
   private IList<ITextBuffer> m_subjectBuffers;
   private TestQuickInfoControllerProvider m_provider;
   private IQuickInfoSession m_session;
   

3. Добавьте конструктор, который устанавливает поля и добавляет обработчик события наведения мыши.

   Friend Sub New(ByVal textView As ITextView, ByVal subjectBuffers As IList(Of ITextBuffer), ByVal provider As TestQuickInfoControllerProvider)
       m_textView = textView
       m_subjectBuffers = subjectBuffers
       m_provider = provider
   
       AddHandler m_textView.MouseHover, AddressOf Me.OnTextViewMouseHover
   End Sub
   

   internal TestQuickInfoController(ITextView textView, IList<ITextBuffer> subjectBuffers, TestQuickInfoControllerProvider provider)
   {
       m_textView = textView;
       m_subjectBuffers = subjectBuffers;
       m_provider = provider;
   
       m_textView.MouseHover += this.OnTextViewMouseHover;
   }
   

4. Добавьте обработчик события наведения указателя мыши, активировать сеанс кратких сведений.

   Private Sub OnTextViewMouseHover(ByVal sender As Object, ByVal e As MouseHoverEventArgs)
       'find the mouse position by mapping down to the subject buffer 
       Dim point As System.Nullable(Of SnapshotPoint) = m_textView.BufferGraph.MapDownToFirstMatch(New SnapshotPoint(m_textView.TextSnapshot, e.Position), PointTrackingMode.Positive, Function(snapshot) m_subjectBuffers.Contains(snapshot.TextBuffer), PositionAffinity.Predecessor)
   
       If point IsNot Nothing Then 
           Dim triggerPoint As ITrackingPoint = point.Value.Snapshot.CreateTrackingPoint(point.Value.Position, PointTrackingMode.Positive)
   
           If Not m_provider.QuickInfoBroker.IsQuickInfoActive(m_textView) Then
               m_session = m_provider.QuickInfoBroker.TriggerQuickInfo(m_textView, triggerPoint, True)
           End If 
       End If 
   End Sub
   

   private void OnTextViewMouseHover(object sender, MouseHoverEventArgs e)
   {
       //find the mouse position by mapping down to the subject buffer
       SnapshotPoint? point = m_textView.BufferGraph.MapDownToFirstMatch
            (new SnapshotPoint(m_textView.TextSnapshot, e.Position),
           PointTrackingMode.Positive,
           snapshot => m_subjectBuffers.Contains(snapshot.TextBuffer),
           PositionAffinity.Predecessor);
   
       if (point != null)
       {
           ITrackingPoint triggerPoint = point.Value.Snapshot.CreateTrackingPoint(point.Value.Position,
           PointTrackingMode.Positive);
   
           if (!m_provider.QuickInfoBroker.IsQuickInfoActive(m_textView))
           {
               m_session = m_provider.QuickInfoBroker.TriggerQuickInfo(m_textView, triggerPoint, true);
           }
       }
   }
   

5. Реализуйте Detach метод, чтобы он удаляет обработчик события наведения указателя мыши, если контроллер будет наконец удаляется из представления текста.

   Public Sub Detach(ByVal textView As ITextView) Implements IIntellisenseController.Detach
       If m_textView Is textView Then 
           AddHandler m_textView.MouseHover, AddressOf Me.OnTextViewMouseHover
           m_textView = Nothing 
       End If 
   End Sub
   

   public void Detach(ITextView textView)
   {
       if (m_textView == textView)
       {
           m_textView.MouseHover -= this.OnTextViewMouseHover;
           m_textView = null;
       }
   }
   

6. Реализуйте DisconnectSubjectBuffer метод и ConnectSubjectBuffer метод как пустые методы для этого примера.

   Public Sub ConnectSubjectBuffer(ByVal subjectBuffer As ITextBuffer) Implements IIntellisenseController.ConnectSubjectBuffer
   
   End Sub 
   
   Public Sub DisconnectSubjectBuffer(ByVal subjectBuffer As ITextBuffer) Implements IIntellisenseController.DisconnectSubjectBuffer
   
   End Sub
   

   public void ConnectSubjectBuffer(ITextBuffer subjectBuffer)
   {
   }
   
   public void DisconnectSubjectBuffer(ITextBuffer subjectBuffer)
   {
   }
   

Реализация поставщика контроллера кратких сведений

Поставщик контроллера кратких сведений служит в основном экспортировать как часть MEF и создать экземпляр компонента контроллер кратких сведений. Так как часть компонентов, MEF, она может импортировать другие части компонент MEF.

Реализация поставщика контроллера кратких сведений

1. Объявите класс TestQuickInfoControllerProvider, реализующий IIntellisenseControllerProviderи экспортировать его a NameAttribute "контроллера кратких сведений подсказки" и " a " ContentTypeAttribute "text".

   <Export(GetType(IIntellisenseControllerProvider))> _
   <Name("ToolTip QuickInfo Controller")> _
   <ContentType("text")> _
   Friend Class TestQuickInfoControllerProvider
       Implements IIntellisenseControllerProvider
   

   [Export(typeof(IIntellisenseControllerProvider))]
   [Name("ToolTip QuickInfo Controller")]
   [ContentType("text")]
   internal class TestQuickInfoControllerProvider : IIntellisenseControllerProvider
   

2. Импортировать IQuickInfoBroker как свойство.

   Private _QuickInfoBroker As IQuickInfoBroker
   <Import()> _
   Friend Property QuickInfoBroker() As IQuickInfoBroker
       Get 
           Return _QuickInfoBroker
       End Get 
       Set(ByVal value As IQuickInfoBroker)
           _QuickInfoBroker = value
       End Set 
   End Property
   

   [Import]
   internal IQuickInfoBroker QuickInfoBroker { get; set; }
   

3. Реализуйте TryCreateIntellisenseController метод путем создания экземпляра контроллера кратких сведений.

   Public Function TryCreateIntellisenseController(ByVal textView As ITextView, ByVal subjectBuffers As IList(Of ITextBuffer)) As IIntellisenseController Implements IIntellisenseControllerProvider.TryCreateIntellisenseController
       Return New TestQuickInfoController(textView, subjectBuffers, Me)
   End Function
   

   public IIntellisenseController TryCreateIntellisenseController(ITextView textView, IList<ITextBuffer> subjectBuffers)
   {
       return new TestQuickInfoController(textView, subjectBuffers, this);
   }
   

Построение и тестирование кода

Для тестирования этого кода выполните построение решения QuickInfoTest и запустите его в экспериментальном экземпляре.

Построение и тестирование решение QuickInfoTest

1. Выполните построение решения.

2. Если запустить этот проект в отладчике, второй экземпляр Visual Studio создается.

3. Создайте текстовый файл и введите текст, который включает ряд машинные слова "добавить" и "вычесть".

4. Переместите указатель над одним из вхождений "добавить". Подпись и описание add метод должен быть отображен.

См. также

Задачи

Пошаговое руководство: Связывание тип контента в расширение имени файла