ユーザー設定ストアへの書き込み

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

ユーザー設定は、[ツール] > [オプション] ダイアログ、[プロパティ] ウィンドウ、その他特定のダイアログボックスのように書き込み可能な設定です。 Visual Studio 拡張機能では、これらを使用して少量のデータを保存できます。このチュートリアルでは、ユーザー設定ストアの読み取りと書き込みによって Visual Studio にメモ帳を外部ツールとして追加する方法について説明します。

ユーザー設定ストアへの書き込み

UserSettingsStoreExtension という名前の VSIX プロジェクトを作成してから、UserSettingsStoreCommand という名前のカスタムコマンドを追加します。カスタムコマンドを作成する方法の詳細については、「メニューコマンドを使用した拡張機能の作成」を参照してください。

UserSettingsStoreCommand.cs で、次の using ディレクティブを追加します。

using System.Collections.Generic;
using Microsoft.VisualStudio.Settings;
using Microsoft.VisualStudio.Shell.Settings;

MenuItemCallback で、メソッドの本文を削除し、次のようにユーザー設定ストアを取得します。

private void MenuItemCallback(object sender, EventArgs e)
{
    SettingsManager settingsManager = new ShellSettingsManager(ServiceProvider);
    WritableSettingsStore userSettingsStore = settingsManager.GetWritableSettingsStore(SettingsScope.UserSettings);
}

メモ帳が外部ツールとして既に設定されているかどうかを確認します。次のように、すべての外部ツールを反復処理して、ToolCmd の設定が "Notepad" であるかどうかを確認する必要があります。

private void MenuItemCallback(object sender, EventArgs e)
{
    SettingsManager settingsManager = new ShellSettingsManager(ServiceProvider);
    WritableSettingsStore userSettingsStore = settingsManager.GetWritableSettingsStore(SettingsScope.UserSettings);

    // Find out whether Notepad is already an External Tool.
    int toolCount = userSettingsStore.GetInt32("External Tools", "ToolNumKeys");
    bool hasNotepad = false;
    CompareInfo Compare = CultureInfo.InvariantCulture.CompareInfo;
    for (int i = 0; i < toolCount; i++)
    {
        if (Compare.IndexOf(userSettingsStore.GetString("External Tools", "ToolCmd" + i), "Notepad", CompareOptions.IgnoreCase) >= 0)
        {
            hasNotepad = true;
            break;
        }
    }
}

メモ帳が外部ツールとして設定されていない場合は、次のように設定します。

private void MenuItemCallback(object sender, EventArgs e)
{
    SettingsManager settingsManager = new ShellSettingsManager(ServiceProvider);
    WritableSettingsStore userSettingsStore = settingsManager.GetWritableSettingsStore(SettingsScope.UserSettings);

    // Find out whether Notepad is already installed.
    int toolCount = userSettingsStore.GetInt32("External Tools", "ToolNumKeys");
    bool hasNotepad = false;
    CompareInfo Compare = CultureInfo.InvariantCulture.CompareInfo;
    for (int i = 0; i < toolCount; i++)
    {
        if (Compare.IndexOf(userSettingsStore.GetString("External Tools", "ToolCmd" + i), "Notepad", CompareOptions.IgnoreCase) >= 0)
        {
            hasNotepad = true;
            break;
        }
    }

    string message = (hasNotepad) ? "Notepad already installed" : "Installing Notepad";
     if (!hasNotepad)
    {
        userSettingsStore.SetString("External Tools", "ToolTitle" + toolCount, "&Notepad");
        userSettingsStore.SetString("External Tools", "ToolCmd" + toolCount, "C:\\Windows\\notepad.exe");
        userSettingsStore.SetString("External Tools", "ToolArg" + toolCount, "");
        userSettingsStore.SetString("External Tools", "ToolDir" + toolCount, "$(ProjectDir)");
        userSettingsStore.SetString("External Tools", "ToolSourceKey" + toolCount, "");
        userSettingsStore.SetUInt32("External Tools", "ToolOpt" + toolCount, 0x00000011);

        userSettingsStore.SetInt32("External Tools", "ToolNumKeys", toolCount + 1);
    }
}

コードをテストします。メモ帳が外部ツールとして追加されるので、2 回目に実行する前にレジストリをロールバックする必要があることにご注意ください。
コードをビルドし、デバッグを開始します。
[ツール] メニューの [UserSettingsStoreCommand の呼び出し] をクリックします。これで、[ツール] メニューにメモ帳が追加されます。
[ツール] > [オプション] メニューに [メモ帳] が表示され、[メモ帳] をクリックするとメモ帳のインスタンスが表示されます。

次の方法で共有

ユーザー設定ストアへの書き込み

ユーザー設定ストアへの書き込み

その他のリソース