将鼠标悬停在文本上时显示工具提示

Question

我想创建允许在我将鼠标悬停在文本上时显示自定义消息的扩展程序。

例如"test-text" 应该给出工具提示 "OK" 而不是当前的 "ITrackin..."

我试着关注 https://docs.microsoft.com/en-us/visualstudio/extensibility/walkthrough-displaying-quickinfo-tooltips?view=vs-2019 但人们说它不起作用，而且要做到这一点需要很长的路要走。

我找不到更多关于此的文档。我知道如何在单击 window/get 当前选定的文本中显示它。

Answer 1

Lance Li-MSFT 发送的样本确实很有帮助，但为了让它正常工作，我不得不花一些时间。

重要步骤：

导入 LineAsyncQuickInfoSourceProvider.cs 和 LineAsyncQuickInfoSource.cs
通过添加引用对话框添加对 System.ComponentModel.Composition 的引用（右键单击项目名称）
通过使用 NuGet 包管理器安装它们来获取丢失的引用
要初始化 MEF 组件，您需要将新资产添加到 source.extension.vsixmanifest。

<Assets>
    ...
    <Asset Type = "Microsoft.VisualStudio.MefComponent" d:Source="Project" d:ProjectName="%CurrentProject%" Path="|%CurrentProject%|" />
</Assets>

LineAsyncQuickInfoSourceProvider.cs

只是用来快速显示info/tooltip。

using Microsoft.VisualStudio.Language.Intellisense;
using Microsoft.VisualStudio.Text;
using Microsoft.VisualStudio.Utilities;
using System.ComponentModel.Composition;

namespace JSONExtension
{
    [Export(typeof(IAsyncQuickInfoSourceProvider))]
    [Name("Line Async Quick Info Provider")]
    [ContentType("any")]
    [Order]
    internal sealed class LineAsyncQuickInfoSourceProvider : IAsyncQuickInfoSourceProvider
    {
        public IAsyncQuickInfoSource TryCreateQuickInfoSource(ITextBuffer textBuffer) //creates instance of LineAsyncQuickInfoSource for displaying Quick Info
        {  
            return textBuffer.Properties.GetOrCreateSingletonProperty(() => new LineAsyncQuickInfoSource(textBuffer)); //this ensures only one instance per textbuffer is created
        }
    }
}

LineAsyncQuickInfoSource.cs

在这里您可以自定义要显示的内容。

using Microsoft.VisualStudio.Language.Intellisense;
using Microsoft.VisualStudio.Language.StandardClassification;
using Microsoft.VisualStudio.Text;
using Microsoft.VisualStudio.Text.Adornments;
using Newtonsoft.Json;
using Newtonsoft.Json.Linq;
using System.Collections.Generic;
using System.IO;
using System.Threading;
using System.Threading.Tasks;

namespace JSONExtension
{
    internal sealed class LineAsyncQuickInfoSource : IAsyncQuickInfoSource
    {
        private ITextBuffer _textBuffer;

        public LineAsyncQuickInfoSource(ITextBuffer textBuffer)
        {
            _textBuffer = textBuffer;
        }

        // This is called on a background thread.
        public Task<QuickInfoItem> GetQuickInfoItemAsync(IAsyncQuickInfoSession session, CancellationToken cancellationToken)
        {
            var triggerPoint = session.GetTriggerPoint(_textBuffer.CurrentSnapshot);

            if (triggerPoint != null)
            {
                var line = triggerPoint.Value.GetContainingLine();
                var lineSpan = _textBuffer.CurrentSnapshot.CreateTrackingSpan(line.Extent, SpanTrackingMode.EdgeInclusive);
                var text = triggerPoint.Value.GetContainingLine().GetText(); //get whole line of current cursor pos

                ContainerElement dataElm = new ContainerElement(
                ContainerElementStyle.Stacked,
                new ClassifiedTextElement(
                    new ClassifiedTextRun(PredefinedClassificationTypeNames.Keyword, "MESSAGE TO EDIT: " + text.ToString())
                ));
                return Task.FromResult(new QuickInfoItem(lineSpan, dataElm)); //add custom text from above to Quick Info
            }

            return Task.FromResult<QuickInfoItem>(null); //do not add anything to Quick Info
        }
        public void Dispose()
        {
            // This provider does not perform any cleanup.
        }
    }
}

将鼠标悬停在文本上时显示工具提示

Show tooltip on hover over text

visual-studio

vsix

visual-studio-extensions