İzlenecek yol: QuickInfo araç ipuçlarını görüntüleme

Makale
01/13/2024

QuickInfo, kullanıcı işaretçiyi bir yöntem adının üzerine getirince yöntem imzalarını ve açıklamalarını görüntüleyen bir IntelliSense özelliğidir. QuickInfo açıklamalarını sağlamak istediğiniz tanımlayıcıları tanımlayarak ve ardından içeriğin görüntüleneceği bir araç ipucu oluşturarak QuickInfo gibi dil tabanlı özellikleri uygulayabilirsiniz. QuickInfo'yu bir dil hizmeti bağlamında tanımlayabilir veya kendi dosya adı uzantınızı ve içerik türünüzü tanımlayıp yalnızca bu tür için QuickInfo'yu görüntüleyebilir veya mevcut bir içerik türü için QuickInfo'yu ("metin" gibi) görüntüleyebilirsiniz. Bu izlenecek yol, "metin" içerik türü için QuickInfo'nun nasıl görüntüleneceğini gösterir.

Bu kılavuzdaki QuickInfo örneği, bir kullanıcı işaretçiyi bir yöntem adının üzerine getirince araç ipuçlarını görüntüler. Bu tasarım için şu dört arabirimi uygulamanız gerekir:

kaynak arabirimi
kaynak sağlayıcı arabirimi
denetleyici arabirimi
denetleyici sağlayıcı arabirimi

Kaynak ve denetleyici sağlayıcıları Yönetilen Genişletilebilirlik Çerçevesi (MEF) bileşen parçalarıdır ve kaynak ve denetleyici sınıflarını dışarı aktarmaktan ve araç ipucu metin arabelleği oluşturan gibi hizmetleri ve IQuickInfoBrokeraracıları ITextBufferFactoryServiceve QuickInfo oturumunu tetikleyen aracıları içeri aktarmaktan sorumludur.

Bu örnekte, QuickInfo kaynağı yöntem adlarının ve açıklamalarının sabit kodlanmış bir listesini kullanır, ancak tam uygulamalarda, dil hizmeti ve dil belgeleri bu içeriği sağlamaktan sorumludur.

MEF projesi oluşturma

MEF projesi oluşturmak için

C# VSIX projesi oluşturun. (Yeni Proje iletişim kutusu, Visual C# / Genişletilebilirlik'i ve ardından VSIX Projesi'ni seçin.) Çözümü QuickInfoTestolarak adlandırın.
Projeye bir Düzenleyici Sınıflandırıcısı öğesi şablonu ekleyin. Daha fazla bilgi için bkz . Düzenleyici öğesi şablonuyla uzantı oluşturma.
Varolan sınıf dosyalarını silin.

QuickInfo kaynağını uygulama

Tanımlayıcılardan biriyle karşılaşıldığında QuickInfo kaynağı, tanımlayıcı kümesini ve açıklamalarını toplamaktan ve içeriği araç ipucu metin arabelleğine eklemekle sorumludur. Bu örnekte, tanımlayıcılar ve açıklamaları kaynak oluşturucuya yeni eklenir.

QuickInfo kaynağını uygulamak için

Bir sınıf dosyası ekleyin ve adını verin TestQuickInfoSource.
Microsoft.VisualStudio.Language.IntelliSense'e bir başvuru ekleyin.

Aşağıdaki içeri aktarmaları ekleyin.

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;

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

uygulayan IQuickInfoSourcebir sınıf bildirin ve adını verin TestQuickInfoSource.

internal class TestQuickInfoSource : IQuickInfoSource

Friend Class TestQuickInfoSource
    Implements IQuickInfoSource

QuickInfo kaynak sağlayıcısı, metin arabelleği ve yöntem adları ve yöntem imzaları kümesi için alanlar ekleyin. Bu örnekte, yöntem adları ve imzaları oluşturucuda TestQuickInfoSource başlatılır.

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

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

QuickInfo kaynak sağlayıcısını ve metin arabelleği ayarlayan ve yöntem adları kümesini, yöntem imzalarını ve açıklamalarını dolduran bir oluşturucu ekleyin.

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

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

