Panduan: Bantuan Tampilkan Tanda Tangan

Bantuan Tanda Tangan (juga dikenal sebagai Info Parameter) menampilkan tanda tangan metode dalam tipsalat saat pengguna mengetik karakter mulai daftar parameter (biasanya tanda kurung buka). Sebagai pemisah parameter dan parameter (biasanya koma) di ketik, tipsalat diperbarui untuk menampilkan parameter berikutnya dalam huruf tebal. Anda dapat menentukan Bantuan Tanda Tangan dengan cara berikut: dalam konteks layanan bahasa, tentukan ekstensi nama file dan tipe konten Anda sendiri dan tampilkan Bantuan Tanda Tangan hanya untuk jenis tersebut, atau tampilkan Bantuan Tanda Tangan untuk tipe konten yang ada (misalnya, "teks"). Panduan ini memperlihatkan cara menampilkan Bantuan Tanda Tangan untuk tipe isi "teks".

Bantuan Tanda Tangan biasanya dipicu dengan mengetik karakter tertentu, misalnya, "(" (kurung buka), dan ditutup dengan mengetik karakter lain, misalnya, ")" (menutup tanda kurung). Fitur IntelliSense yang dipicu dengan mengetik karakter dapat diimplementasikan dengan menggunakan handler perintah untuk penekanan tombol ( IOleCommandTarget antarmuka) dan penyedia handler yang mengimplementasikan IVsTextViewCreationListener antarmuka. Untuk membuat sumber Bantuan Tanda Tangan, yang merupakan daftar tanda tangan yang berpartisipasi dalam Bantuan Tanda Tangan, terapkan ISignatureHelpSource antarmuka dan penyedia sumber yang menjalankan ISignatureHelpSourceProvider antarmuka. Penyedia adalah bagian komponen Managed Extensibility Framework (MEF), dan bertanggung jawab untuk mengekspor kelas sumber dan pengontrol dan mengimpor layanan dan broker, misalnya, ITextStructureNavigatorSelectorService, yang memungkinkan Anda menavigasi dalam buffer teks, dan ISignatureHelpBroker, yang memicu sesi Bantuan Tanda Tangan.

Panduan ini menunjukkan cara menyiapkan Bantuan Tanda Tangan untuk sekumpulan pengidentifikasi yang dikodekan secara permanen. Dalam implementasi penuh, bahasa bertanggung jawab untuk menyediakan konten tersebut.

Membuat proyek MEF

Untuk membuat proyek MEF

1. Buat proyek C# VSIX. (Dalam Dialog Proyek Baru, pilih Visual C# / Ekstensibilitas, lalu Proyek VSIX.) Beri nama solusi SignatureHelpTest.

2. Tambahkan templat item Pengklasifikasi Editor ke proyek. Untuk informasi selengkapnya, lihat Membuat ekstensi dengan templat item editor.

3. Hapus file kelas yang ada.

4. Tambahkan referensi berikut ke proyek, dan pastikan CopyLocal diatur ke false:

   Microsoft.VisualStudio.Editor

   Microsoft.VisualStudio.Language.Intellisense

   Microsoft.VisualStudio.OLE.Interop

   Microsoft.VisualStudio.Shell.14.0

   Microsoft.VisualStudio.TextManager.Interop

Menerapkan tanda tangan dan parameter Bantuan Tanda Tangan

Sumber Bantuan Tanda Tangan didasarkan pada tanda tangan yang mengimplementasikan ISignature, yang masing-masing berisi parameter yang mengimplementasikan IParameter. Dalam implementasi lengkap, informasi ini akan diperoleh dari dokumentasi bahasa, tetapi dalam contoh ini, tanda tangan dikodekan secara permanen.

Untuk mengimplementasikan tanda tangan dan parameter Bantuan Tanda Tangan

1. Tambahkan file kelas dan beri nama SignatureHelpSource.

2. Tambahkan impor berikut.

   C#

   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;
   

   VB

   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
   

3. Tambahkan kelas bernama TestParameter yang mengimplementasikan IParameter.

   C#

   internal class TestParameter : IParameter
   

   VB

   Friend Class TestParameter
       Implements IParameter
   

4. Tambahkan konstruktor yang mengatur semua properti.

   C#

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

   VB

   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
   

5. Tambahkan properti .IParameter

   C#

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

   VB

   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
   

