Поделиться через

Пошаговое руководство: Отображение справки подпись

  • Статья

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

Справка сигнатуры обычно активирована, введя конкретный символ, например "(" (открывающей скобки) и закрыто, введя другой символ, например "), закрывающая круглая скобка ("). Функции IntelliSense, которые активированы, введя символ могут быть реализованы с помощью обработчика команды для нажатий клавиш ( IOleCommandTarget интерфейс) и обработчика, который реализует поставщик IVsTextViewCreationListener интерфейс. Для создания подписи помощь в источнике, список подписей, участвующих в Справке подпись, реализуйте ISignatureHelpSource интерфейс и поставщик источника, который реализует ISignatureHelpSourceProvider интерфейс. Поставщики, управляемые части .NET Framework расширяемости (MEF) и компонентов, ответственные за экспортировать источник и классы контроллера и импортировать службы и маклеры, например ITextStructureNavigatorSelectorService, который позволяет переходить в текстовом буфере. ISignatureHelpBroker, активировать сеанс Справки сигнатуры.

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

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

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

Примечание

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

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

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

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

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

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

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

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

    Microsoft.VisualStudio.Editor

    Microsoft.VisualStudio.Language.Intellisense

    Microsoft.VisualStudio.OLE.Interop

    Microsoft.VisualStudio.Shell

    Microsoft.VisualStudio.TextManager.Interop

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

Реализация подписи и параметры Справки сигнатуры

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

Для реализации подпись помогает сигнатурам и параметрах

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

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

    Imports System
Imports System.Collections.Generic
Imports System.Linq
Imports System.Text
Imports System.Collections.ObjectModel
Imports System.ComponentModel.Composition
Imports System.Runtime.InteropServices
Imports Microsoft.VisualStudio.Language.Intellisense
Imports Microsoft.VisualStudio.Text
Imports Microsoft.VisualStudio.Text.Editor
Imports Microsoft.VisualStudio.Utilities
Imports Microsoft.VisualStudio.Editor
Imports Microsoft.VisualStudio.Text.Operations
Imports Microsoft.VisualStudio
Imports Microsoft.VisualStudio.TextManager.Interop
Imports Microsoft.VisualStudio.OLE.Interop

    using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.ComponentModel.Composition;
using System.Runtime.InteropServices;
using Microsoft.VisualStudio.Language.Intellisense;
using Microsoft.VisualStudio.Text;
using Microsoft.VisualStudio.Text.Editor;
using Microsoft.VisualStudio.Utilities;
using Microsoft.VisualStudio.Editor;
using Microsoft.VisualStudio.Text.Operations;
using Microsoft.VisualStudio;
using Microsoft.VisualStudio.TextManager.Interop;
using Microsoft.VisualStudio.OLE.Interop;

  3. Добавьте в проект класс TestParameter, реализующий IParameter.

    Friend Class TestParameter
    Implements IParameter

    internal class TestParameter : IParameter

  4. Добавьте конструктор, который задает все свойства.

    Public Sub New(ByVal documentation As String, ByVal locus As Span, ByVal name As String, ByVal signature As ISignature)
    Me.privateDocumentation = documentation
    Me.privateLocus = locus
    Me.privateName = name
    Me.privateSignature = signature
End Sub

    public TestParameter(string documentation, Span locus, string name, ISignature signature)
{
    Documentation = documentation;
    Locus = locus;
    Name = name;
    Signature = signature;
}

  5. Добавьте свойства IParameter.

    Private privateDocumentation As String 
ReadOnly Property Documentation() As String Implements IParameter.Documentation
    Get 
        Return privateDocumentation
    End Get 

End Property 
Private privateLocus As Span
ReadOnly Property Locus() As Span Implements IParameter.Locus
    Get 
        Return privateLocus
    End Get 
End Property 
Private privateName As String 
ReadOnly Property Name() As String Implements IParameter.Name
    Get 
        Return privateName
    End Get 
End Property 
Private privateSignature As ISignature
ReadOnly Property Signature() As ISignature Implements IParameter.Signature
    Get 
        Return privateSignature
    End Get 
