ProvideOptionPageAttribute Třída

Reference

Definice

Obor názvů:: Microsoft.VisualStudio.Shell

Sestavení:: Microsoft.VisualStudio.Shell.14.0.dll

Sestavení:: Microsoft.VisualStudio.Shell.15.0.dll

Balíček:: Microsoft.VisualStudio.Shell.15.0 v17.9.37000

Důležité

Některé informace platí pro předběžně vydaný produkt, který se může zásadně změnit, než ho výrobce nebo autor vydá. Microsoft neposkytuje žádné záruky, výslovné ani předpokládané, týkající se zde uváděných informací.

Použijte tento atribut na nezávislé objekty, aby uživatelé mohli konfigurovat balíčky VSPackage prostřednictvím vlastní stránky Možností nástrojů.

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

Dědičnost: Attribute

RegistrationAttribute

ProvideOptionDialogPageAttribute
ProvideOptionPageAttribute

Atributy: AttributeUsageAttribute

Příklady

V následujícím příkladu se instance ProvideOptionPageAttribute použije na implementaci VSPackage pro registraci třídy DesignerOptionsPage, která je odvozena z DialogPage, jako poskytnutí VSPackage se stránkou Možnosti nástrojů .

Třídy odvozené z DialogPage jsou poskytovány s výchozí implementací funkcí nastavení sady Visual Studio, které lze přepsat. Integrované vývojové prostředí (IDE) využívá tuto podporu nastavení sady Visual Studio, pokud se jako v příkladu ProvideProfileAttribute použije na implementaci VSPackage. Další informace o podpoře nastavení sady Visual Studio najdete v tématu Rozšíření uživatelských nastavení a možností.

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  
}

Poznámky

Poznámky pro implementátory

ProvideOptionPageAttribute Použijte na třídy implementují balíček VSPackage. Tento atribut umožňuje zaregistrovat, že konkrétní nezávislý objekt poskytuje uživatelům VSPackage přístup ke konfiguraci prostřednictvím vlastní stránky Možnosti nástrojů .

Kontext atributu


Platí pro	Balíčky VSPackage umožňují konfiguraci prostřednictvím vlastních stránek možností nástrojů implementovaných buď prostřednictvím rozhraní spravovaných DialogPage balíčků, nebo pomocí kódu sady Visual Studio SDK.
Opakovatelnost	Yes
Požadované atributy	DefaultRegistryRootAttribute
Neplatné atributy	Žádné

Poznámky pro volající

Tento atribut se používá pouze pro účely registrace a neovlivňuje chování kódu za běhu.

Zaregistruje ProvideOptionPageAttribute danou třídu implementující IProfileManager nebo DialogPage jako poskytující konkrétní podporu VSPackage pro zachování části nebo celého stavu VSPackage prostřednictvím mechanismu nastavení sady Visual Studio. Informace o stavu, které implementující třída uchovává, se označují jako kategorie nastavení sady Visual Studio a její definující položka v registru se označuje jako vlastní bod nastavení.

Poznámka

Když se načte stránka Možnosti vlastních nástrojů založených na rozhraní Managed Package Framework, integrované vývojové prostředí vytvoří instanci objektu zaregistrovaného ProvideOptionPageAttribute jako jeho implementaci. Podpora stránky Možnosti nástrojů spravovaného balíčku frameworku by měla být implementována na vlastním objektu, a ne na samotném VSPackage.

Další informace o vytváření a použití instancí ProvideOptionPageAttributenástroje najdete v následujícím příkladu a ProvideOptionPageAttribute.

Konstruktory

ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, Int32)	Vytvoří instanci nové instance ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String)	Vytvoří instanci nové instance ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String[])	Vytvoří instanci nové instance ProvideOptionPageAttribute.

Vlastnosti

