ProvideOptionPageAttribute Klasa

Odwołanie

Definicja

Przestrzeń nazw:: Microsoft.VisualStudio.Shell

Zestaw:: Microsoft.VisualStudio.Shell.14.0.dll

Zestaw:: Microsoft.VisualStudio.Shell.15.0.dll

Pakiet:: Microsoft.VisualStudio.Shell.15.0 v17.9.37000

Ważne

Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.

Zastosuj ten atrybut do niezależnych obiektów, aby umożliwić użytkownikom konfigurowanie pakietów VSPackage za pomocą niestandardowej strony Opcje narzędzi.

public ref class ProvideOptionPageAttribute sealed : Microsoft::VisualStudio::Shell::ProvideOptionDialogPageAttribute

public ref class ProvideOptionPageAttribute sealed : Microsoft::VisualStudio::Shell::ProvideOptionDialogPageAttribute

[System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)]
public sealed class ProvideOptionPageAttribute : Microsoft.VisualStudio.Shell.ProvideOptionDialogPageAttribute

[<System.AttributeUsage(System.AttributeTargets.Class, AllowMultiple=true, Inherited=true)>]
type ProvideOptionPageAttribute = class
    inherit ProvideOptionDialogPageAttribute

Public NotInheritable Class ProvideOptionPageAttribute
Inherits ProvideOptionDialogPageAttribute

Dziedziczenie: Attribute

RegistrationAttribute

ProvideOptionDialogPageAttribute
ProvideOptionPageAttribute

Atrybuty: AttributeUsageAttribute

Przykłady

W poniższym przykładzie wystąpienie ProvideOptionPageAttribute programu jest stosowane do implementacji pakietu VSPackage w celu zarejestrowania klasy DesignerOptionsPage, która pochodzi z DialogPageklasy , jako udostępniania pakietu VSPackage na stronie Opcje narzędzi .

Klasy pochodne DialogPage są dostarczane z domyślną implementacją funkcji ustawień programu Visual Studio, które można zastąpić. Środowisko IDE korzysta z tej obsługi ustawień programu Visual Studio, jeśli, podobnie jak w przykładzie, ProvideProfileAttribute jest stosowane do implementacji pakietu VSPackage. Aby uzyskać więcej informacji na temat obsługi ustawień programu Visual Studio, zobacz Rozszerzanie ustawień użytkownika i opcji.

using Microsoft.VisualStudio.Shell;  
namespace Example  
{  
[DefaultRegistryRoot("Software\\Microsoft\\VisualStudio\\8.0")]   
[ProvideOptionPage(typeof(DesignerOptionsPage), "MyDesigner", "OptionPage", 1000, 1001, true)]   
[ProvideProfileAttribute(typeof(DesignerOptionsPage), "MyDesigner", "OptionPage", 1002, 1003, true)]  
[ProvideProfileAttribute(typeof(PersistCurrentDesign), "MyDesigner","CurrentDesign", 1004, 1005, false)]  
[Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]  
public class MyPackage : Package  
{  
//Implementation here  
}  

[Guid("YYYYYYYY-YYYY-YYYY-YYYY-YYYYYYYYYYYY")]  
internal class DesignerOptionsPage: DialogPage {  
//Implementation here  
}  

[Guid("ZZZZZZZZ-ZZZZ-ZZZZ-ZZZZ-ZZZZZZZZZZZZ")]  
internal class PersistCurrentDesign: IProfileManager {  
//Implementation here  
}

Uwagi

Uwagi dotyczące implementacji

Zastosuj do ProvideOptionPageAttribute klas implementowania pakietu VSPackage. Ten atrybut umożliwia zarejestrowanie, że określony niezależny obiekt zapewnia użytkownikom pakietu VSPackage dostęp do konfiguracji za pośrednictwem niestandardowej strony Opcje narzędzi .

Kontekst atrybutu


Dotyczy	Pakiety VSPackage umożliwiają konfigurację za pośrednictwem niestandardowych stron Opcji narzędzi zaimplementowanych za pośrednictwem programu Managed Package Framework DialogPage lub przy użyciu kodu zestawu SDK programu Visual Studio.
Powtarzalność	Tak
Wymagane atrybuty	DefaultRegistryRootAttribute
Nieprawidłowe atrybuty	Brak

Uwagi dotyczące wywoływania

Ten atrybut jest używany tylko do celów rejestracji i nie ma wpływu na zachowanie środowiska uruchomieniowego kodu.

Rejestruje ProvideOptionPageAttribute daną klasę implementując IProfileManager lub DialogPage jako zapewniającą określoną obsługę pakietu VSPackage na potrzeby utrwalania części lub całego stanu pakietu VSPackage za pośrednictwem mechanizmu ustawień programu Visual Studio. Informacje o stanie utrwalane przez klasę implementowania są określane jako kategoria ustawień programu Visual Studio, a jej wpis definiujący w rejestrze jest określany jako punkt ustawień niestandardowych.

Uwaga

Po załadowaniu strony Opcje narzędzi niestandardowych opartych na programie Managed Package Framework środowisko IDE tworzy wystąpienie obiektu zarejestrowanego przez ProvideOptionPageAttribute jego implementację. Obsługa strony Narzędzia struktury pakietów zarządzanych powinna być implementowana na własnym obiekcie, a nie na samym pakiecie VSPackage.

Aby uzyskać więcej informacji na temat tworzenia i stosowania wystąpień programu ProvideOptionPageAttribute, zobacz poniższy przykład i ProvideOptionPageAttribute.

Konstruktory

ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, Int32)	Tworzy wystąpienie nowego wystąpienia elementu ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String)	Tworzy wystąpienie nowego wystąpienia elementu ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String[])	Tworzy wystąpienie nowego wystąpienia elementu ProvideOptionPageAttribute.

