Udostępnij przez

Obsługa ustawień użytkownika

Pakiet VSPackage może definiować co najmniej jedną kategorię ustawień, które są grupami zmiennych stanu, które są utrwalane, gdy użytkownik wybierze polecenie Importuj/Eksportuj ustawienia w menu Narzędzia . Aby włączyć tę trwałość, użyj interfejsów API ustawień w zestawie Visual Studio SDK.

Wpis rejestru określany jako punkt ustawień niestandardowych oraz identyfikator GUID definiują kategorię ustawień pakietu VSPackage. Pakiet VSPackage może obsługiwać wiele kategorii ustawień, z których każda jest zdefiniowana przez niestandardowy punkt ustawień.

  • Implementacje ustawień opartych na zestawach międzyoperacyjnych (przy użyciu interfejsu IVsUserSettings) powinny tworzyć niestandardowy punkt ustawień, edytując rejestr lub używając skryptu rejestratora (plik .rgs). Aby uzyskać więcej informacji, zobacz Tworzenie skryptów rejestratora.

  • Kod korzystający z Managed Package Framework (MPF) powinien tworzyć punkty ustawień niestandardowych, dołączając ProvideProfileAttribute do pakietu VSPackage dla każdego punktu ustawień niestandardowych.

    Jeśli pojedynczy pakiet VSPackage obsługuje kilka punktów ustawień niestandardowych, każdy punkt ustawień niestandardowych jest implementowany przez oddzielną klasę, a każdy z nich jest rejestrowany przez unikatowe wystąpienie ProvideProfileAttribute klasy. W związku z tym klasa implementująca ustawienia może obsługiwać więcej niż jedną kategorię ustawień.

Szczegóły wpisu rejestru punktu ustawień niestandardowych

Punkty ustawień niestandardowych są tworzone w wpisie rejestru w następującej lokalizacji: HKLM\Software\Microsoft\VisualStudio\<Version>\UserSettings\<CSPName>, gdzie <CSPName> jest nazwą punktu ustawień niestandardowych obsługiwanego przez pakiet VSPackage i <wersja> jest wersją programu Visual Studio, na przykład 8.0.

Uwaga / Notatka

Ścieżka główna dla HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\VisualStudio\<Version> może zostać zastąpiona alternatywną ścieżką główną podczas inicjalizacji zintegrowanego środowiska programistycznego (IDE) programu Visual Studio. Aby uzyskać więcej informacji, zobacz przełącznikiCommand-Line.

Struktura wpisu rejestru jest pokazana poniżej:

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

<CSPName >= s '#12345'

Pakiet = "{XXXXXX XXXX XXXX XXXXXXXXX}"

Category = "{YYYYYY YYYY YYYY YYYY YYYYYYYYY}"

ResourcePackage = "{ZZZZZZ ZZZZ ZZZZ ZZZZ ZZZZZZZZZ}"

AlternateParent = CategoryName

Nazwa Typ Dane Opis
(Ustawienie domyślne) REG_SZ Nazwa punktu ustawień niestandardowych Klucz <CSPName> ma nielokalizowaną nazwę będącą punktem ustawień niestandardowych.

W przypadku implementacji opartych na MPF nazwa klucza jest uzyskiwana przez połączenie argumentów categoryName i objectName konstruktora ProvideProfileAttribute w categoryName_objectName.

Klucz może być pusty lub może zawierać identyfikator odwołania do zlokalizowanego ciągu w satelicie DLL. Ta wartość jest uzyskiwana z argumentu objectNameResourceID do konstruktora ProvideProfileAttribute .
Pakiet REG_SZ GUID Identyfikator GUID pakietu VSPackage implementującego punkt ustawień własnych.

Implementacje oparte na MPF przy użyciu klasy ProvideProfileAttribute, wykorzystują argument konstruktora objectType, zawierającego VSPackage i mechanizm refleksji Type, aby pozyskać tę wartość.
Kategoria REG_SZ GUID Identyfikator GUID identyfikujący kategorię ustawień.

W przypadku implementacji opartych na zestawach międzyoperacyjnych ta wartość może być dowolnie wybranym identyfikatorem GUID, który środowisko IDE programu Visual Studio przekazuje metodom ExportSettings i ImportSettings. Wszystkie implementacje tych dwóch metod powinny zweryfikować argumenty identyfikatora GUID.

W przypadku implementacji opartych na MPF, ten identyfikator GUID jest uzyskiwany za pomocą Type klasy implementującej mechanizm ustawień programu Visual Studio.
Pakiet Zasobów REG_SZ GUID Opcjonalny.

Ścieżka do biblioteki DLL satelitarnej zawierającej zlokalizowane ciągi, jeśli implementacja pakietu VSPackage nie dostarcza ich.

Narzędzie MPF używa refleksji, aby uzyskać odpowiedni zasób VSPackage, więc klasa ProvideProfileAttribute nie ustawia tego argumentu.
Alternatywny rodzic REG_SZ Nazwa folderu na stronie Opcje narzędzi zawierającej ten punkt ustawień niestandardowych. Opcjonalny.

Tę wartość należy ustawić tylko wtedy, gdy implementacja ustawień obsługuje strony Opcje narzędzi , które używają mechanizmu trwałości w zestawie SDK programu Visual Studio, a nie mechanizmu w modelu automatyzacji w celu zapisania stanu.

W takich przypadkach wartość w kluczu AlternateParent to sekcja topic ciągu topic.sub-topic, używanego do identyfikowania określonej strony NarzędziaOpcje. Na przykład dla strony ToolsOptions wartość Alternatywny Parent będzie wynosić "TextEditor.Basic".

Gdy ProvideProfileAttribute generuje punkt ustawień niestandardowych, jest taki sam jak nazwa kategorii.
  • Last updated on