End Property 
Private privatePrettyPrintedLocus As Span
ReadOnly Property PrettyPrintedLocus() As Span Implements IParameter.PrettyPrintedLocus
    Get 
        Return privatePrettyPrintedLocus
    End Get 
End Property

    public string Documentation { get; private set; }
public Span Locus { get; private set; }
public string Name { get; private set; }
public ISignature Signature { get; private set; }
public Span PrettyPrintedLocus { get; private set; }

  6. Добавьте в проект класс TestSignature, реализующий ISignature.

    Friend Class TestSignature
    Implements ISignature

    internal class TestSignature : ISignature

  7. Добавьте несколько закрытых полей.

    Private m_subjectBuffer As ITextBuffer
Private m_currentParameter As IParameter
Private m_content As String 
Private m_documentation As String 
Friend m_applicableToSpan As ITrackingSpan
Friend m_parameters As ReadOnlyCollection(Of IParameter)
Private m_printContent As String

    private ITextBuffer m_subjectBuffer;
private IParameter m_currentParameter;
private string m_content;
private string m_documentation;
private ITrackingSpan m_applicableToSpan;
private ReadOnlyCollection<IParameter> m_parameters;
private string m_printContent;

  8. Добавьте конструктор, который устанавливает поля и подписки Changed событие.

    Friend Sub New(ByVal subjectBuffer As ITextBuffer, ByVal content As String, ByVal doc As String, ByVal parameters As ReadOnlyCollection(Of IParameter))
    m_subjectBuffer = subjectBuffer
    m_content = content
    m_documentation = doc
    m_parameters = parameters
    AddHandler m_subjectBuffer.Changed, AddressOf OnSubjectBufferChanged
End Sub

    internal TestSignature(ITextBuffer subjectBuffer, string content, string doc, ReadOnlyCollection<IParameter> parameters)
{
    m_subjectBuffer = subjectBuffer;
    m_content = content;
    m_documentation = doc;
    m_parameters = parameters;
    m_subjectBuffer.Changed += new EventHandler<TextContentChangedEventArgs>(OnSubjectBufferChanged);
}

  9. Declare a CurrentParameterChanged событие. Это событие вызывается, когда пользователь заполняет один из параметров в подписи.

    Public Event CurrentParameterChanged As EventHandler(Of CurrentParameterChangedEventArgs) Implements ISignature.CurrentParameterChanged

    public event EventHandler<CurrentParameterChangedEventArgs> CurrentParameterChanged;

  10. Реализуйте CurrentParameter свойство таким образом, чтобы он вызовет CurrentParameterChanged событие при изменении значения свойства.

    ReadOnly Property CurrentParameter() As IParameter Implements ISignature.CurrentParameter
    Get 
        Return m_currentParameter
    End Get 
End Property

    public IParameter CurrentParameter
{
    get { return m_currentParameter; }
    internal set
    {
        if (m_currentParameter != value)
        {
            IParameter prevCurrentParameter = m_currentParameter;
            m_currentParameter = value;
            this.RaiseCurrentParameterChanged(prevCurrentParameter, m_currentParameter);
        }
    }
}

  11. Добавьте метод, который вызывает CurrentParameterChanged событие.

    Private Sub RaiseCurrentParameterChanged(ByVal prevCurrentParameter As IParameter, ByVal newCurrentParameter As IParameter)
    Dim tempHandler As EventHandler(Of CurrentParameterChangedEventArgs) = Me.CurrentParameterChangedEvent
    If tempHandler IsNot Nothing Then
        tempHandler(Me, New CurrentParameterChangedEventArgs(prevCurrentParameter, newCurrentParameter))
    End If 
