ツールウィンドウへの検索の追加

[アーティクル]
03/10/2023

拡張機能でツールウィンドウを作成または更新する際には、Visual Studio の他の場所に表示されるのと同じ検索機能を追加できます。この機能には次の機能が含まれています:

ツールバーのカスタム領域に常に配置される検索ボックス。
検索ボックス自体に重ねて表示される進行状況インジケーター。
各文字を入力するとすぐに結果が表示される機能 (クイック検索)、または Enter キーを押した後にのみ結果が表示される機能 (オンデマンド検索)。
最近検索した用語を示す一覧。
検索対象の特定のフィールドまたは要素によって検索をフィルター処理する機能。

このチュートリアルでは、次のタスクを実行する方法を学習します。

VSPackage プロジェクトを作成します。
読み取り専用の TextBox を使った UserControl が含まれるツールウィンドウを作成する。
ツールウィンドウに検索ボックスを追加する。
検索の実装を追加する。
クイック検索を有効にし、進行状況バーを表示する。
[大文字と小文字を区別する] オプションを追加する。
[偶数行のみを検索する] フィルターを追加する。

VSIX プロジェクトを作成するには

TestSearch という名前のツールウィンドウを使って、TestToolWindowSearch という名前の VSIX プロジェクトを作成します。この作業の説明が必要な場合は、「ツールウィンドウでの拡張機能の作成」を参照してください。

ツールウィンドウを作成するには

TestToolWindowSearch プロジェクトで、TestSearchControl.xaml ファイルを開きます。
既存の <StackPanel> ブロックを次のブロックに置き換えます。これにより、ツールウィンドウの UserControl に読み取り専用の TextBox が追加されます。
```
<StackPanel Orientation="Vertical">
    <TextBox Name="resultsTextBox" Height="800.0"
        Width="800.0"
        IsReadOnly="True">
    </TextBox>
</StackPanel>
```
TestSearchControl.xaml.cs ファイルで、次の using ディレクティブを追加します。
```
using System.Text;
```

button1_Click() メソッドを削除します。

TestSearchControl クラスで、次のコードを追加します。

このコードにより、SearchResultsTextBox という名前のパブリック TextBox プロパティと、SearchContent という名前のパブリック文字列プロパティが追加されます。コンストラクターでは、SearchResultsTextBox がテキストボックスに設定され、SearchContent は、改行で区切られた一連の文字列に初期化されます。テキストボックスの内容も、一連の文字列に初期化されます。

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

Partial Public Class MyControl
    Inherits System.Windows.Controls.UserControl

    Public Property SearchResultsTextBox As System.Windows.Controls.TextBox
    Public Property SearchContent As String

    Public Sub New()

        ' This call is required by the designer.
        InitializeComponent()

        ' Add any initialization after the InitializeComponent() call.
        Me.SearchResultsTextBox = resultsTextBox
        Me.SearchContent = buildContent

        Me.SearchResultsTextBox.Text = Me.SearchContent
    End Sub

    Private Function BuildContent() As String
        Dim sb As New System.Text.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()
    End Function
End Class

プロジェクトをビルドし、デバッグを開始します。 Visual Studio の実験用インスタンスが表示されます。
メニューバーで、[表示]>[その他のウィンドウ]>[TestSearch] の順に選択します。

ツールウィンドウが表示されますが、検索コントロールはまだ表示されません。

TestSearch.cs ファイルで、TestSearch クラスに次のコードを追加します。このコードにより、SearchEnabled プロパティがオーバーライドされ、get アクセサーによって true が返されるようになります。

検索を有効にするには、SearchEnabled プロパティをオーバーライドする必要があります。 ToolWindowPane クラスでは IVsWindowSearch が実装され、検索を有効にしない既定の実装が提供されます。
```
public override bool SearchEnabled
{
    get { return true; }
}
```
プロジェクトをビルドし、デバッグを開始します。実験用インスタンスが表示されます。
Visual Studio の実験用インスタンスで、TestSearch を開きます。

ツールウィンドウの上部に検索コントロールが表示され、Search という透かしと虫眼鏡アイコンが表示されます。ただし、検索プロセスが実装されていないため、検索はまだ機能しません。

検索の実装を追加するには

ToolWindowPane での検索を (前述の手順と同様の方法で) 有効にすると、ツールウィンドウによって検索ホストが作成されます。このホストにより、検索プロセスが設定および管理されます。これらのプロセスは、常にバックグラウンドスレッドで実行されます。検索ホストの作成と検索の設定は ToolWindowPane クラスによって管理されるため、必要な操作は、検索タスクを作成し、検索メソッドを提供するだけです。検索プロセスはバックグラウンドスレッドで実行され、ツールウィンドウコントロールの呼び出しは UI スレッド上で発生します。そのため、コントロールを操作するうえで行う一切の呼び出しは、ThreadHelper.Invoke* メソッドを使って管理する必要があります。

TestSearch.cs ファイルで、次の using ディレクティブを追加します。

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 スレッドで呼び出されます。したがって、ThreadHelper.Invoke* メソッドを使用してテキストボックスにアクセスする必要はありません。
VsSearchTask を継承する、TestSearchTask という名前のクラスを作成する。これにより、IVsSearchTask の既定の実装が提供されます。

