How to：使用受管理的封裝架構匯出設定

發行項
05/16/2015

Visual Studio整合式的開發環境 (IDE) 會使用類別來實作IProfileManager介面和類別，已經註冊為支援特定的 VSPackage 實作儲存 VSPackage 狀態。

因為 IDE 會具現化之類別的實作IProfileManager介面，以支援設定的IProfileManager應該獨立的類別中實作。

注意事項
不會實作IProfileManager上實作的類別Package。

若要實作的設定匯出

宣告實作的類別Visual Studio設定。

宣告和實作類別IProfileManager介面，並且在提供 GUID。

注意事項

類別的實作IProfileManager也必須實作IComponent。這可以藉由衍生的類別Component。

例如：
```
[Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]
internal class MyPackageProfileManager : Component, IProfileManager 
```
請確定實作設定的類別會取得正確的狀態資訊。此程序專屬於每個 VSPackage，並可能牽涉到從自動化取得狀態、查詢登錄機碼或查詢的 VSPackage。

一般而言，請按照下列的範例中，使用的實作LoadSettingsFromStorage方法來驗證，並接移 VSPackage 狀態資訊。

注意事項

LoadSettingsFromStorage初始化它支援 VSPackage 時，ide 也呼叫方法。

在此情況下，實作LoadSettingsFromStorage方法可以執行下列操作：
- 取得在 VSPackage 的目前設定的狀態資訊，並儲存在登錄中的組態資訊的存取。
```
Dim mySvc As MyPackageService = TryCast(GetService(GetType(IVSMDMyPackage)), MyPackageService) 
Dim package As Package = TryCast(GetService(GetType(Package)), Package) 
Dim rootKey As RegistryKey = package.UserRegistryRoot
```
```
MyPackageService mySvc = GetService(typeof(IVSMDMyPackage)) as MyPackageService;
Package package = GetService(typeof(Package)) as Package;
RegistryKey rootKey = package.UserRegistryRoot;
```
- 取決於所傳回的值MakeCurrentSettingTheDefault VSPackage 方法，它會是更新登錄設定登錄設定值，使用目前的 VSPackage 狀態，或是狀態。
```
If mySvc.MyPackage.MakeCurrentSettingTheDefault() Then 
    DirectCast(mySvc.MyPackage.packageState, IComPropertyBrowser).SaveState(pbrsKey) 
Else 
    DirectCast(mySvc.MyPackage.packageState, IComPropertyBrowser).LoadState(pbrsKey) 
End If
```
```
if (mySvc.MyPackage.MakeCurrentSettingTheDefault()){
  ((IComPropertyBrowser)mySvc.MyPackage.packageState).SaveState(pbrsKey);
}else{
  ((IComPropertyBrowser)mySvc.MyPackage.packageState).LoadState(pbrsKey);
}
```
  為了簡單起見，在這個範例中，除非MakeCurrentSettingsTheDefault方法傳回true，目前的狀態永遠重設為預設值儲存在登錄中。

注意事項
類別的實作IProfileManager也必須實作IComponent。這可以藉由衍生的類別Component。

注意事項
LoadSettingsFromStorage初始化它支援 VSPackage 時，ide 也呼叫方法。

請確定實作設定的類別也會持續存在磁碟的狀態。

實際的寫入的狀態資訊的設定檔都必須由類別實作， SaveSettingsToXml方法。設定寫入作業的特定內容視實作而定。

然而，類別必須取得狀態資訊的存取權，必須使用所提供IVsSettingsWriter介面，以將資料儲存至設定檔。

一般而言，如下例所示，實作SaveSettingsToXml方法並不會驗證狀態資訊。在執行驗證LoadSettingsFromStorage方法。相反地，實作只取得狀態資訊的存取權，並寫入，如此一來，以字串資料。