End Sub

    private void RaiseCurrentParameterChanged(IParameter prevCurrentParameter, IParameter newCurrentParameter)
{
    EventHandler<CurrentParameterChangedEventArgs> tempHandler = this.CurrentParameterChanged;
    if (tempHandler != null)
    {
        tempHandler(this, new CurrentParameterChangedEventArgs(prevCurrentParameter, newCurrentParameter));
    }
}

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

    Friend Sub ComputeCurrentParameter()
    If Parameters.Count = 0 Then 
        Me.m_currentParameter = Nothing 
        Return 
    End If 

    'the number of commas in the string is the index of the current parameter 
    Dim sigText As String = ApplicableToSpan.GetText(m_subjectBuffer.CurrentSnapshot)

    Dim currentIndex As Integer = 0
    Dim commaCount As Integer = 0
    Do While currentIndex < sigText.Length
        Dim commaIndex As Integer = sigText.IndexOf(","c, currentIndex)
        If commaIndex = -1 Then 
            Exit Do 
        End If
        commaCount += 1
        currentIndex = commaIndex + 1
    Loop 

    If commaCount < Parameters.Count Then 
        Me.m_currentParameter = Parameters(commaCount)
    Else 
        'too many commas, so use the last parameter as the current one. 
        Me.m_currentParameter = Parameters(Parameters.Count - 1)
    End If 
End Sub

    internal void ComputeCurrentParameter()
{
    if (Parameters.Count == 0)
    {
        this.CurrentParameter = null;
        return;
    }

    //the number of commas in the string is the index of the current parameter 
    string sigText = ApplicableToSpan.GetText(m_subjectBuffer.CurrentSnapshot);

    int currentIndex = 0;
    int commaCount = 0;
    while (currentIndex < sigText.Length)
    {
        int commaIndex = sigText.IndexOf(',', currentIndex);
        if (commaIndex == -1)
        {
            break;
        }
        commaCount++;
        currentIndex = commaIndex + 1;
    }

    if (commaCount < Parameters.Count)
    {
        this.CurrentParameter = Parameters[commaCount];
    }
    else
    {
        //too many commas, so use the last parameter as the current one. 
        this.CurrentParameter = Parameters[Parameters.Count - 1];
    }
}

  13. Добавление обработчика событий Changed событие, вызывающее ComputeCurrentParameter() метод.

    Friend Sub OnSubjectBufferChanged(ByVal sender As Object, ByVal e As TextContentChangedEventArgs)
    Me.ComputeCurrentParameter()
End Sub

    internal void OnSubjectBufferChanged(object sender, TextContentChangedEventArgs e)
{
    this.ComputeCurrentParameter();
}

  14. Реализуйте свойство ApplicableToSpan. Это свойство содержит ITrackingSpan то соответствующий диапазон текста в буфере, к которому применяется подпись.

    ReadOnly Property ApplicableToSpan() As ITrackingSpan Implements ISignature.ApplicableToSpan
    Get 
        Return (m_applicableToSpan)
    End Get 
End Property

    public ITrackingSpan ApplicableToSpan
{
    get { return (m_applicableToSpan); }
    internal set { m_applicableToSpan = value; }
}

  15. Реализуйте другие параметры.

    ReadOnly Property Content() As String Implements ISignature.Content
    Get 
        Return (m_content)
    End Get 
End Property 

ReadOnly Property Documentation() As String Implements ISignature.Documentation
    Get 
        Return (m_documentation)
    End Get 
End Property 

ReadOnly Property Parameters() As ReadOnlyCollection(Of IParameter) Implements ISignature.Parameters
    Get 
        Return (m_parameters)
    End Get 
End Property 

ReadOnly Property PrettyPrintedContent() As String Implements ISignature.PrettyPrintedContent
    Get 
        Return (m_printContent)
    End Get 
End Property

    public string Content
{
    get { return (m_content); }
    internal set { m_content = value; }
}

public string Documentation
{
    get { return (m_documentation); }
    internal set { m_documentation = value; }
}

public ReadOnlyCollection<IParameter> Parameters
{
    get { return (m_parameters); }
    internal set { m_parameters = value; }
}

public string PrettyPrintedContent
{
    get { return (m_printContent); }
    internal set { m_printContent = value; }
}

Реализация источник Справки сигнатуры

Источник Справки сигнатуры набор сигнатур, для которых необходимо предоставить сведения.

