Erstellen einer Einstellungskategorie
In dieser exemplarischen Vorgehensweise erstellen Sie eine Visual Studio-Einstellungskategorie und verwenden sie zum Speichern von Werten in einer Einstellungsdatei und zum Wiederherstellen von Werten aus einer Einstellungsdatei. Eine Einstellungskategorie ist eine Gruppe verwandter Eigenschaften, die als „benutzerdefinierter Einstellungspunkt“ angezeigt werden, das heißt, als Kontrollkästchen im Assistenten Importieren und Exportieren von Einstellungen. (Sie finden es im Menü Extras.) Einstellungen werden als Kategorie gespeichert oder wiederhergestellt und einzelne Einstellungen werden im Assistenten nicht angezeigt. Weitere Informationen finden Sie unter Umgebungseinstellungen.
Sie erstellen eine Einstellungskategorie, indem Sie sie von der DialogPage-Klasse ableiten.
Um diese exemplarische Vorgehensweise zu starten, müssen Sie zuerst den ersten Abschnitt der Seite Erstellen einer Option abschließen. Mit dem resultierenden Eigenschaftenraster „Optionen“ können Sie die Eigenschaften in der Kategorie untersuchen und ändern. Nachdem Sie die Eigenschaftskategorie in einer Einstellungsdatei gespeichert haben, überprüfen Sie die Datei, um zu sehen, wie die Eigenschaftswerte gespeichert werden.
Erstellen einer Einstellungskategorie
In diesem Abschnitt verwenden Sie einen benutzerdefinierten Einstellungspunkt, um die Werte der Einstellungskategorie zu speichern und wiederherzustellen.
So erstellen Sie eine Einstellungskategorie
Füllen Sie die Seite Erstellen einer Option aus.
Öffnen Sie die Datei VSPackage.resx, und fügen Sie diese drei Zeichenfolgenressourcen hinzu:
Name Wert 106 Meine Kategorie 107 Meine Einstellungen 108 OptionInteger und OptionFloat Dadurch werden Ressourcen erstellt, die die Kategorie „Meine Kategorie“, das Objekt „Meine Einstellungen“ und die Kategoriebeschreibung „OptionInteger und OptionFloat“ benennen.
Hinweis
Von diesen dreien wird nur der Kategoriename nicht im Assistenten Importieren und Exportieren von Einstellungen angezeigt.
Fügen Sie in MyToolsOptionsPackage.cs eine
float-Eigenschaft mit der BezeichnungOptionFloatzur KlasseOptionPageGridhinzu, wie im folgenden Beispiel gezeigt.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; } } }Hinweis
Die
OptionPageGrid-Kategorie mit dem Namen „Meine Kategorie“ besteht nun aus den beiden EigenschaftenOptionIntegerundOptionFloat.Fügen Sie ProvideProfileAttribute zur Klasse
MyToolsOptionsPackagehinzu, und geben Sie ihr den CategoryName „Meine Kategorie“ sowie den ObjectName „Meine Einstellungen“, und legen Sie isToolsOptionPage auf „true“ fest. Legen Sie „categoryResourceID“, „objectNameResourceID“ und „DescriptionResourceID“ auf die entsprechenden zuvor erstellten Zeichenfolgenressourcen-IDs fest.[ProvideProfileAttribute(typeof(OptionPageGrid), "My Category", "My Settings", 106, 107, isToolsOptionPage:true, DescriptionResourceID = 108)]Erstellen Sie das Projekt, und starten Sie das Debugging. In der experimentellen Instanz sollten Sie sehen, dass Meine Rasterseite jetzt sowohl ganzzahlige als auch Float-Werte enthält.
Überprüfen der Einstellungsdatei
In diesem Abschnitt exportieren Sie Eigenschaftskategoriewerte in eine Einstellungsdatei. Sie untersuchen die Datei und importieren dann die Werte wieder in die Eigenschaftskategorie.
Beginnen Sie das Projekt im Debugmodus, indem Sie F5 drücken. Dadurch wird die experimentelle Instanz gestartet.
Öffnen Sie das Dialogfeld Extras>Optionen.
Erweitern Sie in der Strukturansicht im linken Bereich Meine Kategorie, und klicken Sie dann auf Meine Rasterseite.
Ändern Sie den Wert von OptionFloat in 3.1416 und OptionInteger in 12. Klicken Sie auf OK.
Klicken Sie im Menü Extras auf Einstellungen importieren und exportieren.
Der Assistent Einstellungen importieren und exportieren wird angezeigt.
Stellen Sie sicher, dass Exportieren ausgewählter Umgebungseinstellungen ausgewählt ist, und klicken Sie dann auf Weiter.
Die Seite Einstellungen für den Export auswählen wird angezeigt.
Klicken Sie auf Meine Einstellungen.
Die Beschreibung wird in OptionInteger und OptionFloat geändert.
Stellen Sie sicher, dass Meine Einstellungen die einzige Kategorie ist, die ausgewählt ist, und klicken Sie dann auf Weiter.
Die Seite Ihre Einstellungsdatei benennen wird angezeigt.
Benennen Sie die neue Einstellungsdatei MySettings.vssettings, und speichern Sie sie in einem entsprechenden Verzeichnis. Klicken Sie auf Fertig stellen.
Die Datei
.vssettingsist die Visual Studio-Einstellungsdatei. Das Schema der Datei ist offen. Am häufigsten folgt das Schema einer XML-Struktur, bei der jede Kategorie ein Tag ist, das wiederum Tags für Unterkategorien enthalten kann. Diese Tags für Unterkategorien können Tags für Eigenschaftswerte enthalten. Während die meisten Pakete die allgemeine Struktur verwenden, kann ein Paket in Visual Studio beliebige XML-Daten mit dem ausgewählten Schema zur Datei hinzufügen.Die Seite Export abgeschlossen meldet, dass Ihre Einstellungen erfolgreich exportiert wurden.
Zeigen Sie im Menü Datei auf Öffnen, und klicken Sie dann auf Datei. Suchen Sie MySettings.vssettings, und öffnen Sie es.
Die von Ihnen exportierte Eigenschaftskategorie finden Sie im folgenden Abschnitt der Datei (Ihre GUIDs unterscheiden sich).
<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>Beachten Sie, dass der vollständige Kategoriename durch das Hinzufügen eines Unterstrichs zum Kategorienamen gefolgt vom Objektnamen gebildet wird. OptionFloat und OptionInteger werden zusammen mit ihren exportierten Werten in der Kategorie angezeigt.
Schließen Sie die Einstellungsdatei, ohne sie zu ändern.
Klicken Sie im Menü Extras auf Optionen, erweitern Sie Meine Kategorie, klicken Sie auf Meine Rasterseite und ändern Sie dann den Wert von OptionFloat in 1.0 und OptionInteger in 1. Klicken Sie auf OK.
Klicken Sie im Menü Extras auf Einstellungen importieren und exportieren, wählen Sie Ausgewählte Umgebungseinstellungen importieren aus, und klicken Sie dann auf Weiter.
Die Seite Aktuelle Einstellungen speichern wird angezeigt.
Wählen Sie Nein, nur neue Einstellungen importieren aus, und klicken Sie dann auf Weiter.
Die Seite Sammlung von zu importierenden Einstellungen auswählen wird angezeigt.
Wählen Sie die Datei MySettings.vssettings im Knoten Meine Einstellungen der Strukturansicht aus. Wenn die Datei nicht in der Strukturansicht angezeigt wird, klicken Sie auf Durchsuchen, und suchen Sie sie. Klicken Sie auf Weiter.
Das Dialogfeld Einstellungen für den Import auswählen wird angezeigt.
Vergewissern Sie sich, dass Meine Einstellungen ausgewählt ist, und klicken Sie dann auf Fertig stellen. Wenn die Seite Import abgeschlossen angezeigt wird, klicken Sie auf Schließen.
Klicken Sie im Menü Extras auf Optionen, erweitern Sie Meine Kategorie, klicken Sie auf Meine Rasterseite, und stellen Sie sicher, dass die Werte der Eigenschaftskategorie wiederhergestellt wurden.