CategoryDescriptionResourceId	ID prostředku obsahujícího lokalizovaný popis nadřazené kategorie stránky. Tato vlastnost se používá pouze v případě, že SupportsAutomation == true a SupportsProfiles == true. Lokalizovaný popis se zobrazí v průvodci nastavením importu/exportu.
CategoryName	Získá kanonický nelokalizovaný název kategorie Nástroje Možnosti stránky.
CategoryPackageGuid	ID balíčku, který vlastní kategorii, ve které je tato stránka registrována. Pokud není nastavena, předpokládá se, že balíček je ten, na který je tento atribut použit. Tato vlastnost se používá pouze v případě, že SupportsAutomation == true a SupportsProfiles == true. Vygenerujte ho z guidu pomocí Guid.ToString("B").
CategoryResourceID	Získá ID prostředku kategorie pro stránku Možnosti nástrojů.
DescriptionResourceId	ID prostředku obsahujícího lokalizovaný popis stránky. Tato vlastnost se používá pouze v případě, že SupportsAutomation == true a SupportsProfiles == true. Lokalizovaný popis se zobrazí v průvodci nastavením importu/exportu.
IsInUnifiedSettings	Získá nebo nastaví hodnotu určující, zda nastavení na této stránce byly onboardovány do sjednoceného nastavení prostřednictvím vytvoření nové registrace. Pokud je hodnota true, stránka se při povolení sjednoceného nastavení skryje, aby se její nastavení neduplikovala.
IsServerAware	Získá nebo nastaví hodnotu určující, zda uživatelské rozhraní této stránky zobrazuje nastavení, které jsou synchronizovány se serverem v připojeném scénáři klient-server pomocí ISettingsManager3 nebo rozhraní API s podobnou funkcí.
Keywords	Získá prohledávatelná klíčová slova pro tuto stránku možností. Každé klíčové slovo může být řetězec literálu, název/ID prostředku (předpona s "@"/"#") odkazující na jedno klíčové slovo nebo název/ID prostředku (předpona s "@"/"#") odkazující na seznam klíčových slov oddělených středníky.
NoShowAllView	Získá nebo nastaví, zda jsou zobrazeny agregované možnosti nástroje stránky.
PageName	Získá kanonický nelokalizovaný název nástroje možnosti stránky.
PageNameResourceId	Získá ID prostředku názvu stránky. (Zděděno od ProvideOptionDialogPageAttribute)
PageType	Získá typ stránky. (Zděděno od ProvideOptionDialogPageAttribute)
ProfileMigrationType	Nastaví typ migrace profilu.
ProvidesLocalizedCategoryName	Určuje, zda balíček obsahuje lokalizované prostředky pro název kategorie.
Sort	Pořadí řazení pro stránku možnosti Stránky možností se kompletují v následujícím pořadí: `1. The General page 2. Pages with a Sort value, sorted from low to high. 3. Pages without a Sort value, sorted alphabetically.`
SupportsAutomation	Získá, zda nástroj možnosti implementace stránky podporuje automatizaci.
SupportsProfiles	Získá nebo nastaví, zda nástroje Možnosti stránky implementace používá visual studio nastavení mechanismus k zachování jeho stavu.
TypeId	Získá aktuální instanci .ProvideOptionPageAttribute
UnifiedSettingsCategoryMoniker	Pro stránky s IsInUnifiedSettings = false získá nebo nastaví moniker nadřazené kategorie v hierarchii Sjednocená nastavení. Může to být moniker, který již existuje, nebo jeden, který existuje plus jeden další .. segment s oddělovači. Pokud je to druhé, vytvoří se v hierarchii Sjednocená nastavení nová kategorie s názvem by CategoryResourceID a tato stránka se do ní vloží. V opačném případě se tato stránka vloží pod existující kategorii.
VisibilityCmdUIContexts	Seznam identifikátorů GUID uiContext oddělených středníkem. Stránka možností je viditelná, pokud je aktivní libovolný text UIContext v seznamu. Pokud tato možnost není zadána, stránka možností je vždy viditelná.

Metody

GetPackageRegKeyPath(Guid)	Získá cestu registru (vzhledem k kořenovému adresáři registru aplikace) VSPackage. (Zděděno od RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	Zaregistruje stránku Možnosti nástrojů.
Unregister(RegistrationAttribute+RegistrationContext)	Odebere klíč stránky Možnosti nástrojů z registru.

Platí pro

Sdílet prostřednictvím