Реализовать источник Справки сигнатуры

  1. Добавьте в проект класс TestSignatureHelpSource, реализующий ISignatureHelpSource.

    Friend Class TestSignatureHelpSource
    Implements ISignatureHelpSource

    internal class TestSignatureHelpSource : ISignatureHelpSource

  2. Добавьте ссылку в текстовый буфер.

    Private m_textBuffer As ITextBuffer

    private ITextBuffer m_textBuffer;

  3. Добавьте конструктор, который задает текстовый буфер и поставщик Справки сигнатуры.

    Public Sub New(ByVal textBuffer As ITextBuffer)
    m_textBuffer = textBuffer
End Sub

    public TestSignatureHelpSource(ITextBuffer textBuffer)
{
    m_textBuffer = textBuffer;
}

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

    Public Sub AugmentSignatureHelpSession(ByVal session As ISignatureHelpSession, ByVal signatures As IList(Of ISignature)) Implements ISignatureHelpSource.AugmentSignatureHelpSession
    Dim snapshot As ITextSnapshot = m_textBuffer.CurrentSnapshot
    Dim position As Integer = session.GetTriggerPoint(m_textBuffer).GetPosition(snapshot)

    Dim applicableToSpan As ITrackingSpan = m_textBuffer.CurrentSnapshot.CreateTrackingSpan(New Span(position, 0), SpanTrackingMode.EdgeInclusive, 0)

    signatures.Add(CreateSignature(m_textBuffer, "add(int firstInt, int secondInt)", "Documentation for adding integers.", applicableToSpan))
    signatures.Add(CreateSignature(m_textBuffer, "add(double firstDouble, double secondDouble)", "Documentation for adding doubles.", applicableToSpan))
End Sub

    public void AugmentSignatureHelpSession(ISignatureHelpSession session, IList<ISignature> signatures)
{
    ITextSnapshot snapshot = m_textBuffer.CurrentSnapshot;
    int position = session.GetTriggerPoint(m_textBuffer).GetPosition(snapshot);

    ITrackingSpan applicableToSpan = m_textBuffer.CurrentSnapshot.CreateTrackingSpan(
     new Span(position, 0), SpanTrackingMode.EdgeInclusive, 0);

    signatures.Add(CreateSignature(m_textBuffer, "add(int firstInt, int secondInt)", "Documentation for adding integers.", applicableToSpan));
    signatures.Add(CreateSignature(m_textBuffer, "add(double firstDouble, double secondDouble)", "Documentation for adding doubles.", applicableToSpan));

}

  5. Вспомогательный метод CreateSignature() предоставляет только для иллюстрации.

    Private Function CreateSignature(ByVal textBuffer As ITextBuffer, ByVal methodSig As String, ByVal methodDoc As String, ByVal span As ITrackingSpan) As TestSignature
    Dim sig As New TestSignature(textBuffer, methodSig, methodDoc, Nothing)
    AddHandler textBuffer.Changed, AddressOf sig.OnSubjectBufferChanged

    'find the parameters in the method signature (expect methodname(one, two) 
    Dim pars() As String = methodSig.Split(New Char() {"("c, ","c, ")"c})
    Dim paramList As New List(Of IParameter)()

    Dim locusSearchStart As Integer = 0
    For i As Integer = 1 To pars.Length - 1
        Dim param As String = pars(i).Trim()

        If String.IsNullOrEmpty(param) Then 
            Continue For 
        End If 

        'find where this parameter is located in the method signature 
        Dim locusStart As Integer = methodSig.IndexOf(param, locusSearchStart)
        If locusStart >= 0 Then 
            Dim locus As New Span(locusStart, param.Length)
            locusSearchStart = locusStart + param.Length
            paramList.Add(New TestParameter("Documentation for the parameter.", locus, param, sig))
        End If 
    Next i

    sig.m_Parameters = New ReadOnlyCollection(Of IParameter)(paramList)
    sig.m_ApplicableToSpan = span
    sig.ComputeCurrentParameter()
    Return sig
