4.7添加到工具窗口搜索

来源：互联网发布：json 20160212.jar 编辑：程序博客网时间：2024/06/07 00:06

添加到工具窗口搜索

Visual Studio 2015

其他版本

若要了解有关 Visual Studio 2017 RC 的最新文档，请参阅 Visual Studio 2017 RC 文档。

当创建或更新您的扩展中的一个工具窗口时，可以在 Visual Studio 中添加相同的搜索功能在其他位置出现。此功能包括以下功能︰

在工具栏上的自定义区域始终位于一个搜索框。
在搜索框本身叠加一个进度指示器。
只要输入每个字符（即时搜索），或者只有在选择 Enter 键（按需搜索）后，才显示结果的功能。
显示为其已搜索到的最新的术语列表。
筛选搜索的特定字段或搜索目标的各个方面的能力。

通过遵循本演练，您将学习如何执行以下任务︰

创建 VSPackage 项目。
创建一个包含与只读文本框 UserControl 的工具窗口。
将搜索框添加到工具窗口中。
添加搜索实现。
启用即时搜索和显示一个进度栏。
添加区分大小写选项。
添加搜索偶数行仅筛选器。

创建 VSIX 项目

创建一个名为的 VSIX 项目TestToolWindowSearch与名为工具窗口TestSearch。如果你在执行此操作时需要帮助，请参阅 Creating an Extension with a Tool Window。

若要创建一个工具窗口

在TestToolWindowSearch项目中，打开 TestSearchControl.xaml 文件。

替换现有<StackPanel>块以与下面的块，也就是添加一个只读的TextBox到UserControl工具窗口中。

XAML
<StackPanel Orientation="Vertical">      <TextBox Name="resultsTextBox" Height="800.0"          Width="800.0"          IsReadOnly="True">      </TextBox>  </StackPanel>  

在 TestSearchControl.xaml.cs 文件中，添加以下 using 语句︰
C#
using System.Text;

删除button1_Click()方法。

在TestSearchControl类中，添加下面的代码。

此代码将添加一个公共TextBox属性名为SearchResultsTextBox和一个名为的公共字符串属性SearchContent。在构造函数中，SearchResultsTextBox 设置为文本框中，同时 SearchContent 初始化到一组换行分隔的字符串。文本框中的内容也将初始化为字符串集。

C#
public partial class TestSearchControl : UserControl  {      public TextBox SearchResultsTextBox { get; set; }      public string SearchContent { get; set; }      public TestSearchControl()      {          InitializeComponent();          this.SearchResultsTextBox = resultsTextBox;          this.SearchContent = BuildContent();          this.SearchResultsTextBox.Text = this.SearchContent;      }      private string BuildContent()      {          StringBuilder sb = new StringBuilder();          sb.AppendLine("1 go");          sb.AppendLine("2 good");          sb.AppendLine("3 Go");          sb.AppendLine("4 Good");          sb.AppendLine("5 goodbye");          sb.AppendLine("6 Goodbye");          return sb.ToString();      }  }  

C#
VB
    public partial class MyControl : UserControl    {        public TextBox SearchResultsTextBox { get; set; }        public string SearchContent { get; set; }        public MyControl()        {            InitializeComponent();            this.SearchResultsTextBox = resultsTextBox;            this.SearchContent = BuildContent();            this.SearchResultsTextBox.Text = this.SearchContent;        }        private string BuildContent()        {            StringBuilder sb = new StringBuilder();            sb.AppendLine("1 go");            sb.AppendLine("2 good");            sb.AppendLine("3 Go");            sb.AppendLine("4 Good");            sb.AppendLine("5 goodbye");            sb.AppendLine("6 Goodbye");            return sb.ToString();        }    }

生成项目并启动调试。将显示 Visual Studio 的实验实例。
在菜单栏上依次选择视图，其他窗口， TestSearch。
工具窗口中显示，但搜索控件不显示。

若要将搜索框添加到工具窗口

在 TestSearch.cs 文件中，添加以下代码到TestSearch类。该代码重写SearchEnabled属性，以便 get 访问器返回true。
若要启用搜索，必须重写SearchEnabled属性。 ToolWindowPane类实现IVsWindowSearch ，并提供一个默认实现，不能通过搜索。
C#
public override bool SearchEnabled { get { return true; } }
生成项目并启动调试。将显示的实验实例。
在 Visual Studio 的实验实例中，打开TestSearch。
在工具窗口的顶部，将出现与的搜索控件搜索水印和放大玻璃图标。但是，搜索不工作，还因为尚未实现对搜索过程。

若要添加的搜索实现