6. Tambahkan kelas bernama TestSignature yang mengimplementasikan ISignature.

   C#

   internal class TestSignature : ISignature
   

   VB

   Friend Class TestSignature
       Implements ISignature
   

7. Tambahkan beberapa bidang privat.

   C#

   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;
   

   VB

   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
   

8. Tambahkan konstruktor yang mengatur bidang dan berlangganan acara Changed .

   C#

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

   VB

   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
   

9. Mendeklarasikan CurrentParameterChanged peristiwa. Kejadian ini dimunculkan ketika pengguna mengisi salah satu parameter dalam tanda tangan.

   C#

   public event EventHandler<CurrentParameterChangedEventArgs> CurrentParameterChanged;
   

   VB

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

10. Terapkan CurrentParameter properti sehingga meningkatkan CurrentParameterChanged peristiwa saat nilai properti diubah.

    C#

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

    VB

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

11. Tambahkan metode yang meningkatkan CurrentParameterChanged peristiwa.

    C#

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

    VB

    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
    

12. Tambahkan metode yang menghitung parameter saat ini dengan membandingkan jumlah koma dalam ApplicableToSpan jumlah koma dalam tanda tangan.

    C#

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

    VB

    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
    

13. Tambahkan penanganan aktivitas untuk Changed peristiwa yang memanggil ComputeCurrentParameter() metode .

    C#

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

    VB

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

14. Implementasikan properti ApplicableToSpan. Properti ini menyimpan ITrackingSpan yang sesuai dengan rentang teks dalam buffer tempat tanda tangan diterapkan.

    C#

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

    VB

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

15. Terapkan parameter lainnya.

    C#

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

    VB

    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
    

Menerapkan sumber Bantuan Tanda Tangan

Sumber Bantuan Tanda Tangan adalah kumpulan tanda tangan yang Anda berikan informasinya.

Untuk mengimplementasikan sumber Bantuan Tanda Tangan

1. Tambahkan kelas bernama TestSignatureHelpSource yang mengimplementasikan ISignatureHelpSource.

   C#

   internal class TestSignatureHelpSource : ISignatureHelpSource
   

   VB

   Friend Class TestSignatureHelpSource
       Implements ISignatureHelpSource
   

2. Tambahkan referensi ke buffer teks.

   C#

   private ITextBuffer m_textBuffer;
   

   VB

   Private m_textBuffer As ITextBuffer
   

3. Tambahkan konstruktor yang mengatur buffer teks dan penyedia sumber Bantuan Tanda Tangan.

   C#

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

   VB

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

4. Mengimplementasikan metode AugmentSignatureHelpSession. Dalam contoh ini, tanda tangan dikodekan secara permanen, tetapi dalam implementasi lengkap Anda akan mendapatkan informasi ini dari dokumentasi bahasa.

   C#

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

   VB

   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
   

5. Metode pembantu CreateSignature() disediakan hanya untuk ilustrasi.

   C#

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

   VB

   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
   

6. Mengimplementasikan metode GetBestMatch. Dalam contoh ini, hanya ada dua tanda tangan, yang masing-masing memiliki dua parameter. Oleh karena itu, metode ini tidak diperlukan. Dalam implementasi yang lebih lengkap, di mana lebih dari satu sumber Bantuan Tanda Tangan tersedia, metode ini digunakan untuk memutuskan apakah sumber Bantuan Tanda Tangan prioritas tertinggi dapat memberikan tanda tangan yang cocok. Jika tidak bisa, metode mengembalikan null dan sumber prioritas tertinggi berikutnya diminta untuk menyediakan kecocokan.

   C#

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

   VB

   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
   

7. Terapkan Dispose() metode :

   C#

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

   VB

   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
   

Menerapkan penyedia sumber Bantuan Tanda Tangan

Penyedia sumber Bantuan Tanda Tangan bertanggung jawab untuk mengekspor bagian komponen Managed Extensibility Framework (MEF) dan untuk membuat instans sumber Bantuan Tanda Tangan.

Untuk mengimplementasikan penyedia sumber Bantuan Tanda Tangan

1. Tambahkan kelas bernama TestSignatureHelpSourceProvider yang mengimplementasikan ISignatureHelpSourceProvider, dan ekspor dengan NameAttribute, ContentTypeAttribute dari "teks", dan OrderAttribute default Before=".

   C#

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

   VB

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

