ProvideOptionPageAttribute Klasse

Referenz

Definition

Namespace:: Microsoft.VisualStudio.Shell

Assembly:: Microsoft.VisualStudio.Shell.14.0.dll

Assembly:: Microsoft.VisualStudio.Shell.15.0.dll

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

Wichtig

Einige Informationen beziehen sich auf Vorabversionen, die vor dem Release ggf. grundlegend überarbeitet werden. Microsoft übernimmt hinsichtlich der hier bereitgestellten Informationen keine Gewährleistungen, seien sie ausdrücklich oder konkludent.

Wenden Sie dieses Attribut auf unabhängige Objekte an, damit Benutzer VSPackages über eine benutzerdefinierte Seite Tools-Optionen konfigurieren können.

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

Vererbung: Attribute

RegistrationAttribute

ProvideOptionDialogPageAttribute
ProvideOptionPageAttribute

Attribute: AttributeUsageAttribute

Beispiele

Im folgenden Beispiel wird ein instance von ProvideOptionPageAttribute auf eine VSPackage-Implementierung angewendet, um die -Klasse DesignerOptionsPagezu registrieren, die von DialogPageabgeleitet wird, als Bereitstellung des VSPackage mit einer Seite Tools-Optionen.

Von abgeleitete DialogPage Klassen werden mit einer Standardimplementierung der Visual Studio-Einstellungsfunktionalität bereitgestellt, die überschrieben werden kann. Die IDE verwendet diese Unterstützung für Visual Studio-Einstellungen, wenn, wie im Beispiel, ProvideProfileAttribute auf die VSPackage-Implementierung angewendet wird. Weitere Informationen zur Unterstützung von Visual Studio-Einstellungen finden Sie unter Erweitern von Benutzereinstellungen und -optionen.

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  
}

Hinweise

Hinweise für Implementierer

Wenden Sie die auf Klassen an, die ProvideOptionPageAttribute ein VSPackage implementieren. Dieses Attribut ermöglicht die Registrierung, dass ein bestimmtes unabhängiges Objekt den Benutzern von VSPackage Konfigurationszugriff über eine benutzerdefinierte Seite Tools-Optionen bietet.

Attributkontext


Gilt für:	VSPackages ermöglichen die Konfiguration über benutzerdefinierte Tools-Optionsseiten , die entweder über das Verwaltete Paketframework DialogPage oder mithilfe des Visual Studio SDK-Codes implementiert werden.
Wiederholbar	Yes
Erforderliche Attribute	DefaultRegistryRootAttribute
Ungültige Attribute	Keine

Hinweise für Aufrufer

Dieses Attribut wird nur zu Registrierungszwecken verwendet und wirkt sich nicht auf das Laufzeitverhalten des Codes aus.

Die ProvideOptionPageAttribute registriert eine bestimmte Klasse, die implementiert oder als eine bestimmte VSPackage-Unterstützung zum Beibehalten eines Teils oder des gesamten VSPackage-Zustands über den Visual Studio-Einstellungsmechanismus implementiert IProfileManager oder DialogPage bereitstellt. Die zustandsinformationen, die von der implementierenden Klasse beibehalten werden, werden als Visual Studio-Einstellungskategorie bezeichnet, und ihr definierender Eintrag in der Registrierung wird als Benutzerdefinierter Einstellungspunkt bezeichnet.

Hinweis

Wenn eine Seite mit den optionen für benutzerdefinierte Tools geladen wird, instanziiert die IDE das Objekt, das bei ProvideOptionPageAttribute der Implementierung registriert wurde. Die Unterstützung der Optionen für verwaltete Paketframeworktools sollte für ein eigenes Objekt und nicht für das VSPackage selbst implementiert werden.

Weitere Informationen zum Erstellen und Anwenden von Instanzen von ProvideOptionPageAttributefinden Sie im folgenden Beispiel und ProvideOptionPageAttribute.

Konstruktoren

ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, Int32)	Instanziiert eine neue instance von ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String)	Instanziiert eine neue instance von ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String[])	Instanziiert eine neue instance von ProvideOptionPageAttribute.

Eigenschaften