如果在启用搜索ToolWindowPane，如在上一过程中，工具窗口创建搜索主机。该主机将设置和管理搜索过程，始终在后台线程发生。因为ToolWindowPane类管理搜索主机和设置创建向上搜索的只需要创建搜索任务，然后提供搜索方法。搜索过程发生在后台线程，并在 UI 线程上发生了对工具窗口控件调用。因此，必须使用M:Microsoft.VisualStudio.Shell.ThreadHelper.Invoke``1 (System.Func`1)方法来管理在该控件处理中所做的任何调用。

在 TestSearch.cs 文件中，添加以下using语句︰

C#
using System;  using System.Collections.Generic;  using System.Runtime.InteropServices;  using System.Text;  using System.Windows.Controls;  using Microsoft.Internal.VisualStudio.PlatformUI;  using Microsoft.VisualStudio;  using Microsoft.VisualStudio.PlatformUI;  using Microsoft.VisualStudio.Shell;  using Microsoft.VisualStudio.Shell.Interop;  

在TestSearch类中，添加下面的代码执行下列操作︰

重写CreateSearch方法来创建搜索任务。
重写ClearSearch方法，以还原文本框中的状态。当用户取消搜索任务和用户设置或取消设置选项或筛选器时，调用此方法。同时CreateSearch和ClearSearch在 UI 线程上调用程序。因此，您不需要访问通过文本框M:Microsoft.VisualStudio.Shell.ThreadHelper.Invoke``1 (System.Func`1)方法。
创建一个类的名为TestSearchTask，该类继承自VsSearchTask，该属性提供的默认实现IVsSearchTask。
在TestSearchTask，该构造函数设置引用工具窗口中的私有字段。若要提供的搜索方法，重写OnStartSearch和OnStopSearch方法。 OnStartSearch方法就是其中实现了搜索进程。此过程包括执行搜索，在文本框中显示搜索结果以及调用此方法以报告完成搜索后的基类实现。