2. Terapkan TryCreateSignatureHelpSource dengan membuat instans TestSignatureHelpSource.

   C#

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

   VB

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

Menerapkan handler perintah

Bantuan Tanda Tangan biasanya dipicu oleh karakter tanda kurung pembuka "(" dan diberhentikan oleh karakter kurung tutup ")". Anda dapat menangani penekanan tombol ini dengan menjalankan IOleCommandTarget sehingga memicu sesi Bantuan Tanda Tangan saat menerima karakter tanda kurung pembuka yang didahului oleh nama metode yang diketahui, dan menutup sesi saat menerima karakter tanda kurung penutup.

Untuk mengimplementasikan handler perintah

1. Tambahkan kelas bernama TestSignatureHelpCommand yang mengimplementasikan IOleCommandTarget.

   C#

   internal sealed class TestSignatureHelpCommandHandler : IOleCommandTarget
   

   VB

   Friend NotInheritable Class TestSignatureHelpCommandHandler
       Implements IOleCommandTarget
   

2. Tambahkan bidang privat untuk IVsTextView adaptor (yang memungkinkan Anda menambahkan handler perintah ke rantai penangan perintah), tampilan teks, broker dan sesi Bantuan Tanda Tangan, ITextStructureNavigator, dan berikutnya IOleCommandTarget.

   C#

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

   VB

   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
   

3. Tambahkan konstruktor untuk menginisialisasi bidang ini dan untuk menambahkan filter perintah ke rantai filter perintah.

   C#

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

   VB

   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
   

4. Exec Terapkan metode untuk memicu sesi Bantuan Tanda Tangan ketika filter perintah menerima karakter tanda kurung pembuka "(" setelah salah satu nama metode yang diketahui, dan untuk menutup sesi ketika menerima karakter tanda kurung penutup ")" saat sesi masih aktif. Dalam setiap kasus, perintah diteruskan.

   C#

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

   VB

   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
   

5. Terapkan QueryStatus metode sehingga selalu meneruskan perintah.

   C#

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

   VB

   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
   

Menerapkan penyedia perintah Bantuan Tanda Tangan

Anda dapat memberikan perintah Bantuan Tanda Tangan dengan mengimplementasikan IVsTextViewCreationListener untuk membuat instans handler perintah saat tampilan teks dibuat.

Untuk mengimplementasikan penyedia perintah Bantuan Tanda Tangan

1. Tambahkan kelas bernama TestSignatureHelpController yang mengimplementasikan IVsTextViewCreationListener dan mengekspornya dengan NameAttribute, ContentTypeAttribute, dan TextViewRoleAttribute.

   C#

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

   VB

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

2. IVsEditorAdaptersFactoryService Impor (digunakan untuk mendapatkan ITextView, diberikan IVsTextView objek), ITextStructureNavigatorSelectorService (digunakan untuk menemukan kata saat ini), dan ISignatureHelpBroker (untuk memicu sesi Bantuan Tanda Tangan).

   C#

   [Import]
   internal IVsEditorAdaptersFactoryService AdapterService;
   
   [Import]
   internal ITextStructureNavigatorSelectorService NavigatorService { get; set; }
   
   [Import]
   internal ISignatureHelpBroker SignatureHelpBroker;
   

   VB

   <Import()>
   Friend AdapterService As IVsEditorAdaptersFactoryService
   
   <Import()>
   Friend Property NavigatorService() As ITextStructureNavigatorSelectorService
   
   <Import()>
   Friend SignatureHelpBroker As ISignatureHelpBroker
   

3. Terapkan VsTextViewCreated metode dengan membuat instans TestSignatureCommandHandler.

   C#

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

   VB

   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
   

Membangun dan Menguji Kode

Untuk menguji kode ini, buat solusi SignatureHelpTest dan jalankan dalam instans eksperimental.

Untuk membangun dan menguji solusi SignatureHelpTest

1. Bangun solusinya.

2. Saat Anda menjalankan proyek ini di debugger, instans kedua Visual Studio dimulai.

3. Buat file teks dan ketik beberapa teks yang menyertakan kata "tambahkan" ditambah tanda kurung pembuka.

4. Setelah Anda mengetik tanda kurung pembuka, Anda akan melihat tipsalat yang menampilkan daftar dua tanda tangan untuk metode tersebut add() .

Konten terkait

• Panduan: Menautkan tipe konten ke ekstensi nama file