Freigeben über

Unterstützung für Benutzereinstellungen

Ein VSPackage kann eine oder mehrere Einstellungskategorien definieren, bei denen es sich um Gruppen von Zustandsvariablen handelt, die beibehalten werden, wenn ein Benutzer den Befehl "Import/Export Settings" im Menü "Extras " auswählt. Um diese Persistenz zu aktivieren, verwenden Sie die Einstellungs-APIs im Visual Studio SDK.

Ein Registrierungseintrag, der als benutzerdefinierter Einstellungspunkt bezeichnet wird, und eine GUID definiert die Einstellungskategorie einer VSPackage. Ein VSPackage kann mehrere Einstellungskategorien unterstützen, die jeweils durch einen benutzerdefinierten Einstellungspunkt definiert werden.

  • Implementierungen von Einstellungen, die auf Interop-Assemblys (mithilfe der IVsUserSettings-Schnittstelle) basieren, sollten benutzerdefinierte Einstellungspunkte erstellen, indem sie entweder die Registrierung editieren oder ein Registrar-Skript (rgs-Datei) verwenden. Weitere Informationen finden Sie unter Erstellen von Registrarskripten.

  • Code, der das Verwaltete Paketframework (Managed Package Framework, MPF) verwendet, sollte benutzerdefinierte Einstellungspunkte erstellen, indem er für jeden benutzerdefinierten Einstellungspunkt ein ProvideProfileAttribute Element an das VSPackage anfügt.

    Wenn ein einzelnes VSPackage mehrere benutzerdefinierte Einstellungspunkte unterstützt, wird jeder benutzerdefinierte Einstellungspunkt von einer separaten Klasse implementiert, und jeder wird von einer eindeutigen Instanz der ProvideProfileAttribute Klasse registriert. Demnach kann eine Implementierungsklasse, die Einstellungen implementiert, mehrere Einstellungskategorien unterstützen.

Details des Eintrags zu benutzerdefinierten Einstellungspunkt-Registrierungseinträgen

Benutzerdefinierte Einstellungspunkte werden in einem Registrierungseintrag am folgenden Speicherort erstellt: HKLM\Software\Microsoft\VisualStudio\<Version>\UserSettings\<CSPName>, wobei <CSPName> der Name des benutzerdefinierten Einstellungspunkts, den vsPackage unterstützt, und <Version> ist die Version von Visual Studio, z. B. 8.0.

Hinweis

Der Stammpfad HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\<Version> kann mit einem alternativen Stamm überschrieben werden, wenn die integrierte Entwicklungsumgebung (IDE) von Visual Studio initialisiert wird. Weitere Informationen finden Sie unter Command-Line Switches.

Die Struktur des Registrierungseintrags wird unten veranschaulicht:

HKLM\Software\Microsoft\VisualStudio\<Version>\UserSettings\

<CSPName >= s '#12345'

Paket = '{XXXXXX XXXX XXXX XXXX XXXXXXX}'

Kategorie = '{YYYYYY YYYY YYYY YYYY YYYYYYYYY}'

ResourcePackage = '{ZZZZZZZZ ZZZZ ZZZZ ZZZZ ZZZZZZZZZZZ}'

AlternateParent = CategoryName

Name Typ Daten Description
(Standard) REG_SZ Name des Benutzerdefinierten Einstellungspunkts Der Name <CSPName>des Schlüssels ist der nicht lokalisierte Name des Benutzerdefinierten Einstellungspunkts.

Für Implementierungen, die auf MPF basieren, wird der Name des Schlüssels abgerufen, indem die categoryName- und objectName-Argumente des ProvideProfileAttribute-Konstruktors zu categoryName_objectName kombiniert werden.

Der Schlüssel kann leer sein, oder er kann die Referenz-ID für die lokalisierte Zeichenfolge in einer Satelliten-DLL enthalten. Dieser Wert wird vom objectNameResourceID Argument zum ProvideProfileAttribute Konstruktor abgerufen.
Package REG_SZ GUID Die GUID des VSPackage, das den Benutzerdefinierten Einstellungspunkt implementiert.

Implementierungen, die auf MPF mithilfe der ProvideProfileAttribute Klasse basieren, verwenden das Argument des objectType Konstruktors, das die VSPackage Type und Reflection enthält, um diesen Wert abzurufen.
Kategorie REG_SZ GUID GUID, die die Einstellungskategorie identifiziert.

Bei Implementierungen, die auf Interopassemblys basieren, kann dieser Wert eine willkürlich ausgewählte GUID sein, die von der Visual Studio-IDE an die ExportSettings Und die ImportSettings Methoden übergeben wird. Alle Implementierungen dieser beiden Methoden sollten ihre GUID-Argumente überprüfen.

Für Implementierungen, die auf MPF basieren, wird diese GUID von der Klasse abgerufen, die Type den Visual Studio-Einstellungsmechanismus implementiert.
ResourcePackage REG_SZ GUID Wahlfrei.

Pfad zur Satelliten-DLL, die lokalisierte Zeichenfolgen enthält, wenn sie vom implementierenden VSPackage nicht bereitgestellt werden.

MPF verwendet Spiegelung, um die richtige Ressource VSPackage abzurufen, sodass die ProvideProfileAttribute Klasse dieses Argument nicht festgelegt.
AlternateParent REG_SZ Name des Ordners unter der Seite "Extras-Optionen", die diesen benutzerdefinierten Einstellungspunkt enthält. Wahlfrei.

Sie müssen diesen Wert nur festlegen, wenn eine Einstellungsimplementierung Tools-Optionsseiten unterstützt, die den Persistenzmechanismus im Visual Studio SDK anstelle des Mechanismus im Automatisierungsmodell zum Speichern des Zustands verwenden.

In diesen Fällen ist der Wert im AlternateParent-Schlüssel der topic Abschnitt der Zeichenfolge, mit der topic.sub-topic die jeweilige ToolsOptions-Seite identifiziert wird. Zum Beispiel wäre für die Seite ToolsOptions"TextEditor.Basic" der Wert von AlternateParent "TextEditor".

Wenn ProvideProfileAttribute der Benutzerdefinierte Einstellungspunkt generiert wird, ist er mit dem Kategorienamen identisch.
  • Last updated on