C#
public override IVsSearchTask CreateSearch(uint dwCookie, IVsSearchQuery pSearchQuery, IVsSearchCallback pSearchCallback)  {      if (pSearchQuery == null || pSearchCallback == null)          return null;       return new TestSearchTask(dwCookie, pSearchQuery, pSearchCallback, this);  }  public override void ClearSearch()  {      TestSearchControl control = (TestSearchControl)this.Content;      control.SearchResultsTextBox.Text = control.SearchContent;  }  internal class TestSearchTask : VsSearchTask  {      private TestSearch m_toolWindow;      public TestSearchTask(uint dwCookie, IVsSearchQuery pSearchQuery, IVsSearchCallback pSearchCallback, TestSearch toolwindow)          : base(dwCookie, pSearchQuery, pSearchCallback)      {          m_toolWindow = toolwindow;      }      protected override void OnStartSearch()      {          // Use the original content of the text box as the target of the search.           var separator = new string[] { Environment.NewLine };          TestSearchControl control = (TestSearchControl)m_toolWindow.Content;          string[] contentArr = control.SearchContent.Split(separator, StringSplitOptions.None);          // Get the search option.           bool matchCase = false;          // matchCase = m_toolWindow.MatchCaseOption.Value;               // Set variables that are used in the finally block.              StringBuilder sb = new StringBuilder("");              uint resultCount = 0;              this.ErrorCode = VSConstants.S_OK;              try              {                  string searchString = this.SearchQuery.SearchString;                  // Determine the results.                   uint progress = 0;                  foreach (string line in contentArr)                  {                      if (matchCase == true)                      {                          if (line.Contains(searchString))                          {                              sb.AppendLine(line);                              resultCount++;                          }                      }                      else                          {                              if (line.ToLower().Contains(searchString.ToLower()))                              {                                  sb.AppendLine(line);                                  resultCount++;                              }                          }                          // SearchCallback.ReportProgress(this, progress++, (uint)contentArr.GetLength(0));                           // Uncomment the following line to demonstrate the progress bar.                           // System.Threading.Thread.Sleep(100);                      }                  }                  catch (Exception e)                  {                      this.ErrorCode = VSConstants.E_FAIL;                  }                  finally                  {                      ThreadHelper.Generic.Invoke(() =>                      { ((TextBox)((TestSearchControl)m_toolWindow.Content).SearchResultsTextBox).Text = sb.ToString(); });                      this.SearchResults = resultCount;                  }          // Call the implementation of this method in the base class.           // This sets the task status to complete and reports task completion.           base.OnStartSearch();      }      protected override void OnStopSearch()      {          this.SearchResults = 0;      }  }  

通过执行以下步骤来测试您搜索的实现︰
1. 重新生成项目并启动调试。
2. 在 Visual Studio 的实验实例中，再次打开工具窗口、搜索窗口中输入一些搜索文本和单击 ENTER。
  应显示正确的结果。

若要自定义搜索行为

通过更改搜索设置，可以在搜索控件的显示方式和搜索执行方式进行各种更改。例如，可以更改水印（在搜索框中显示的默认文本）、所需的最低和最大宽度的搜索控件，以及是否显示一个进度栏。此外可以更改的点开始（按需或即时搜索中）显示的搜索结果以及是否显示为其最近搜索到的术语列表。您可以找到中设置的完整列表SearchSettingsDataSource类。

在 TestSearch.cs 文件中，添加以下代码到TestSearch类。此代码启用即时搜索而不是按需搜索（用户无需单击输入的含义）。该代码重写ProvideSearchSettings中的方法TestSearch类，该类是需要更改默认设置。
C#
public override void ProvideSearchSettings(IVsUIDataSource pSearchSettings) { Utilities.SetValue(pSearchSettings, SearchSettingsDataSource.SearchStartTypeProperty.Name, (uint)VSSEARCHSTARTTYPE.SST_INSTANT);}
测试新设置重新生成解决方案并重新启动调试器。
搜索结果将显示每次您在搜索框中输入一个字符。

在ProvideSearchSettings方法中，添加以下行，可以显示一个进度栏。

C#
public override void ProvideSearchSettings(IVsUIDataSource pSearchSettings)  {      Utilities.SetValue(pSearchSettings,           SearchSettingsDataSource.SearchStartTypeProperty.Name,            (uint)VSSEARCHSTARTTYPE.SST_INSTANT);      Utilities.SetValue(pSearchSettings,           SearchSettingsDataSource.SearchProgressTypeProperty.Name,            (uint)VSSEARCHPROGRESSTYPE.SPT_DETERMINATE);  }  

若要显示的进度条，必须报告进度。若要报告进度，请取消注释下面的代码OnStartSearch方法TestSearchTask类︰

C#
SearchCallback.ReportProgress(this, progress++, (uint)contentArr.GetLength(0));  

缓慢足够的处理进度条是否可见，请取消注释中的以下行将OnStartSearch方法TestSearchTask类︰
C#
System.Threading.Thread.Sleep(100);
通过重新生成解决方案并启动到 debugb 测试新的设置。
进度栏出现在搜索窗口（作为一条蓝线下方的搜索文本框）每次执行搜索。

若要使用户能够改进其搜索

您可以允许用户以如通过选项来优化其搜索区分大小写或全字匹配。选项可以是布尔值，它显示为复选框或显示为按钮的命令。对于本演练，你将创建一个布尔值的选项。

在 TestSearch.cs 文件中，添加以下代码到TestSearch类。该代码重写SearchOptionsEnum方法，它允许搜索实现来检测到给定的选项是开还是关。中的代码SearchOptionsEnum中添加一个选项以匹配用例与IVsEnumWindowSearchOptions枚举器。区分大小写的选项都还可作为MatchCaseOption属性。

C#
private IVsEnumWindowSearchOptions m_optionsEnum;  public override IVsEnumWindowSearchOptions SearchOptionsEnum  {      get      {          if (m_optionsEnum == null)          {              List<IVsWindowSearchOption> list = new List<IVsWindowSearchOption>();              list.Add(this.MatchCaseOption);              m_optionsEnum = new WindowSearchOptionEnumerator(list) as IVsEnumWindowSearchOptions;          }          return m_optionsEnum;      }  }  private WindowSearchBooleanOption m_matchCaseOption;  public WindowSearchBooleanOption MatchCaseOption  {      get      {          if (m_matchCaseOption == null)          {              m_matchCaseOption = new WindowSearchBooleanOption("Match case", "Match case", false);          }          return m_matchCaseOption;      }  }  

在TestSearchTask类中，取消注释中的 matchCase 行OnStartSearch方法︰

C#
private IVsEnumWindowSearchOptions m_optionsEnum;  public override IVsEnumWindowSearchOptions SearchOptionsEnum  {      get      {          if (m_optionsEnum == null)          {              List<IVsWindowSearchOption> list = new List<IVsWindowSearchOption>();              list.Add(this.MatchCaseOption);              m_optionsEnum = new WindowSearchOptionEnumerator(list) as IVsEnumWindowSearchOptions;          }          return m_optionsEnum;      }  }  private WindowSearchBooleanOption m_matchCaseOption;  public WindowSearchBooleanOption MatchCaseOption  {      get       {          if (m_matchCaseOption == null)          {              m_matchCaseOption = new WindowSearchBooleanOption("Match case", "Match case", false);          }          return m_matchCaseOption;      }  }  

测试选项︰
1. 生成项目并启动调试。将显示的实验实例。
2. 在工具窗口中，选择文本框右侧的向下箭头。
  区分大小写显示复选框。
3. 选择区分大小写复选框，然后再执行某些搜索。

若要添加的搜索筛选器

您可以添加允许用户优化的搜索目标组的搜索筛选器。例如，您可以按依据其进行了修改最新的日期和各个文件扩展名筛选文件资源管理器中的文件。在本演练中，您将添加甚至只为行筛选器。当用户选择该筛选器时，搜索主机会将您指定的字符串添加到搜索查询。然后可以识别这些字符串内搜索方法，并相应地进行筛选的搜索目标。

在 TestSearch.cs 文件中，添加以下代码到TestSearch类。该代码会实施SearchFiltersEnum通过添加WindowSearchSimpleFilter ，指定要筛选搜索结果，以便只偶数行显示。
C#
public override IVsEnumWindowSearchFilters SearchFiltersEnum { get { List<IVsWindowSearchFilter> list = new List<IVsWindowSearchFilter>(); list.Add(new WindowSearchSimpleFilter("Search even lines only", "Search even lines only", "lines", "even")); return new WindowSearchFilterEnumerator(list) as IVsEnumWindowSearchFilters; } }
现在，搜索控件显示的搜索筛选器Search even lines only。当用户选择的筛选器，该字符串lines:"even"出现在搜索框。其他搜索条件可以出现在同一时间作为筛选器。搜索字符串后和 / 或筛选器中，情况下可能出现在筛选器中之前,。

在 TestSearch.cs 文件中，添加以下方法向TestSearchTask类，该类是在TestSearch类。这些方法还支持OnStartSearch方法，您将在下一步，修改。

C#
private string RemoveFromString(string origString, string stringToRemove)  {      int index = origString.IndexOf(stringToRemove);      if (index == -1)          return origString;      else            return (origString.Substring(0, index) + origString.Substring(index + stringToRemove.Length)).Trim();  }  private string[] GetEvenItems(string[] contentArr)  {      int length = contentArr.Length / 2;      string[] evenContentArr = new string[length];      int indexB = 0;      for (int index = 1; index < contentArr.Length; index += 2)      {          evenContentArr[indexB] = contentArr[index];          indexB++;      }      return evenContentArr;  }  

在TestSearchTask类中，更新OnStartSearch方法替换为以下代码。这一更改更新代码以支持该筛选器。

C#
protected override void OnStartSearch()  {      // Use the original content of the text box as the target of the search.       var separator = new string[] { Environment.NewLine };      string[] contentArr = ((TestSearchControl)m_toolWindow.Content).SearchContent.Split(separator, StringSplitOptions.None);      // Get the search option.       bool matchCase = false;      matchCase = m_toolWindow.MatchCaseOption.Value;      // Set variables that are used in the finally block.      StringBuilder sb = new StringBuilder("");      uint resultCount = 0;      this.ErrorCode = VSConstants.S_OK;      try      {          string searchString = this.SearchQuery.SearchString;          // If the search string contains the filter string, filter the content array.           string filterString = "lines:\"even\"";          if (this.SearchQuery.SearchString.Contains(filterString))          {              // Retain only the even items in the array.              contentArr = GetEvenItems(contentArr);              // Remove 'lines:"even"' from the search string.              searchString = RemoveFromString(searchString, filterString);          }          // Determine the results.           uint progress = 0;          foreach (string line in contentArr)          {              if (matchCase == true)              {                  if (line.Contains(searchString))                  {                      sb.AppendLine(line);                      resultCount++;                  }              }              else              {                  if (line.ToLower().Contains(searchString.ToLower()))                  {                      sb.AppendLine(line);                      resultCount++;                  }              }              SearchCallback.ReportProgress(this, progress++, (uint)contentArr.GetLength(0));              // Uncomment the following line to demonstrate the progress bar.               // System.Threading.Thread.Sleep(100);          }      }      catch (Exception e)      {          this.ErrorCode = VSConstants.E_FAIL;      }      finally      {          ThreadHelper.Generic.Invoke(() =>          { ((TextBox)((TestSearchControl)m_toolWindow.Content).SearchResultsTextBox).Text = sb.ToString(); });          this.SearchResults = resultCount;      }      // Call the implementation of this method in the base class.       // This sets the task status to complete and reports task completion.       base.OnStartSearch();  }  

测试您的代码。
生成项目并启动调试。在 Visual Studio 的实验实例中，打开工具窗口，然后选择搜索控件上的向下箭头。
区分大小写复选框和搜索偶数行仅筛选器应显示。
选择筛选器。
搜索框包含行:"偶数"，并且显示以下结果︰
2 工作正常
4 良好
6 再见
删除lines:"even"从搜索框中，选择区分大小写复选框，然后再输入g搜索框中。
显示以下结果︰
1 转到
2 工作正常
5 再见
选择搜索框右侧的 X。
清除搜索，并显示原始内容。但是，区分大小写复选框仍处于选中状态。

阅读全文

0 0