Dim mySvc As MyPackageService = TryCast(GetService(GetType(MyPackage)), MyPackageService) 
If mySvc IsNot Nothing Then 
    ' Information is stored in a StateObject 
    Dim myState As StateObject = mySvc.MyPackage.packageState 
    writer.WriteSettingString("PbrsAlpha", (If(myState.SortState = SortState.Alphabetical, "1", "0"))) 
    writer.WriteSettingString("PbrsShowDesc", (If(myState.HelpVisible, "1", "0"))) 
End If

MyPackageService mySvc = GetService(typeof(MyPackage)) as MyPackageService;
if (mySvc != null) {
  // Information is stored in a StateObject
  StateObject myState = mySvc.MyPackage.packageState;
 writer.WriteSettingString( 
                            "PbrsAlpha", 
                            (myState.SortState == SortState.Alphabetical ? "1" : "0"));
  writer.WriteSettingString( 
                            "PbrsShowDesc", 
                            (myState.HelpVisible ? "1" : "0"));
}

實作詳細資料如下所示：

除了明確的書面且根本不需要的資料ExportSettings方法實作中，設定 API 也會儲存Visual Studio版本資訊。因此，儲存的設定可以比較這些設定匯入作業期間所產生的 ide 版本。

值為pszSettingName引數提供給方法的IVsSettingsWriter介面必須唯一地識別儲存某個設定分類在各資料元素。

注意事項
名稱必須只有唯一的實作類別範圍內。IDE 會使用實作的設定類別的 GUID 及值pszSettingName來識別每一個儲存設定。如果多個IVsSettingsWriter都具有相同的方法pszSettingName的值都稱為、原始值會覆寫設定檔中。

設定檔支援隨機資料存取，因此順序讀取及寫入作業並不重要。在下列範例中，寫入器的實作中的作業順序的SaveSettingsToXml方法是相反的讀取作業，在LoadSettingsFromXml方法。

如果實作可以將資料對應到其中一個四個支援的格式，再沒有任何限制，有關的多，或可以撰寫哪些類型的資料。

注意事項
人力資源之間的LoadSettingsFromStorage和SaveSettingsToXml方法的實作而定，而且是隨意訂定。比方說，實作可以重新撰寫使用空的實作LoadSettingsFromStorage方法，讓所有的登錄和狀態查詢執行的SaveSettingsToXml方法。

暫存器的實作類別做為對 VSPackage 提供支援的設定。

套用的執行個體ProvideProfileAttribute ，藉由使用建構Type實作的類別的IProfileManager到 VSPackage Package實作。
```
<ProvideProfile(GetType(MyPackageProfileManager), "CoreUI", "MyPackage", 1004, 1004, False)> _ 
<Guid("YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY")> _ 
Class MyPackage 
    Inherits Package 
End Class
```
```
[ProvideProfile(typeof(MyPackageProfileManager), "CoreUI", "MyPackage", 1004, 1004, false)]
[Guid("YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY")]
class MyPackage: Package 
```
在此情況下，屬性會通知 IDE 的MyPackageProfileManager類別會提供要設定實作MyPackage類別。自訂設定在登錄中建立點下 HKLM\Software\Microsoft\VisualStudio\版本\UserSettings\ CoreUI_MyPackage，其中版本版本的Visual Studio，比方說，10.0。

如需詳細資訊，請參閱保存的設定和 ProvideProfileAttribute。

範例

下列範例會實作IProfileManager在類別上。