End Function

    private TestSignature CreateSignature(ITextBuffer textBuffer, string methodSig, string methodDoc, ITrackingSpan span)
{
    TestSignature sig = new TestSignature(textBuffer, methodSig, methodDoc, null);
    textBuffer.Changed += new EventHandler<TextContentChangedEventArgs>(sig.OnSubjectBufferChanged);

    //find the parameters in the method signature (expect methodname(one, two) 
    string[] pars = methodSig.Split(new char[] { '(', ',', ')' });
    List<IParameter> paramList = new List<IParameter>();

    int locusSearchStart = 0;
    for (int i = 1; i < pars.Length; i++)
    {
        string param = pars[i].Trim();

        if (string.IsNullOrEmpty(param))
            continue;

        //find where this parameter is located in the method signature 
        int locusStart = methodSig.IndexOf(param, locusSearchStart);
        if (locusStart >= 0)
        {
            Span locus = new Span(locusStart, param.Length);
            locusSearchStart = locusStart + param.Length;
            paramList.Add(new TestParameter("Documentation for the parameter.", locus, param, sig));
        }
    }

    sig.Parameters = new ReadOnlyCollection<IParameter>(paramList);
    sig.ApplicableToSpan = span;
    sig.ComputeCurrentParameter();
    return sig;
}

  6. Реализуйте метод GetBestMatch. В этом примере просто 2 подписи, каждый из которых принимает 2 параметров. Поэтому этот метод требуется. В более полной реализации, в которой несколько источников Справки сигнатуры доступен, этот метод используется, чтобы определить, является ли источник Справки сигнатур с наивысшим приоритетом может предоставить соответствующие сигнатуре. Если он не может, то метод возвращает значение null, а поставлена предоставляет источник следующ-высок-приоритета совпадение.

    Public Function GetBestMatch(ByVal session As ISignatureHelpSession) As ISignature Implements ISignatureHelpSource.GetBestMatch
    If session.Signatures.Count > 0 Then 
        Dim applicableToSpan As ITrackingSpan = session.Signatures(0).ApplicableToSpan
        Dim text As String = applicableToSpan.GetText(applicableToSpan.TextBuffer.CurrentSnapshot)

        If text.Trim().Equals("add") Then 'get only "add" 
            Return session.Signatures(0)
        End If 
    End If 
    Return Nothing 
End Function

    public ISignature GetBestMatch(ISignatureHelpSession session)
{
    if (session.Signatures.Count > 0)
    {
        ITrackingSpan applicableToSpan = session.Signatures[0].ApplicableToSpan;
        string text = applicableToSpan.GetText(applicableToSpan.TextBuffer.CurrentSnapshot);

        if (text.Trim().Equals("add"))  //get only "add"  
            return session.Signatures[0];
    }
    return null;
}

  7. Реализуйте метод dispose ():

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

Реализация поставщика источника Справки сигнатуры

Поставщик источника Справки сигнатуры отвечает за экспортировать управляемая часть .NET Framework расширяемости (компонент MEF) и для создания экземпляров источников Справки сигнатуры.

Реализация поставщика источника Справки сигнатуры

  1. Добавьте в проект класс TestSignatureHelpSourceProvider, реализующий ISignatureHelpSourceProviderи экспортировать его a NameAttributea ContentTypeAttribute "text". OrderAttribute Before= " по умолчанию".

    <Export(GetType(ISignatureHelpSourceProvider)), Name("Signature Help source"), Order(Before:="default"), ContentType("text")>
Friend Class TestSignatureHelpSourceProvider
    Implements ISignatureHelpSourceProvider

    [Export(typeof(ISignatureHelpSourceProvider))]
[Name("Signature Help source")]
[Order(Before = "default")]
[ContentType("text")]
internal class TestSignatureHelpSourceProvider : ISignatureHelpSourceProvider

  2. Реализация TryCreateSignatureHelpSource путем создания экземпляра TestSignatureHelpSource.

    Public Function TryCreateSignatureHelpSource(ByVal textBuffer As ITextBuffer) As ISignatureHelpSource Implements ISignatureHelpSourceProvider.TryCreateSignatureHelpSource
    Return New TestSignatureHelpSource(textBuffer)