TestSearchTask では、コンストラクターによって、ツールウィンドウを参照するプライベートフィールドが設定されます。検索メソッドを提供するには、OnStartSearch メソッドと OnStopSearch メソッドをオーバーライドします。 OnStartSearch メソッドは、検索プロセスを実装する場所です。このプロセスでは、検索を実行し、テキストボックスに検索結果を表示し、このメソッドの基本クラスの実装を呼び出して、検索が完了したことを報告します。

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 クラスに次のコードを追加します。このコードでは、オンデマンド検索ではなく、インスタント検索が有効になります (つまり、ユーザーが ENTER キーを押す必要はありません)。このコードにより、TestSearch クラスの ProvideSearchSettings メソッドがオーバーライドされます。これは、既定の設定を変更するために必要です。
```
public override void ProvideSearchSettings(IVsUIDataSource pSearchSettings)
{
    Utilities.SetValue(pSearchSettings,
        SearchSettingsDataSource.SearchStartTypeProperty.Name,
        (uint)VSSEARCHSTARTTYPE.SST_INSTANT);}
```
ソリューションをリビルドし、デバッガーを再起動して、新しい設定をテストします。

検索ボックスに文字を入力するたびに、検索結果が表示されます。

ProvideSearchSettings メソッドに次の行を追加します。これにより、進行状況バーの表示が有効になります。

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

進行状況バーを表示させるには、進行状況を報告する必要があります。進行状況を報告するには、TestSearchTask クラスの OnStartSearch メソッドで次のコードをコメント解除します。

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

処理速度を落として進行状況バーが見えるようにするには、TestSearchTask クラスの OnStartSearch メソッドで次の行のコメントを解除します。
```
System.Threading.Thread.Sleep(100);
```
ソリューションをリビルドし、デバッグを開始して、新しい設定をテストします。

検索を実行するたびに、進行状況バー ([検索] テキストボックスの下の青い線) が検索ウィンドウに表示されます。

ユーザーが検索を絞り込めるようにするには

[大文字と小文字を区別する] や [単語単位での検索] などのオプションを使用して、ユーザーが検索を絞り込めるようにすることもできます。オプションは、ブール値またはコマンドで提供できます。前者はチェックボックスとして、後者はボタンとして表示されます。このチュートリアルでは、ブール値によるオプションを作成します。

TestSearch.cs ファイルで、TestSearch クラスに次のコードを追加します。このコードにより、SearchOptionsEnum メソッドがオーバーライドされます。これにより、指定されたオプションがオンかオフかを検索実装で検出できるようになります。 SearchOptionsEnum のコードでは、大文字と小文字を区別するオプションが IVsEnumWindowSearchOptions 列挙子に追加されています。大文字と小文字を区別するオプションは、MatchCaseOption プロパティとして提供することもできます。

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 クラスで、OnStartSearch メソッドの次の行をコメント解除します。
```
matchCase = m_toolWindow.MatchCaseOption.Value;
```
オプションをテストします。
1. プロジェクトをビルドし、デバッグを開始します。実験用インスタンスが表示されます。
2. ツールウィンドウで、テキストボックスの右側にある下向きの矢印をクリックします。
  
  [Match case]\(大文字と小文字を区別する\) チェックボックスが表示されます。
3. [Match case]\(大文字と小文字を区別する\) チェックボックスをオンにし、いくつかの検索を実行します。

検索フィルターを追加して、ユーザーが検索対象を絞り込めるようにすることができます。たとえば、エクスプローラーで、直近の変更日とファイル名拡張子を使用してファイルをフィルター処理することもできます。このチュートリアルでは、対象を偶数行のみに絞り込むフィルターを追加します。このフィルターをユーザーが選択すると、指定された文字列が検索ホストによって検索クエリに追加されます。その後、検索メソッド内でそれらの文字列を識別し、状況に応じて検索ターゲットをフィルター処理することができます。

TestSearch.cs ファイルで、TestSearch クラスに次のコードを追加します。このコードでは、WindowSearchSimpleFilter を追加することによって SearchFiltersEnum を実装します。これにより、検索結果がフィルター処理され、偶数行だけが表示されるようになります。
```
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 メソッドをサポートしています。

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 メソッドを次のコードで更新します。この変更により、コードがフィルターをサポートするように更新されます。

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 の実験用インスタンスで、ツールウィンドウを開き、検索コントロールの下矢印をクリックします。

[Match case]\(大文字と小文字を区別する\) チェックボックスと [Search even lines only]\(偶数行のみを検索する\) フィルターが表示されます。
フィルターを選択します。

検索ボックスに lines:"even" が含められ、次の結果が表示されます。

2 good

4 Good

6 Goodbye
検索ボックスから lines:"even" を削除し、[Match case]\(大文字と小文字を区別する\) チェックボックスをオンにして、検索ボックスに「g」と入力します。

次の結果が表示されます。

1 go

2 good

5 goodbye
検索ボックスの右側にある [X] をクリックします。

検索がクリアされ、元のコンテンツが表示されます。ただし、[Match case]\(大文字と小文字を区別する\) チェックボックスはオンのままになります。

次の方法で共有

ツールウィンドウへの検索の追加

VSIX プロジェクトを作成するには

ツールウィンドウを作成するには

検索の実装を追加するには

検索動作をカスタマイズするには

ユーザーが検索を絞り込めるようにするには

検索フィルターを追加するには

その他のリソース

次の方法で共有

ツール ウィンドウへの検索の追加

VSIX プロジェクトを作成するには

ツール ウィンドウを作成するには

ツール ウィンドウに検索ボックスを追加するには

検索の実装を追加するには

検索動作をカスタマイズするには

ユーザーが検索を絞り込めるようにするには

検索フィルターを追加するには

その他のリソース

ツールウィンドウへの検索の追加

ツールウィンドウを作成するには

ツールウィンドウに検索ボックスを追加するには