Imports System 
Imports System.Runtime.InteropServices 
Imports Microsoft.VisualStudio.Shell 
Imports Microsoft.VisualStudio.Shell.Interop 
Imports Microsoft.Win32 
Imports myPackageNameSpace 
Namespace myProfileManagerNameSpace 
    
    
    <Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")> _ 
    Friend Class MyPackageProfileManager 
        Inherits System.ComponentModel.Component 
        Implements IProfileManager 
        Friend Const m_supportVer As Integer = 8 
        Public Sub SaveSettingsToXml(ByVal writer As IVsSettingsWriter) 
            Dim mySvc As MyPackageService = TryCast(GetService(GetType(MyPackage)), MyPackageService) 
            If mySvc IsNot Nothing Then 
                ' Information is stored in a StateObject. 
                Dim myState As StateObject = mySvc.MyPackage.packageState 
                writer.WriteSettingString("PbrsAlpha", (If(myState.SortState = SortState.Alphabetical, "1", "0"))) 
                writer.WriteSettingString("PbrsShowDesc", (If(myState.HelpVisible, "1", "0"))) 
            End If 
        End Sub 
        
        Public Sub LoadSettingsFromXml(ByVal reader As IVsSettingsReader) 
            
            Dim pnMajor As Integer, pnMinor As Integer, pnBuild As Integer 
            ' First, check if data is obtained from the correct major version 
            reader.ReadVersion(pnMajor, pnMinor, pnBuild) 
            If pnMajor <> m_supportVer Then 
                reader.ReportError("Unsupported Version") 
            Else 
                Dim mySvc As MyPackageService = TryCast(GetService(GetType(IVSMDMyPackage)), MyPackageService) 
                If mySvc IsNot Nothing Then 
                    Dim value As String 
                    Dim myState As StateObject = mySvc.MyPackage.packageState 
                    reader.ReadSettingString("PbrsShowDesc", value) 
                    ' Not all values must be present. 
                    If value Is Nothing OrElse value = "" Then 
                        reader.ReportError("Unable to Help Visibility Setting") 
                    Else 
                        myState.HelpVisible = Not value.Equals("0") 
                    End If 
                    reader.ReadSettingString("PbrsAlpha", value) 
                    ' Not all values must be present. 
                    If value Is Nothing OrElse value = "" Then 
                        reader.ReportError("Unable to Retrieve Sort Value") 
                    Else 
                        If Not value.Equals("0") Then 
                            myState.SortState = SortState.Alphabetical 
                        Else 
                            myState.SortState = SortState.Categorized 
                        End If 
                    End If 
                End If 
            End If 
        End Sub 
        
        Public Sub SaveSettingsToStorage() 
            Dim mySvc As MyPackageService = TryCast(GetService(GetType(IVSMDMyPackage)), MyPackageService) 
            Dim package As Package = TryCast(GetService(GetType(Package)), Package) 
            Dim rootKey As RegistryKey = package.UserRegistryRoot 
            
            If mySvc.MyPackage.packageState IsNot Nothing Then 
                Using rootKey 
                    Using pbrsKey As RegistryKey = rootKey.CreateSubKey(Me.[GetType]().Name) 
                        Using pbrsKey 
                            DirectCast(mySvc.MyPackage.packageState, IComPropertyBrowser).SaveState(pbrsKey) 
                        End Using 
                    End Using 
                End Using 
            End If 
        End Sub 
        
        Public Sub LoadSettingsFromStorage() 
            Dim mySvc As MyPackageService = TryCast(GetService(GetType(IVSMDMyPackage)), MyPackageService) 
            Dim package As Package = TryCast(GetService(GetType(Package)), Package) 
            Dim rootKey As RegistryKey = package.UserRegistryRoot 
            Using rootKey 
                Dim pbrsKey As RegistryKey = rootKey.OpenSubKey(Me.[GetType]().Name) 
                If pbrsKey IsNot Nothing Then 
                    Using pbrsKey 
                        If mySvc.MyPackage.MakeCurrentSettingTheDefault() Then 
                            DirectCast(mySvc.MyPackage.packageState, IComPropertyBrowser).SaveState(pbrsKey) 
                        Else 
                            DirectCast(mySvc.MyPackage.packageState, IComPropertyBrowser).LoadState(pbrsKey) 
                        End If 
                    End Using 
                End If 
            End Using 
        End Sub 
    End Class 
End Namespace 

Convert C# to VB.NET

namespace myProfileManagerNameSpace  {
  
