設定カテゴリの作成

[アーティクル]
12/21/2023

このチュートリアルでは、Visual Studio の設定カテゴリを作成し、それを使用して設定ファイルの値を保存および復元します。設定カテゴリは、"カスタム設定ポイント"、つまり、設定のインポートとエクスポート ウィザードのチェックボックスとして表示される関連プロパティのグループです (このウィザードは [ツール] メニューにあります)。設定はカテゴリとして保存または復元されます。また、個々の設定はウィザードに表示されません。詳細については、環境設定に関するページを参照してください。

設定カテゴリは、DialogPage クラスから派生させて作成します。

このチュートリアルを開始するには、まず、「オプションページを作成する」の最初のセクションを完了する必要があります。結果のオプションのプロパティグリッドを使用すると、カテゴリ内のプロパティを確認および変更できます。プロパティカテゴリを設定ファイルに保存した後、ファイルを調べて、プロパティ値がどのように格納されているかを確認します。

設定カテゴリの作成

このセクションでは、カスタム設定ポイントを使用して、設定カテゴリの値を保存および復元します。

設定カテゴリを作成するには

「オプションページを作成する」を完了します。
VSPackage.resx ファイルを開き、次の 3 つの文字列リソースを追加します。

名前値

106 My Category

107 [個人の設定]

108 OptionInteger and OptionFloat

これにより、カテゴリ名が "My Category"、オブジェクト名が "My Settings"、カテゴリの説明が "OptionInteger and OptionFloat" であるリソースが作成されます。

Note

これら 3 つのうち、カテゴリ名だけが、設定のインポートとエクスポート ウィザードに表示されません。

名前	値
106	My Category
107	[個人の設定]
108	OptionInteger and OptionFloat

MyToolsOptionsPackage.cs で、次の例に示すように、OptionFloat という名前の float プロパティを OptionPageGrid クラスに追加します。

public class OptionPageGrid : DialogPage
{
    private int optionInt = 256;
    private float optionFloat = 3.14F;

    [Category("My Options")]
    [DisplayName("My Integer option")]
    [Description("My integer option")]
    public int OptionInteger
    {
        get { return optionInt; }
        set { optionInt = value; }
    }
    [Category("My Options")]
    [DisplayName("My Float option")]
    [Description("My float option")]
    public float OptionFloat
    {
        get { return optionFloat; }
        set { optionFloat = value; }
    }
}

Note

"My Category" という名前の OptionPageGrid カテゴリは、OptionInteger と OptionFloat という 2 つのプロパティで構成されるようになりました。

ProvideProfileAttribute を MyToolsOptionsPackage クラスに追加し、CategoryName に "My Category"、ObjectName に "My Settings" を指定し、isToolsOptionPage を true に設定します。 categoryResourceID、objectNameResourceID、DescriptionResourceID を、前に作成した対応する文字列リソース ID に設定します。
```
[ProvideProfileAttribute(typeof(OptionPageGrid),
    "My Category", "My Settings", 106, 107, isToolsOptionPage:true, DescriptionResourceID = 108)]
```
プロジェクトをビルドし、デバッグを開始します。実験用インスタンスでは、[My Grid Page] に整数値と浮動小数点値の両方が指定されていることがわかります。

設定ファイルを確認する

このセクションでは、プロパティカテゴリの値を設定ファイルにエクスポートします。ファイルを調べてから、プロパティカテゴリに値をインポートします。

F5 キーを押して、デバッグモードでプロジェクトを開始します。これにより、実験用インスタンスが開始されます。
[ツール]>[オプション] ダイアログを開きます。
左側のペインのツリービューで、[My Category] を展開し、[My Grid Page] をクリックします。
[OptionFloat] の値を 3.1416 に、[OptionInteger] を 12 に変更します。 OK をクリックします。
[ツール] メニューの [設定のインポートとエクスポート] を選択します。

設定のインポートとエクスポート ウィザードが表示されます。
[選択された環境設定をエクスポート] が選択されていることを確認し、[次へ] をクリックします。

[エクスポートする設定の選択] ページが表示されます。
[My Settings] をクリックします。

[説明] は、[OptionInteger and OptionFloat] に変わります。
[My Settings] が選択されている唯一のカテゴリであることを確認し、[次へ] をクリックします。

[設定ファイルの名前を指定してください] ページが表示されます。
新しい設定ファイルに「MySettings.vssettings」という名前を付け、適切なディレクトリに保存します。 [完了] をクリックします。

.vssettings ファイルは Visual Studio 設定ファイルです。ファイルのスキーマが開いています。最も一般的には、スキーマは XML 構造に従います。その構造では、各カテゴリはタグであり、それ自体にサブカテゴリタグを含めることができます。これらのサブカテゴリタグには、プロパティ値タグを含めることができます。ほとんどのパッケージでは共通の構造を使用されますが、Visual Studio 内のパッケージはすべて、選択したスキーマを使用して任意の XML をファイルに提供できます。

[エクスポートの完了] ページに、設定が正常にエクスポートされたことが表示されます。
[ファイル] メニューの [開く]をポイントし、 [ファイル]をクリックします。 MySettings.vssettings を検索して開きます。

エクスポートしたプロパティカテゴリは、ファイルの次のセクションで確認できます (GUID は異なります)。
```
<Category name="My Category_My Settings"
      Category="{4802bc3e-3d9d-4591-8201-23d1a05216a6}"
      Package="{6bb6942e-014c-489e-a612-a935680f703d}"
      RegisteredName="My Category_My Settings">
      PackageName="MyToolsOptionsPackage">
   <PropertyValue name="OptionFloat">3.1416</PropertyValue>
   <PropertyValue name="OptionInteger">12</PropertyValue>
</Category>
```
完全なカテゴリ名は、カテゴリ名にアンダースコアを付加し、その後にオブジェクト名が続いていることに注意してください。 OptionFloat と OptionInteger は、エクスポートされた値と共にカテゴリ内に出力されています。
設定ファイルを変更せずに閉じます。
[ツール] メニューの [オプション] をクリックし、[My Category] を展開して、[My Grid Page] をクリックします。次に、[OptionFloat] の値を 1.0 に変更し、[OptionInteger] を 1 に変更します。 OK をクリックします。
[ツール] メニューで、[設定のインポートとエクスポート] をクリックし、[選択された環境設定をインポート] を選択し、[次へ] をクリックします。

[現在の設定の保存] ページが表示されます。
[いいえ、新しい設定をインポートします] を選択し、[次へ] をクリックします。

[インポートする設定コレクションの選択] ページが表示されます。
ツリービューの [My Settings] ノードで、MySettings.vssettings ファイルを選択します。ファイルがツリービューに表示されない場合は、[参照] をクリックして検索します。次へをクリックします。

[インポートする設定の選択] ダイアログボックスが表示されます。
[My Settings] が選択されていることを確認し、[完了] をクリックします。 [インポートの完了] ページが表示されたら、[閉じる] をクリックします。
[ツール] メニューの [オプション] をクリックし、[My Category] を展開し、[My Grid Page] をクリックして、プロパティカテゴリの値が復元されていることを確認します。

設定カテゴリの作成

設定カテゴリの作成

設定カテゴリを作成するには

設定ファイルを確認する

その他のリソース