End Function

    public ISignatureHelpSource TryCreateSignatureHelpSource(ITextBuffer textBuffer)
{
    return new TestSignatureHelpSource(textBuffer);
}

Реализация обработчика команды

Справка сигнатуры обычно активирована знаком (символ и закрыто a). Можно обрабатывать эти сообщения о нажатии клавиш, реализовав a IOleCommandTarget таким образом, чтобы он активировать сеанс Справки сигнатуры, когда он получит символ " a " (символ предшествуемый известным именем метода и закрывает сеанс при получении a).

Реализовать обработчик команд

  1. Добавьте в проект класс TestSignatureHelpCommand, реализующий IOleCommandTarget.

    Friend NotInheritable Class TestSignatureHelpCommandHandler
    Implements IOleCommandTarget

    internal sealed class TestSignatureHelpCommandHandler : IOleCommandTarget

  2. Добавьте закрытые поля IVsTextView адаптера (который позволяет добавлять обработчик команды к обработчикам последовательности команд), представление текста, брокер Справки сигнатуры и сеансом, a ITextStructureNavigatorи ниже IOleCommandTarget.

    Private m_nextCommandHandler As IOleCommandTarget
Private m_textView As ITextView
Private m_broker As ISignatureHelpBroker
Private m_session As ISignatureHelpSession
Private m_navigator As ITextStructureNavigator

    IOleCommandTarget m_nextCommandHandler;
ITextView m_textView;
ISignatureHelpBroker m_broker;
ISignatureHelpSession m_session;
ITextStructureNavigator m_navigator;

  3. Добавьте конструктор для инициализации эти поля и добавить фильтр команды к фильтрам последовательности команд.

    Friend Sub New(ByVal textViewAdapter As IVsTextView, ByVal textView As ITextView, ByVal nav As ITextStructureNavigator, ByVal broker As ISignatureHelpBroker)
    Me.m_textView = textView
    Me.m_broker = broker
    Me.m_navigator = nav

    'add this to the filter chain
    textViewAdapter.AddCommandFilter(Me, m_nextCommandHandler)
End Sub

    internal TestSignatureHelpCommandHandler(IVsTextView textViewAdapter, ITextView textView, ITextStructureNavigator nav, ISignatureHelpBroker broker)
{
    this.m_textView = textView;
    this.m_broker = broker;
    this.m_navigator = nav;

    //add this to the filter chain
    textViewAdapter.AddCommandFilter(this, out m_nextCommandHandler);
}

  4. Реализуйте Exec метод, чтобы активировать сеанс Справки сигнатуры, если фильтр команды возвращает знак (символа после одного из известных имен метода и закрыть сеанс при получении a) пока сеанс остается активным. В каждом случае команда переадресованна.

    Public 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
    Dim typedChar As Char = Char.MinValue

    If pguidCmdGroup = VSConstants.VSStd2K AndAlso nCmdID = CUInt(VSConstants.VSStd2KCmdID.TYPECHAR) Then
        typedChar = CChar(ChrW(CUShort(Marshal.GetObjectForNativeVariant(pvaIn))))
        If typedChar.Equals("("c) Then 
            'move the point back so it's in the preceding word 
            Dim point As SnapshotPoint = m_textView.Caret.Position.BufferPosition - 1
            Dim extent As TextExtent = m_navigator.GetExtentOfWord(point)
            Dim word As String = extent.Span.GetText()
            If word.Equals("add") Then
                m_session = m_broker.TriggerSignatureHelp(m_textView)
            End If 

        ElseIf typedChar.Equals(")"c) AndAlso m_session IsNot Nothing Then
            m_session.Dismiss()
            m_session = Nothing 
        End If 
    End If 
    Return m_nextCommandHandler.Exec(pguidCmdGroup, nCmdID, nCmdexecopt, pvaIn, pvaOut)