  using System;
  using System.Runtime.InteropServices;
  using Microsoft.VisualStudio.Shell;
  using Microsoft.VisualStudio.Shell.Interop;
  using Microsoft.Win32;
  using myPackageNameSpace;
  
  
  [Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]
  internal class MyPackageProfileManager : System.ComponentModel.Component , IProfileManager {
    internal const int m_supportVer = 8;
    public void SaveSettingsToXml(IVsSettingsWriter writer) {
      MyPackageService mySvc = GetService(typeof(MyPackage)) as MyPackageService;
      if (mySvc != null) {
        // Information is stored in a StateObject.
        StateObject myState = mySvc.MyPackage.packageState;
        writer.WriteSettingString( 
                                  "PbrsAlpha", 
                                  (myState.SortState == SortState.Alphabetical ? "1" : "0"));
        writer.WriteSettingString( 
                                  "PbrsShowDesc", 
                                  (myState.HelpVisible ? "1" : "0"));
      }
    }
    
    public void LoadSettingsFromXml(IVsSettingsReader reader)
    {
      
      int pnMajor, pnMinor, pnBuild;
      // First, check if data is obtained from the correct major version 
      reader.ReadVersion(pnMajor, pnMinor, pnBuild);
      if (pnMajor != m_supportVer){
        reader.ReportError("Unsupported Version");
      }else{
        MyPackageService mySvc = GetService(typeof(IVSMDMyPackage)) as MyPackageService;
        if (mySvc != null){
          string value;
          StateObject myState = mySvc.MyPackage.packageState;
          reader.ReadSettingString("PbrsShowDesc", out value);
          // Not all values must be present.
          if (value == null || value == ""){
              reader.ReportError("Unable to Help Visibility Setting");
          }else{
            myState.HelpVisible = !value.Equals("0");
          }
          reader.ReadSettingString("PbrsAlpha", out value);
          // Not all values must be present.
          if (value == null || value == ""){
              reader.ReportError("Unable to Retrieve Sort Value");
          }else{
            if (!value.Equals("0")){
              myState.SortState = SortState.Alphabetical;
            }else{
              myState.SortState = SortState.Categorized;
            }
          }
        }
      }
    }

    public void SaveSettingsToStorage() {
      MyPackageService mySvc = GetService(typeof(IVSMDMyPackage)) as MyPackageService;
      Package package = GetService(typeof(Package)) as Package;
      RegistryKey rootKey = package.UserRegistryRoot;
      
      if (mySvc.MyPackage.packageState != null) {
        using (rootKey) {
          using(RegistryKey pbrsKey = rootKey.CreateSubKey(this.GetType().Name)) {
            using (pbrsKey) {
              ((IComPropertyBrowser)mySvc.MyPackage.packageState).SaveState(pbrsKey);
            }
          }
        }
      }
    }
    
    public void LoadSettingsFromStorage() {
      MyPackageService mySvc = GetService(typeof(IVSMDMyPackage)) as MyPackageService;
      Package package = GetService(typeof(Package)) as Package;
      RegistryKey rootKey = package.UserRegistryRoot;
      using (rootKey) {
        RegistryKey pbrsKey = rootKey.OpenSubKey(this.GetType().Name);
        if (pbrsKey != null) {
          using (pbrsKey) {
            if (mySvc.MyPackage.MakeCurrentSettingTheDefault()){
              ((IComPropertyBrowser)mySvc.MyPackage.packageState).SaveState(pbrsKey);
            }else{
              ((IComPropertyBrowser)mySvc.MyPackage.packageState).LoadState(pbrsKey);
            }
          }
        }
      }
    }
  }
}

請參閱

共用方式為

How to：使用受管理的封裝架構匯出設定

若要實作的設定匯出

範例

請參閱

工作

參考

概念

其他資源

共用方式為

How to： 使用受管理的封裝架構匯出設定

若要實作的設定匯出

範例

請參閱

工作

參考

概念

其他資源

How to：使用受管理的封裝架構匯出設定