Właściwości

CategoryDescriptionResourceId	Identyfikator zasobu zawierającego zlokalizowany opis kategorii nadrzędnej strony. Ta właściwość jest używana tylko w przypadku wartości SupportsAutomation == true i SupportsProfiles == true. Zlokalizowany opis jest wyświetlany w kreatorze ustawień importu/eksportu.
CategoryName	Pobiera kanoniczną nielokalizowaną nazwę kategorii Opcje narzędzi.
CategoryPackageGuid	Identyfikator pakietu, który jest właścicielem kategorii, w której zarejestrowano tę stronę. Jeśli to nie jest ustawione, zakłada się, że pakiet jest tym, do którego jest stosowany ten atrybut. Ta właściwość jest używana tylko w przypadku wartości SupportsAutomation == true i SupportsProfiles == true. Wygeneruj to na podstawie identyfikatora Guid.ToString("B").
CategoryResourceID	Pobiera identyfikator zasobu kategorii dla strony Opcje narzędzi.
DescriptionResourceId	Identyfikator zasobu zawierającego zlokalizowany opis strony. Ta właściwość jest używana tylko w przypadku wartości SupportsAutomation == true i SupportsProfiles == true. Zlokalizowany opis jest wyświetlany w kreatorze ustawień importu/eksportu.
IsInUnifiedSettings	Pobiera lub ustawia wartość wskazującą, czy ustawienia na tej stronie zostały dołączone do ujednoliconych ustawień podczas tworzenia nowej rejestracji. Jeśli to prawda, strona jest ukryta po włączeniu ujednoliconych ustawień, więc jego ustawienia nie są zduplikowane.
IsServerAware	Pobiera lub ustawia wartość wskazującą, czy interfejs użytkownika tej strony pokazuje ustawienia synchronizowane z serwerem w scenariuszu połączonym klient-serwer przy użyciu protokołu ISettingsManager3 lub interfejsu API z podobną funkcjonalnością.
Keywords	Pobiera wyszukiwane słowa kluczowe dla tej strony opcji. Każde słowo kluczowe może być ciągiem literału, nazwą zasobu/identyfikatorem (poprzedzonym znakiem "@"/"#") wskazującym jedno słowo kluczowe lub nazwą/identyfikatorem zasobu (poprzedzoną znakiem "@"/"#") wskazującą listę słów kluczowych rozdzielanych średnikami.
NoShowAllView	Pobiera lub ustawia, czy są wyświetlane zagregowane strony Opcje narzędzi.
PageName	Pobiera kanoniczną nielokalizowaną nazwę strony Opcje narzędzi.
PageNameResourceId	Pobiera identyfikator zasobu nazwy strony. (Odziedziczone po ProvideOptionDialogPageAttribute)
PageType	Pobiera typ strony. (Odziedziczone po ProvideOptionDialogPageAttribute)
ProfileMigrationType	Ustawia typ migracji profilu.
ProvidesLocalizedCategoryName	Określa, czy pakiet ma zlokalizowane zasoby dla nazwy kategorii.
Sort	Kolejność sortowania dla strony opcji. Strony opcji są sortowane w następującej kolejności: `1. The General page 2. Pages with a Sort value, sorted from low to high. 3. Pages without a Sort value, sorted alphabetically.`
SupportsAutomation	Pobiera, czy implementacja strony Opcje narzędzi obsługuje automatyzację.
SupportsProfiles	Pobiera lub ustawia, czy implementacja strony Opcje narzędzi używa mechanizmu ustawień programu Visual Studio do utrwalania stanu.
TypeId	Pobiera bieżące wystąpienie elementu ProvideOptionPageAttribute.
UnifiedSettingsCategoryMoniker	W przypadku stron z IsInUnifiedSettings = false, pobiera lub ustawia moniker kategorii nadrzędnej w hierarchii Ujednolicone ustawienia. Może to być moniker, który już istnieje, lub jeden, który istnieje plus jeden dodatkowy "". -rozdzielany segment. Jeśli ta ostatnia kategoria o nazwie by CategoryResourceID zostanie utworzona w hierarchii ujednoliconych ustawień i zostanie wstawiona ta strona. W przeciwnym razie ta strona zostanie wstawiona w istniejącej kategorii.
VisibilityCmdUIContexts	Rozdzielana średnikami lista identyfikatorów GUID interfejsu użytkownikaContext. Strona opcji jest widoczna, gdy dowolny element UIContext na liście jest aktywny. Jeśli ta opcja nie jest określona, strona opcji jest zawsze widoczna.

Metody

GetPackageRegKeyPath(Guid)	Pobiera ścieżkę rejestru (względem katalogu głównego rejestru aplikacji) pakietu VSPackage. (Odziedziczone po RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	Rejestruje stronę Opcje narzędzi.
Unregister(RegistrationAttribute+RegistrationContext)	Usuwa klucz strony Opcje narzędzi z rejestru.

Dotyczy

Udostępnij przez