建立選項] 頁面

發行項
03/24/2017

如需 Visual Studio 2017 的最新文件請參閱 Visual Studio 2017 文件。

本逐步解說會建立使用屬性方格中檢查和設定屬性的簡單工具/選項頁面。

將這些屬性，以儲存備份，還原從設定檔案，請遵循下列步驟，看然後建立設定分類。

MPF 提供兩個類別來協助您建立工具選項頁封裝類別和DialogPage類別。您建立子類別化在套件類別，這些頁面提供容器的 VSPackage。您可以衍生自 DialogPage 類別建立每個工具選項頁面。

必要條件

啟動 Visual Studio 2015 中，您未安裝 Visual Studio SDK 從「下載中心」。它是 Visual Studio 安裝程式的選用功能。您也可以在稍後安裝 VS SDK。如需詳細資訊，請參閱安裝 Visual Studio SDK。

建立工具選項的格線頁

在本節中，您可以建立簡單的工具選項屬性方格。您可以使用這個方格來顯示和變更屬性的值。

若要建立 VSIX 專案並加入 VSPackage

每個 Visual Studio 擴充功能開始 VSIX 部署專案，以將包含擴充資產。建立Visual StudioVSIX 專案，名為MyToolsOptionsExtension。您可以找到 VSIX 專案範本，在新的專案下的對話方塊Visual C# / 擴充性。
加入名為的 Visual Studio 套件項目範本加入 VSPackage MyToolsOptionsPackage。在方案總管中，以滑鼠右鍵按一下專案節點，然後選取加入 / 新的項目。在加入新項目對話方塊，請移至Visual C# 項目 / 擴充性，然後選取Visual Studio 套件。在名稱欄位底部的 [] 對話方塊中，變更的檔案名稱MyToolsOptionsPackage.cs。如需如何建立 VSPackage 的詳細資訊，請參閱建立擴充功能的 VSPackage。

若要建立工具選項屬性方格

程式碼編輯器中開啟 MyToolsOptionsPackage 檔案。
新增下列 using 陳述式。
```
using System.ComponentModel;  
```
宣告 OptionPageGrid 類別和衍生它從DialogPage。
```
public class OptionPageGrid : DialogPage  
{  }  
```

套用ProvideOptionPageAttribute至 VSPackage 類別，以指派給類別的選項類別目錄和 OptionPageGrid 選項頁面名稱。結果應該如下所示︰

[PackageRegistration(UseManagedResourcesOnly = true)]  
[InstalledProductRegistration("#110", "#112", "1.0", IconResourceID = 400)]  
[ProvideMenuResource("Menus.ctmenu", 1)]  
[Guid(GuidList.guidMyToolsOptionsPkgString)]  
[ProvideOptionPage(typeof(OptionPageGrid),  
    "My Category", "My Grid Page", 0, 0, true)]  
public sealed class MyToolsOptionsPackage : Package

新增OptionInteger屬性OptionPageGrid類別。
- 套用System.ComponentModel.CategoryAttribute来指派給屬性的屬性方格的類別。
- 套用System.ComponentModel.DisplayNameAttribute来指派給屬性的名稱。
- 套用System.ComponentModel.DescriptionAttribute来指派給屬性的描述。
```
public class OptionPageGrid : DialogPage  
{  
    private int optionInt = 256;  

    [Category("My Category")]  
    [DisplayName("My Integer Option")]  
    [Description("My integer option")]  
    public int OptionInteger  
    {  
        get { return optionInt; }  
        set { optionInt = value; }  
    }  
}  
```
注意

預設實作DialogPage支援具有適當的轉換或結構或可展開成有適當的轉換器的屬性陣列的屬性。如需轉換的清單，請參閱System.ComponentModel命名空間。
建置此專案並開始偵錯。
在 Visual Studio 中，實驗性執行個體上工具功能表上，按一下選項。

在左窗格中，您應該看到My Category。（選項類別目錄會列出依字母順序，它應該會出現有關中途清單向下）。開啟My Category然後按一下 我的格線頁。選項方格會顯示在右窗格中。屬性類別目錄是My Options，而屬性名稱是我整數選項。屬性描述我整數選項，會出現在窗格的底端。將值從 256 其初始值變更為其他項目。按一下確定，然後再重新開啟我的格線頁。您可以看到新的值保存。

也可透過 Visual Studio 的快速啟動選項頁面。在 IDE 右上角 [快速啟動] 視窗中，輸入My Category ，您會看到My Category – > 我的格線頁列在下拉式清單中。

建立自訂工具選項頁面

本節中，您可以建立工具選項頁面使用自訂 UI。您可以使用此頁面來顯示和變更屬性的值。

程式碼編輯器中開啟 MyToolsOptionsPackage 檔案。
新增下列 using 陳述式。
```
using System.Windows.Forms;  
```

新增OptionPageCustom類別之前OptionPageGrid類別。將新類別衍生自DialogPage。

