オプションとオプションページ

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

[ツール] メニューの [オプション] をクリックすると、[オプション] ダイアログボックスが開きます。このダイアログボックス内のオプションは、総称してオプションページと呼ばれます。ナビゲーションウィンドウのツリーコントロールにはオプションカテゴリが含まれていて、すべてのカテゴリにオプションページがあります。ページを選択すると、そのオプションが右側のウィンドウに表示されます。これらのページでは、VSPackage の状態を決定するオプションの値を変更できます。

オプションページのサポート

オプションページとオプションカテゴリの作成は、Package クラスによってサポートされます。オプションページは、DialogPage クラスによって実装されます。

DialogPage の既定の実装では、プロパティの汎用グリッド内のユーザーに対して、パブリックプロパティが提供されます。この動作をカスタマイズするには、ページのさまざまなメソッドをオーバーライドして、独自のユーザーインターフェイス (UI) を使ったカスタムオプションページを作成します。詳しくは、「オプションページの作成」をご覧ください。

DialogPage クラスでは、IProfileManager が実装されます。これにより、オプションページとユーザー設定に対する保持機能が提供されます。 LoadSettingsFromStorage メソッドと SaveSettingsToStorage メソッドの既定の実装では、プロパティと文字列との間での変換が可能な場合、プロパティの変更がレジストリのユーザーセクションに保持されます。

オプションページのレジストリパス

既定では、オプションページによって管理されるプロパティのレジストリパスは、UserRegistryRoot、DialogPage という文字列、およびオプションページクラスの型名を組み合わせることで決定されます。たとえば、オプションページクラスは次のように定義できます。

namespace Company.OptionsPage
{
    public class OptionsPageGeneral : DialogPage
    {
    }
}

Namespace Company.OptionsPage
    Public Class OptionsPageGeneral
        Inherits DialogPage
    End Class
End Namespace

UserRegistryRoot が HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\8.0Exp の場合、プロパティ名と値のペアは、HKEY_CURRENT_USER\Software\Microsoft\VisualStudio\8.0Exp\DialogPage\Company.OptionsPage.OptionsPageGeneral のサブキーになります。

オプションページ自体のレジストリパスは、ApplicationRegistryRoot、ToolsOptionsPages という文字列、およびオプションページのカテゴリと名前を組み合わせることで決定されます。たとえば、Custom オプションページのカテゴリが My Option Pages、ApplicationRegistryRoot が HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\8.0Exp である場合、そのオプションページのレジストリキーは、HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\8.0Exp\ToolsOptionsPages\My Option Pages\Custom になります。

ツール/オプションページの属性とレイアウト

ProvideOptionPageAttribute 属性を使用すると、[オプション] ダイアログボックスのナビゲーションツリーで、カスタムオプションページをカテゴリ別にグループ化できます。 ProvideOptionPageAttribute 属性を使用すると、オプションページに、インターフェイスを提供する VSPackage を関連付けることができます。次のコードがあるとします。

[ProvideOptionPage(typeof(OptionsPageGeneral),"My Option Pages", "General", 101, 106, true)]
[ProvideOptionPage(typeof(OptionsPageCustom), "My Option Pages", "Custom", 101, 107, true)]
[Guid("B0002DC2-56EE-4931-93F7-70D6E9863940")]
public class MyPackage : Package

<ProvideOptionPage(GetType(OptionsPageGeneral), "My Option Pages", "General", 101, 106, True),
 ProvideOptionPage(GetType(OptionsPageCustom), "My Option Pages", "Custom", 101, 107, True),
 Guid("B0002DC2-56EE-4931-93F7-70D6E9863940")>
Public Class MyPackage
    Inherits Package

このコードでは、MyPackage で 2 つのオプションページ (OptionsPageGeneral と OptionsPageCustom) を提供することを宣言しています。これらのオプションページは、[オプション] ダイアログボックスの [My Option Pages] カテゴリに、[General] および [Custom] という名前でそれぞれ表示されます。

オプションの属性とレイアウト

カスタムオプションページ内のオプションの外観は、ページに表示されるユーザーインターフェイス (UI) によって決まります。汎用オプションページのオプションのレイアウト、ラベル付け、および説明は、次の属性によって決定されます。

CategoryAttribute では、オプションのカテゴリを決定します。
DisplayNameAttribute では、オプションの表示名を決定します。

DescriptionAttribute では、オプションの説明を決定します。

Note

同等の属性、SRCategory、LocDisplayName、および SRDescription では、ローカライズ用の文字列リソースを使用します。これらは、マネージドプロジェクトのサンプルで定義されています。

次のコードがあるとします。

[Category("My Options")]
[DisplayName("Integer Option")]
[Description("My integer option")]
public int OptionInteger { get; set; }

Private _optionInt As Integer

<Category("My Options"),
DisplayName("Integer Option"),
Description("My integer option")>
Public Property OptionInteger() As Integer
    Get
        Return _optionInt
    End Get
    Set(ByVal value As Integer)
        _optionInt = value
    End Set
End Property

OptionInteger オプションは、オプションページで、[My Options] カテゴリの [Integer Option] として表示されます。このオプションが選択されると、説明ボックスに「My integer option」という説明が表示されます。

別の VSPackage からオプションページにアクセスする

オプションページをホストおよび管理する VSPackage には、オートメーションモデルを使って、別の VSPackage からプログラムでアクセスすることもできます。たとえば、次のコードでは、VSPackage がオプションページのホストとして登録されています。

[ProvideOptionPage(typeof(MyOptionPage), "My Category", "My Grid Page", 0, 0, true)]
[Guid("6bb6942e-014c-489e-a612-a935680f703d")]
public sealed class MyToolsOptions : Package

<ProvideOptionPage(GetType(MyOptionPage), "My Category", "My Grid Page", 0, 0, True)>
<Guid("6bb6942e-014c-489e-a612-a935680f703d")>
Public NotInheritable Class MyToolsOptions
    Inherits Package

次のコードフラグメントでは、MyOptionPage から OptionInteger の値を取得しています。

DTE dte = (DTE)GetService(typeof(DTE));
EnvDTE.Properties props = dte.get_Properties("My Category", "My Grid Page");
int n = (int)props.Item("OptionInteger").Value;

Dim dte As DTE = CType(GetService(GetType(DTE)), DTE)
Dim props As EnvDTE.Properties = dte.get_Properties("My Category", "My Grid Page")
Dim n As Integer = CInt(Fix(props.Item("OptionInteger").Value))

ProvideOptionPageAttribute 属性でオプションページが登録されるとき、属性の SupportsAutomation 引数が true であれば、そのページは AutomationProperties キーの下に登録されます。オートメーションは、このレジストリエントリを調べて、関連する VSPackage を見つけます。その後、ホストされているオプションページ (この場合は My Grid Page) を通じてプロパティにアクセスします。

オートメーションプロパティのレジストリパスは、ApplicationRegistryRoot、AutomationProperties という文字列、およびオプションページのカテゴリと名前を組み合わせることで決定されます。たとえば、オプションページのカテゴリが My Category、名前が My Grid Page、ApplicationRegistryRoot が HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\8.0Exp である場合、オートメーションプロパティのレジストリキーは、HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\8.0Exp\AutomationProperties\My Category\My Grid Page になります。

Note

正規名である My Category.My Grid Page は、このキーの Name サブキーの値です。

オプションとオプション ページ

オプション ページのサポート

オプション ページのレジストリ パス

ツール/オプション ページの属性とレイアウト