End Function

    public int Exec(ref Guid pguidCmdGroup, uint nCmdID, uint nCmdexecopt, IntPtr pvaIn, IntPtr pvaOut)
{
    char typedChar = char.MinValue;

    if (pguidCmdGroup == VSConstants.VSStd2K && nCmdID == (uint)VSConstants.VSStd2KCmdID.TYPECHAR)
    {
        typedChar = (char)(ushort)Marshal.GetObjectForNativeVariant(pvaIn);
        if (typedChar.Equals('('))
        {
            //move the point back so it's in the preceding word
            SnapshotPoint point = m_textView.Caret.Position.BufferPosition - 1;
            TextExtent extent = m_navigator.GetExtentOfWord(point);
            string word = extent.Span.GetText();
            if (word.Equals("add"))
                m_session = m_broker.TriggerSignatureHelp(m_textView);

        }
        else if (typedChar.Equals(')') && m_session != null)
        {
            m_session.Dismiss();
            m_session = null;
        }
    }
    return m_nextCommandHandler.Exec(ref pguidCmdGroup, nCmdID, nCmdexecopt, pvaIn, pvaOut);
}

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

    Public 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_nextCommandHandler.QueryStatus(pguidCmdGroup, cCmds, prgCmds, pCmdText)
End Function

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

Реализация поставщика команды Справки сигнатуры

Можно обеспечить команду Справки сигнатуры путем реализации IVsTextViewCreationListener создать обработчик команд, если представление текста будет создано.

Реализация поставщика команды Справки сигнатуры

  1. Добавьте в проект класс TestSignatureHelpController, реализующий IVsTextViewCreationListener и экспортировать его с NameAttribute" ContentTypeAttributeи TextViewRoleAttribute.

    <Export(GetType(IVsTextViewCreationListener)), Name("Signature Help controller"), TextViewRole(PredefinedTextViewRoles.Editable), ContentType("text")>
Friend Class TestSignatureHelpCommandProvider
    Implements IVsTextViewCreationListener

    [Export(typeof(IVsTextViewCreationListener))]
[Name("Signature Help controller")]
[TextViewRole(PredefinedTextViewRoles.Editable)]
[ContentType("text")]
internal class TestSignatureHelpCommandProvider : IVsTextViewCreationListener

  2. Импортировать IVsEditorAdaptersFactoryService (используется для получения ITextViewс учетом IVsTextView объект) ITextStructureNavigatorSelectorService (используется для поиска текущего машинное), и слово ISignatureHelpBroker (активирован сеанс Справки сигнатуры).

    <Import()>
Friend AdapterService As IVsEditorAdaptersFactoryService

<Import()>
Friend Property NavigatorService() As ITextStructureNavigatorSelectorService

<Import()>
Friend SignatureHelpBroker As ISignatureHelpBroker

    [Import]
internal IVsEditorAdaptersFactoryService AdapterService;

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

[Import]
internal ISignatureHelpBroker SignatureHelpBroker;

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

    Public Sub VsTextViewCreated(ByVal textViewAdapter As IVsTextView) Implements IVsTextViewCreationListener.VsTextViewCreated
    Dim textView As ITextView = AdapterService.GetWpfTextView(textViewAdapter)
    If textView Is Nothing Then 
        Return 
    End If

    textView.Properties.GetOrCreateSingletonProperty(Function() New TestSignatureHelpCommandHandler(textViewAdapter, textView, NavigatorService.GetTextStructureNavigator(textView.TextBuffer), SignatureHelpBroker))
End Sub

    public void VsTextViewCreated(IVsTextView textViewAdapter)
{
    ITextView textView = AdapterService.GetWpfTextView(textViewAdapter);
    if (textView == null)
        return;

    textView.Properties.GetOrCreateSingletonProperty(
         () => new TestSignatureHelpCommandHandler(textViewAdapter,
            textView,
            NavigatorService.GetTextStructureNavigator(textView.TextBuffer),
            SignatureHelpBroker));
}

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

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

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

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

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

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

  4. После набора открывающей скобки, вы должны увидеть подсказку, которая отображает список подписей, 2 add() метод.

См. также

Задачи

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