我想编写一个Visual Studio插件，能够拦截默认的在线帮助命令，并在调用类或类型的F1帮助时获取MSDN库的URL。
例如，如果我将光标放在关键字"string"上并按下F1，它通常会自动打开浏览器并导航至"string"引用类型的帮助文档。我想在到达浏览器之前抓取传递给浏览器的URL。
是否可以编写Visual Studio插件/扩展来拦截默认的F1帮助命令？
如果上述内容可行，有没有指南可以作为起点？
Visual Studio 拦截 F1 帮助命令
12
- LukeDevs
1
抓取URL并不会真正起作用。你的情况是什么？ - Jason Malinowski
2个回答
16
大约10年前，当我在微软工作时，我为Visual Studio 2005中的原始“在线F1”功能编写了规范。因此，我的知识有一定权威性，但也可能已经过时。;-)
您无法更改Visual Studio正在使用的URL（至少我不知道如何更改），但您可以编写另一个插件，窃取F1键绑定，使用与默认F1处理程序相同的帮助上下文，并将用户重定向到自己的URL或应用程序。
首先，一些关于Online F1工作方式的信息：
Visual Studio IDE的组件将关键字推送到“F1帮助上下文”，这是有关用户正在进行的操作的信息属性包：例如，在代码编辑器中当前选择，正在编辑的文件类型，正在编辑的项目类型等。
当用户按F1时，IDE将该帮助上下文打包成一个URL，并打开指向MSDN的浏览器。
以下是示例URL，在此示例中，在VS2012 HTML编辑器中选择CSS属性“width”时按F1：
msdn.microsoft.com/query/dev11.query?
appId=Dev11IDEF1&
l=EN-US&
k=k(width);
k(vs.csseditor);
k(TargetFrameworkMoniker-.NETFramework,Version%3Dv4.0);
k(DevLang-CSS)&
rd=true
以上的"k"参数包含了Visual Studio中的帮助上下文。帮助上下文包含了一些"关键字"(文本字符串)和"属性"(名称/值对)，不同的Visual Studio窗口使用它来告诉IDE用户正在做什么。
CSS编辑器提供了两个关键字："width"是我选择的，"vs.csseditor"可作为MSDN的"备选项"，例如当我的选择在MSDN上找不到时，可以使用该关键字。
还有一些上下文过滤属性：
TargetFrameworkMoniker = NETFramework,Version=v4.0
DevLang=CSS
这些确保F1加载正确语言或技术的页面，本例中为CSS。（另一个过滤器.NET 4.0存在是因为我所加载的项目是以.NET 4.0为目标平台）
请注意上下文的顺序。"width"关键字比下面的关键字更重要。
MSDN上的实际帮助内容具有元数据（由编写文档的团队手动设置），其中包含与该页面关联的关键字和名称/值上下文属性。例如，在MSDN上存储的css width property documentation，与之关联的关键字列表（在本例中为："width"）和上下文属性列表（在本例中为："DevLang=CSS"）。页面可以具有多个关键字（例如"System.String"，"String"）和多个上下文属性（例如"DevLang=C#"，"DevLang=VB"等）。
当关键字列表到达MSDN在线F1服务时，算法如下，并且它可能已经在过去几年中发生了变化：
- 取第一个关键字
- 找到与该关键字匹配的所有页面
- 排除所有具有上下文属性名称匹配项（例如"DevLang"）但没有值匹配项的页面。例如，这将排除Control.Width页面，因为它将被标记为"DevLang=C#"，"DevLang=VB"。但是不会排除没有DevLang属性的页面。
- 如果没有结果剩下，但还有更多关键字剩余，则重新从#1开始使用下一个关键字（按顺序），除非你已经用完关键字了。如果没有剩余关键字，则执行"备份"操作，这可能是返回MSDN搜索结果列表，显示"无法找到页面"，或者其他解决方案。
- 对剩余结果进行排名。我不记得确切的排名算法，而且它可能已经改变了，但我相信一般思路是先显示匹配更多属性的页面，然后先显示更受欢迎的匹配项。
- 在浏览器中显示最顶部的结果
以下是Visual Studio插件如何完成以下操作的代码示例：
- 接管F1键绑定
- 按下F1时，获取帮助上下文并将其转换为一组名称=值对
- 将该名称=值对集传递到某些外部代码中，以处理F1请求。
我忽略了所有Visual Studio插件样板代码--如果你也需要，应该可以在Google中找到很多示例。
using System;
using Extensibility;
using EnvDTE;
using EnvDTE80;
using Microsoft.VisualStudio.CommandBars;
using System.Resources;
using System.Reflection;
using System.Globalization;
using System.Collections;
using System.Collections.Generic;
using System.Text;
namespace ReplaceF1
{
/// <summary>The object for implementing an Add-in.</summary>
/// <seealso class='IDTExtensibility2' />
public class Connect : IDTExtensibility2, IDTCommandTarget
{
/// <summary>Implements the constructor for the Add-in object. Place your initialization code within this method.</summary>
public Connect()
{
}
MsdnExplorer.MainWindow Explorer = new MsdnExplorer.MainWindow();
/// <summary>Implements the OnConnection method of the IDTExtensibility2 interface. Receives notification that the Add-in is being loaded.</summary>
/// <param term='application'>Root object of the host application.</param>
/// <param term='connectMode'>Describes how the Add-in is being loaded.</param>
/// <param term='addInInst'>Object representing this Add-in.</param>
/// <seealso class='IDTExtensibility2' />
public void OnConnection(object application, ext_ConnectMode connectMode, object addInInst, ref Array custom)
{
_applicationObject = (DTE2)application;
_addInInstance = (AddIn)addInInst;
if(connectMode == ext_ConnectMode.ext_cm_UISetup)
{
object []contextGUIDS = new object[] { };
Commands2 commands = (Commands2)_applicationObject.Commands;
string toolsMenuName;
try
{
// If you would like to move the command to a different menu, change the word "Help" to the
// English version of the menu. This code will take the culture, append on the name of the menu
// then add the command to that menu. You can find a list of all the top-level menus in the file
// CommandBar.resx.
ResourceManager resourceManager = new ResourceManager("ReplaceF1.CommandBar", Assembly.GetExecutingAssembly());
CultureInfo cultureInfo = new System.Globalization.CultureInfo(_applicationObject.LocaleID);
string resourceName = String.Concat(cultureInfo.TwoLetterISOLanguageName, "Help");
toolsMenuName = resourceManager.GetString(resourceName);
}
catch
{
//We tried to find a localized version of the word Tools, but one was not found.
// Default to the en-US word, which may work for the current culture.
toolsMenuName = "Help";
}
//Place the command on the tools menu.
//Find the MenuBar command bar, which is the top-level command bar holding all the main menu items:
Microsoft.VisualStudio.CommandBars.CommandBar menuBarCommandBar = ((Microsoft.VisualStudio.CommandBars.CommandBars)_applicationObject.CommandBars)["MenuBar"];
//Find the Tools command bar on the MenuBar command bar:
CommandBarControl toolsControl = menuBarCommandBar.Controls[toolsMenuName];
CommandBarPopup toolsPopup = (CommandBarPopup)toolsControl;
//This try/catch block can be duplicated if you wish to add multiple commands to be handled by your Add-in,
// just make sure you also update the QueryStatus/Exec method to include the new command names.
try
{
//Add a command to the Commands collection:
Command command = commands.AddNamedCommand2(_addInInstance,
"ReplaceF1",
"MSDN Advanced F1",
"Brings up context-sensitive Help via the MSDN Add-in",
true,
59,
ref contextGUIDS,
(int)vsCommandStatus.vsCommandStatusSupported+(int)vsCommandStatus.vsCommandStatusEnabled,
(int)vsCommandStyle.vsCommandStylePictAndText,
vsCommandControlType.vsCommandControlTypeButton);
command.Bindings = new object[] { "Global::F1" };
}
catch(System.ArgumentException)
{
//If we are here, then the exception is probably because a command with that name
// already exists. If so there is no need to recreate the command and we can
// safely ignore the exception.
}
}
}
/// <summary>Implements the OnDisconnection method of the IDTExtensibility2 interface. Receives notification that the Add-in is being unloaded.</summary>
/// <param term='disconnectMode'>Describes how the Add-in is being unloaded.</param>
/// <param term='custom'>Array of parameters that are host application specific.</param>
/// <seealso class='IDTExtensibility2' />
public void OnDisconnection(ext_DisconnectMode disconnectMode, ref Array custom)
{
}
/// <summary>Implements the OnAddInsUpdate method of the IDTExtensibility2 interface. Receives notification when the collection of Add-ins has changed.</summary>
/// <param term='custom'>Array of parameters that are host application specific.</param>
/// <seealso class='IDTExtensibility2' />
public void OnAddInsUpdate(ref Array custom)
{
}
/// <summary>Implements the OnStartupComplete method of the IDTExtensibility2 interface. Receives notification that the host application has completed loading.</summary>
/// <param term='custom'>Array of parameters that are host application specific.</param>
/// <seealso class='IDTExtensibility2' />
public void OnStartupComplete(ref Array custom)
{
}
/// <summary>Implements the OnBeginShutdown method of the IDTExtensibility2 interface. Receives notification that the host application is being unloaded.</summary>
/// <param term='custom'>Array of parameters that are host application specific.</param>
/// <seealso class='IDTExtensibility2' />
public void OnBeginShutdown(ref Array custom)
{
}
/// <summary>Implements the QueryStatus method of the IDTCommandTarget interface. This is called when the command's availability is updated</summary>
/// <param term='commandName'>The name of the command to determine state for.</param>
/// <param term='neededText'>Text that is needed for the command.</param>
/// <param term='status'>The state of the command in the user interface.</param>
/// <param term='commandText'>Text requested by the neededText parameter.</param>
/// <seealso class='Exec' />
public void QueryStatus(string commandName, vsCommandStatusTextWanted neededText, ref vsCommandStatus status, ref object commandText)
{
if(neededText == vsCommandStatusTextWanted.vsCommandStatusTextWantedNone)
{
if(commandName == "ReplaceF1.Connect.ReplaceF1")
{
status = (vsCommandStatus)vsCommandStatus.vsCommandStatusSupported|vsCommandStatus.vsCommandStatusEnabled;
return;
}
}
}
/// <summary>Implements the Exec method of the IDTCommandTarget interface. This is called when the command is invoked.</summary>
/// <param term='commandName'>The name of the command to execute.</param>
/// <param term='executeOption'>Describes how the command should be run.</param>
/// <param term='varIn'>Parameters passed from the caller to the command handler.</param>
/// <param term='varOut'>Parameters passed from the command handler to the caller.</param>
/// <param term='handled'>Informs the caller if the command was handled or not.</param>
/// <seealso class='Exec' />
public void Exec(string commandName, vsCommandExecOption executeOption, ref object varIn, ref object varOut, ref bool handled)
{
if(executeOption == vsCommandExecOption.vsCommandExecOptionDoDefault)
{
if (commandName == "ReplaceF1.Connect.ReplaceF1")
{
// Get a reference to Solution Explorer.
Window activeWindow = _applicationObject.ActiveWindow;
ContextAttributes contextAttributes = activeWindow.DTE.ContextAttributes;
contextAttributes.Refresh();
List<string> attributes = new List<string>();
try
{
ContextAttributes highPri = contextAttributes == null ? null : contextAttributes.HighPriorityAttributes;
highPri.Refresh();
if (highPri != null)
{
foreach (ContextAttribute CA in highPri)
{
List<string> values = new List<string>();
foreach (string value in (ICollection)CA.Values)
{
values.Add(value);
}
string attribute = CA.Name + "=" + String.Join(";", values.ToArray());
attributes.Add(CA.Name + "=");
}
}
}
catch (System.Runtime.InteropServices.COMException e)
{
// ignore this exception-- means there's no High Pri values here
string x = e.Message;
}
catch (System.Reflection.TargetInvocationException e)
{
// ignore this exception-- means there's no High Pri values here
string x = e.Message;
}
catch (System.Exception e)
{
System.Windows.Forms.MessageBox.Show(e.Message);
// ignore this exception-- means there's no High Pri values here
string x = e.Message;
}
// fetch context attributes that are not high-priority
foreach (ContextAttribute CA in contextAttributes)
{
List<string> values = new List<string>();
foreach (string value in (ICollection)CA.Values)
{
values.Add (value);
}
string attribute = CA.Name + "=" + String.Join(";", values.ToArray());
attributes.Add (attribute);
}
// Replace this call with whatever you want to do with the help context info
HelpHandler.HandleF1 (attributes);
}
}
}
private DTE2 _applicationObject;
private AddIn _addInInstance;
}
}
- Justin Grant
1
1感谢关于ContextAttributes的信息。我可以在Nuget Package Management Console中轻松使用"$dte.ContextAttributes"来查看上下文，太棒了！ - wangzq
-2
这一切都非常令人兴奋，但潜在地过于工程化了吗？ 像大多数人一样，我有一个可编程鼠标。我已经将其中一个按钮设置为搜索。也就是说，点击单词，浏览器会在喜爱的搜索引擎中打开该单词。通常MSDN帮助文档和SO链接都在列表中。我喜欢有效和简单的解决方案 :-)
- phil soady
网页内容由stack overflow 提供, 点击上面的可以查看英文原文，
原文链接
原文链接