AugmentQuickInfoSession yöntemini uygulayın. Bu örnekte, imleç bir satırın veya metin arabelleğinin sonundaysa yöntem geçerli sözcüğü veya önceki sözcüğü bulur. Sözcük yöntem adlarından biriyse, bu yöntem adının açıklaması QuickInfo içeriğine eklenir.

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
                                        extent.Span.Start + foundIndex, key.Length, SpanTrackingMode.EdgeInclusive
                );

            string value;
            m_dictionary.TryGetValue(key, out value);
            if (value != null)
                qiContent.Add(value);
            else
                qiContent.Add("");

            return;
        }
    }

    applicableToSpan = null;
}

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)

            applicableToSpan = currentSnapshot.CreateTrackingSpan(extent.Span.Start + foundIndex, key.Length, 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

Şunu uyguladığından IQuickInfoSource dispose() yöntemi de uygulamanız IDisposablegerekir:

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

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

QuickInfo kaynak sağlayıcısı uygulama

QuickInfo kaynağının sağlayıcısı öncelikle kendisini bir MEF bileşeni parçası olarak dışarı aktarmaya ve QuickInfo kaynağının örneğini oluşturmaya hizmet eder. Bu bir MEF bileşeni parçası olduğundan, diğer MEF bileşen parçalarını içeri aktarabilir.

QuickInfo kaynak sağlayıcısı uygulamak için

uygulayan adlı TestQuickInfoSourceProvider bir QuickInfo kaynak sağlayıcısı bildirin ve bunu NameAttribute "ToolTip QuickInfo Kaynağı", OrderAttribute Before="default" ve "ContentTypeAttributetext" ile dışarı aktarınIQuickInfoSourceProvider.

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

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

İki düzenleyici hizmetini ITextStructureNavigatorSelectorService ve ITextBufferFactoryServiceözelliklerini içeri aktarın TestQuickInfoSourceProvider.

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

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

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

Yeni TestQuickInfoSourcebir döndürmek için uygulayınTryCreateQuickInfoSource.

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

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

QuickInfo denetleyicisi uygulama

QuickInfo denetleyicileri QuickInfo'nun ne zaman görüntüleneceğini belirler. Bu örnekte, işaretçi yöntem adlarından birine karşılık gelen bir sözcüğün üzerindeyken QuickInfo görüntülenir. QuickInfo denetleyicisi, QuickInfo oturumunu tetikleyen bir fare üzerine gelme olay işleyicisi uygular.

QuickInfo denetleyicisi uygulamak için

uygulayan IIntellisenseControllerbir sınıf bildirin ve adını verin TestQuickInfoController.

internal class TestQuickInfoController : IIntellisenseController

Friend Class TestQuickInfoController
    Implements IIntellisenseController

Metin görünümü, metin görünümünde temsil edilen metin arabellekleri, QuickInfo oturumu ve QuickInfo denetleyici sağlayıcısı için özel alanlar ekleyin.

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

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

Alanları ayarlayan ve fareyle vurgulama olay işleyicisini ekleyen bir oluşturucu ekleyin.

internal TestQuickInfoController(ITextView textView, IList<ITextBuffer> subjectBuffers, TestQuickInfoControllerProvider provider)
{
    m_textView = textView;
    m_subjectBuffers = subjectBuffers;
    m_provider = provider;

    m_textView.MouseHover += this.OnTextViewMouseHover;
}

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

QuickInfo oturumunu tetikleyen fare üzerine gelme olay işleyicisini ekleyin.

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

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

Detach Denetleyici metin görünümünden ayrılırken farenin üzerine gelme olay işleyicisini kaldırması için yöntemini uygulayın.

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

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

ConnectSubjectBuffer bu örnek için yöntemini ve DisconnectSubjectBuffer yöntemini boş yöntemler olarak uygulayın.

public void ConnectSubjectBuffer(ITextBuffer subjectBuffer)
{
}

public void DisconnectSubjectBuffer(ITextBuffer subjectBuffer)
{
}

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

End Sub

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

End Sub

QuickInfo denetleyici sağlayıcısını uygulama

QuickInfo denetleyicisinin sağlayıcısı öncelikle kendisini MEF bileşeni parçası olarak dışarı aktarmaya ve QuickInfo denetleyicisinin örneğini oluşturmaya hizmet eder. Bu bir MEF bileşeni parçası olduğundan, diğer MEF bileşen parçalarını içeri aktarabilir.

QuickInfo denetleyici sağlayıcısını uygulamak için

uygulayan IIntellisenseControllerProvideradlı TestQuickInfoControllerProvider bir sınıf bildirin ve bunu "ToolTip QuickInfo Controller" ve ContentTypeAttribute "text" ile NameAttribute dışarı aktarın:

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

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

özelliğini bir özellik olarak içeri aktarın IQuickInfoBroker .

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

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

QuickInfo denetleyicisini TryCreateIntellisenseController başlatarak yöntemini uygulayın.

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

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

Kodu derleme ve test etme

Bu kodu test etmek için QuickInfoTest çözümünü derleyin ve deneysel örnekte çalıştırın.

QuickInfoTest çözümünü derlemek ve test etmek için

Çözümü oluşturun.
Bu projeyi hata ayıklayıcıda çalıştırdığınızda, Visual Studio'nun ikinci bir örneği başlatılır.
Bir metin dosyası oluşturun ve "ekle" ve "çıkar" sözcüklerini içeren bir metin yazın.
İşaretçiyi "ekle" örneğinden birinin üzerine getirin. yöntemin imzası ve açıklaması add görüntülenmelidir.

İzlenecek yol: İçerik türünü dosya adı uzantısına bağlama

Aracılığıyla paylaş

İzlenecek yol: QuickInfo araç ipuçlarını görüntüleme

MEF projesi oluşturma

MEF projesi oluşturmak için

QuickInfo kaynağını uygulama

QuickInfo kaynağını uygulamak için

QuickInfo kaynak sağlayıcısı uygulama

QuickInfo kaynak sağlayıcısı uygulamak için

QuickInfo denetleyicisi uygulama

QuickInfo denetleyicisi uygulamak için

QuickInfo denetleyici sağlayıcısını uygulama

QuickInfo denetleyici sağlayıcısını uygulamak için

Kodu derleme ve test etme

QuickInfoTest çözümünü derlemek ve test etmek için

Ek kaynaklar

Aracılığıyla paylaş

İzlenecek yol: QuickInfo araç ipuçlarını görüntüleme

MEF projesi oluşturma

MEF projesi oluşturmak için

QuickInfo kaynağını uygulama

QuickInfo kaynağını uygulamak için

QuickInfo kaynak sağlayıcısı uygulama

QuickInfo kaynak sağlayıcısı uygulamak için

QuickInfo denetleyicisi uygulama

QuickInfo denetleyicisi uygulamak için

QuickInfo denetleyici sağlayıcısını uygulama

QuickInfo denetleyici sağlayıcısını uygulamak için

Kodu derleme ve test etme

QuickInfoTest çözümünü derlemek ve test etmek için

İlgili içerik

Ek kaynaklar