CategoryDescriptionResourceId	Die ID einer Ressource, die die lokalisierte Beschreibung der übergeordneten Kategorie der Seite enthält. Diese Eigenschaft wird nur verwendet, wenn SupportsAutomation == true und SupportsProfiles == true. Die lokalisierte Beschreibung wird im Import-/Exporteinstellungen-Assistenten angezeigt.
CategoryName	Ruft den kanonischen nicht zugeordneten Namen der Kategorie der Seite Extras-Optionen ab.
CategoryPackageGuid	Die ID des Pakets, das die Kategorie besitzt, unter der diese Seite registriert ist. Wenn dies nicht festgelegt ist, wird davon ausgegangen, dass es sich bei dem Paket um das Paket handelt, auf das dieses Attribut angewendet wird. Diese Eigenschaft wird nur verwendet, wenn SupportsAutomation == true und SupportsProfiles == true. Generieren Sie diese aus einer GUID mit Guid.ToString("B").
CategoryResourceID	Ruft die Kategorieressourcen-ID für eine Seite Tools-Optionen ab.
DescriptionResourceId	Die ID einer Ressource, die die lokalisierte Beschreibung der Seite enthält. Diese Eigenschaft wird nur verwendet, wenn SupportsAutomation == true und SupportsProfiles == true. Die lokalisierte Beschreibung wird im Import-/Exporteinstellungen-Assistenten angezeigt.
IsInUnifiedSettings	Ruft einen Wert ab, der angibt, ob die Einstellungen auf dieser Seite durch die Erstellung einer neuen Registrierung in einheitliche Einstellungen integriert wurden, oder legt diesen fest. Wenn true, wird die Seite ausgeblendet, wenn Einheitliche Einstellungen aktiviert sind, sodass ihre Einstellungen nicht dupliziert werden.
IsServerAware	Ruft einen Wert ab, der angibt, ob die Benutzeroberfläche dieser Seite Einstellungen anzeigt, die mit dem Server in einem verbundenen Clientserverszenario mithilfe von ISettingsManager3 oder einer API mit ähnlicher Funktionalität synchronisiert werden, oder legt diesen fest.
Keywords	Ruft die durchsuchbaren Schlüsselwörter für diese Optionsseite ab. Jede Schlüsselwort (keyword) kann eine Literalzeichenfolge, ein Ressourcenname/eine Ressourcen-ID (präfixiert mit "@"/"#") sein, die auf einen einzelnen Schlüsselwort (keyword) verweist, oder ein Ressourcenname/eine Ressourcen-ID (präfixiert mit "@"/"#"), die auf eine durch Semikolon getrennte Liste von Schlüsselwörtern verweist.
NoShowAllView	Ruft ab oder legt fest, ob aggregierte Seiten für Tools-Optionen angezeigt werden.
PageName	Ruft den kanonischen nicht zugeordneten Namen der Seite Extrasoptionen ab.
PageNameResourceId	Ruft die Namenressourcen-ID der Seite ab. (Geerbt von ProvideOptionDialogPageAttribute)
PageType	Ruft den Typ der Seite ab. (Geerbt von ProvideOptionDialogPageAttribute)
ProfileMigrationType	Legt den Profilmigrationstyp fest.
ProvidesLocalizedCategoryName	Bestimmt, ob das Paket über die lokalisierten Ressourcen für den Kategorienamen verfügt.
Sort	Die Sortierreihenfolge für die Optionsseite. Optionsseiten werden in der folgenden Reihenfolge sortiert: `1. The General page 2. Pages with a Sort value, sorted from low to high. 3. Pages without a Sort value, sorted alphabetically.`
SupportsAutomation	Ruft ab, ob eine Implementierung der Tools-Optionen-Seite die Automatisierung unterstützt.
SupportsProfiles	Ruft ab oder legt fest, ob eine Implementierung der Tools-Optionen-Seite den Visual Studio-Einstellungsmechanismus verwendet, um ihren Zustand beizubehalten.
TypeId	Ruft die aktuelle Instanz von ProvideOptionPageAttribute ab.
UnifiedSettingsCategoryMoniker	Ruft für Seiten mit IsInUnifiedSettings = false den Moniker der übergeordneten Kategorie in der Hierarchie einheitlicher Einstellungen ab oder legt diese fest. Dies kann ein bereits vorhandener Moniker oder ein vorhandener Moniker plus ein zusätzliches "" sein. -Segment mit Trennzeichen. Bei letzterem wird eine neue Kategorie mit dem Namen von CategoryResourceID in der Hierarchie "Einheitliche Einstellungen" erstellt, und diese Seite wird darin eingefügt. Andernfalls wird diese Seite unter die vorhandene Kategorie eingefügt.
VisibilityCmdUIContexts	Eine durch Semikolon getrennte Liste von UIContext-GUIDs. Die Optionsseite ist sichtbar, wenn uiContext in der Liste aktiv ist. Wenn dies nicht angegeben ist, ist die Optionsseite immer sichtbar.

Methoden

GetPackageRegKeyPath(Guid)	Ruft den Registrierungspfad (relativ zum Registrierungsstamm der Anwendung) des VSPackages ab. (Geerbt von RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	Registriert die Seite Extrasoptionen.
Unregister(RegistrationAttribute+RegistrationContext)	Entfernt den Seitenschlüssel Extrasoptionen aus der Registrierung.

Gilt für:

Freigeben über