public class OptionPageCustom : DialogPage  
{  
    private string optionValue = "alpha";  

    public string OptionString  
    {  
        get { return optionValue; }  
        set { optionValue = value; }  
    }  
}

將 GUID 屬性。新增 OptionString 屬性︰

[Guid("00000000-0000-0000-0000-000000000000")]  
public class OptionPageCustom : DialogPage  
{  
    private string optionValue = "alpha";  

    public string OptionString  
    {  
        get { return optionValue; }  
        set { optionValue = value; }  
    }  
}

套用第二個ProvideOptionPageAttribute VSPackage 類別。選項類別目錄和選項頁面名稱，這個屬性就會指派類別。

[PackageRegistration(UseManagedResourcesOnly = true)]  
[InstalledProductRegistration("#110", "#112", "1.0", IconResourceID = 400)]  
[ProvideMenuResource("Menus.ctmenu", 1)]  
[Guid(GuidList.guidMyToolsOptionsPkgString)]  
[ProvideOptionPage(typeof(OptionPageGrid),  
    "My Category", "My Grid Page", 0, 0, true)]  
[ProvideOptionPage(typeof(OptionPageCustom),  
    "My Category", "My Custom Page", 0, 0, true)]  
public sealed class MyToolsOptionsPackage : Package

加入新使用者控制項命名 MyUserControl 至專案。
新增文字方塊至使用者控制項的控制項。

在屬性視窗的工具列上，按一下事件] 按鈕，然後再按兩下 [保留事件。新的事件處理常式會出現在 MyUserControl.cs 程式碼。

加入公用OptionsPage 欄位中，Initialize方法來控制類別和更新的事件處理常式，來設定選項值的文字方塊中的內容︰

public partial class MyUserControl : UserControl  
{  
    public MyUserControl()  
    {  
        InitializeComponent();  
    }  

    internal OptionPageCustom optionsPage;  

    public void Initialize()  
    {  
        textBox1.Text = optionsPage.OptionString;  
    }  

    private void textBox1_Leave(object sender, EventArgs e)  
    {  
        optionsPage.OptionString = textBox1.Text;  
    }  
}

optionsPage欄位保存父參考OptionPageCustom執行個體。 Initialize方法顯示OptionString中文字方塊。事件處理常式寫入目前的值文字方塊至OptionString當專注分葉文字方塊。

在封裝的程式碼檔案中新增的覆寫OptionPageCustom.Window至 OptionPageCustom 類別，以建立、初始化及傳回的執行個體的屬性MyUserControl。此類別現在看起來應該像這樣︰

[Guid("00000000-0000-0000-0000-000000000000")]  
public class OptionPageCustom : DialogPage  
{  
    private string optionValue = "alpha";  

    public string OptionString  
    {  
        get { return optionValue; }  
        set { optionValue = value; }  
    }  

    protected override IWin32Window Window  
    {  
        get  
        {  
            MyUserControl page = new MyUserControl();  
            page.optionsPage = this;  
            page.Initialize();  
            return page;  
        }  
    }  
}

建置並執行專案。
在實驗執行個體中，按一下 工具 / 選項。
尋找我類別然後我自訂頁面。
值變更OptionString。按一下確定，然後再重新開啟我的自訂頁面。您可以看到已保存的新值。

存取選項

本節中，您可以取得選項的值從 VSPackage 裝載相關聯的工具選項頁面。相同的技巧可以用來取得任何公用屬性的值。

在封裝的程式碼檔案中，新增名為的公用屬性OptionInteger至MyToolsOptionsPackage類別。
```
public int OptionInteger  
{  
    get  
    {  
        OptionPageGrid page = (OptionPageGrid)GetDialogPage(typeof(OptionPageGrid));  
        return page.OptionInteger;  
    }  
}  
```
此程式碼呼叫GetDialogPage建立或擷取OptionPageGrid執行個體。 OptionPageGrid呼叫LoadSettingsFromStorage載入它的公用屬性的選項。
現在加入名為的自訂命令項目範本MyToolsOptionsCommand来顯示的值。在加入新項目 對話方塊中，移至Visual C# / 擴充性，然後選取自訂命令。在名稱視窗的底部欄位中，將命令檔名稱變更為MyToolsOptionsCommand.cs。

在 MyToolsOptionsCommand 檔案中取代命令的主體ShowMessageBox使用下列方法︰

private void ShowMessageBox(object sender, EventArgs e)  
{  
    MyToolsOptionsPackage myToolsOptionsPackage = this.package as MyToolsOptionsPackage;  
    System.Windows.Forms.MessageBox.Show(string.Format(CultureInfo.CurrentCulture, "OptionInteger: {0}", myToolsOptionsPackage.OptionInteger));  
}

建置此專案並開始偵錯。
在實驗性的執行個體，在工具] 功能表上，按一下 [叫用 MyToolsOptionsCommand。

訊息方塊顯示目前的值OptionInteger。

另請參閱

選項和選項頁面

共用方式為