ProvideToolboxItemsAttribute 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.11.40262

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 Klassen an, die VSPackages implementieren, um zu deklarieren, wenn sie einen Satz von Elementen für die Visual Studio-Toolbox anbieten.

public ref class ProvideToolboxItemsAttribute : Microsoft::VisualStudio::Shell::RegistrationAttribute

[System.AttributeUsage(System.AttributeTargets.Class, Inherited=true)]
public class ProvideToolboxItemsAttribute : Microsoft.VisualStudio.Shell.RegistrationAttribute

[<System.AttributeUsage(System.AttributeTargets.Class, Inherited=true)>]
type ProvideToolboxItemsAttribute = class
    inherit RegistrationAttribute

Public Class ProvideToolboxItemsAttribute
Inherits RegistrationAttribute

Vererbung: Attribute

RegistrationAttribute
ProvideToolboxItemsAttribute

Attribute: AttributeUsageAttribute

Beispiele

Im folgenden Beispiel geben die auf die Klasse MyPackage angewendeten Attribute an, dass sie Version 1 der Toolboxelemente von mit den beiden Zwischenablageformaten "CF_XMLCODE" und "InPlaceMenuEditorMenu" unterstützt.

[DefaultRegistryRoot("Software\\Microsoft\\VisualStudio\\8.0")]  
[ProvideToolboxItems(true, 1)]  
[ProvideToolboxFormat("CF_XMLCODE")]  
[ProvideToolboxFormat("InPlaceMenuEditorMenu")]  
[Guid("XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX")]  
internal sealed class MyPackage : Package

Hinweise

Attributkontext


Gilt für:	Klassen, die VSPackages bereitstellen, indem , implementiert IVsPackagewerden Package.
Wiederholbar	No
Erforderliche Attribute	ProvideToolboxFormatAttribute
Ungültige Attribute	Keine

Wenden Sie dieses Attribut auf eine Packageabgeleitete IVsPackage Klasse oder eine Klasse an, die implementiert, die erforderlich ist, damit Benutzer Datenobjekte dieses Formats, die von der -Klasse bereitgestellt werden, in die Toolbox ziehen können. Diese implementierenden Klasse muss die Löschbenachrichtigungen selbst verarbeiten.

Dieses Attribut wird nur zu Registrierungszwecken verwendet und wirkt sich nicht auf das Verhalten von Code zur Laufzeit aus.

Abhängig von den im Konstruktor angegebenen Argumenten kann dieses Attribut angeben, dass ein VSPackage keine Toolboxelemente bereitstellt. Wenn das Attribut ProvideToolboxFormatAttribute einer Klasse hinzugefügt wird, um anzugeben, dass toolbox-Elemente bereitgestellt werden, muss auch eine oder mehrere Instanzen von ProvideToolboxFormatAttribute hinzugefügt werden.

Dieses Attribut verwendet ProvideToolboxFormatAttribute , um ein VSPackage als Bereitstellung von Toolboxelementen eines bestimmten Formats zu registrieren.

Wenn dieses Attribut angibt, dass Toolboxelemente bereitgestellt werden, muss das VSPackage die ToolboxInitialized Ereignisse und ToolboxUpgraded behandeln.

Jedes VSPackage, das dieses Attribut verwendet, muss einen Handler für die ToolboxInitialized Ereignisse und ToolboxUpgraded bereitstellen.

Konstruktoren

ProvideToolboxItemsAttribute(Int32)	Erstellt eine neue instance, von der angegeben wird, ob eine Klasse, die ProvideToolboxItemsAttribute ein VSPackage implementiert, Toolboxelemente bereitstellt.
ProvideToolboxItemsAttribute(Int32, Boolean)	Initialisiert eine neue Instanz von ProvideToolboxItemsAttribute für die angegebene Version.

Eigenschaften

NeedsCallBackAfterReset	Wenn Sie dies auf true festlegen, wird nach jedem Zurücksetzen der Toolbox ein ToolboxInitialized-Ereignis erzwungen. Dies kann beim Entwickeln Ihres Pakets verwendet werden, um die Toolbox zu erzwingen, die Liste der Elemente zum Paket jedes Mal anzufordern (falls sie geändert wurde). Bei ausgelieferten Produkten empfiehlt es sich, den Wert false zu belassen, damit der Cache für eine bessere Leistung verwendet werden kann. In einigen Szenarien (z. B. Elementliste, die nicht im Cache beibehalten werden können) muss dieses Flag möglicherweise auf true festgelegt werden.
TypeId	Überschreiben Sie die TypeID-Eigenschaft, damit die abgeleiteten RegistrationAttribute-Klassen mit System.ComponentModel.TypeDescriptor.GetAttributes(...) arbeiten können. Ein von diesem abgeleitetes Attribut muss diese Eigenschaft nur überschreiben, wenn es eine bessere Steuerung für die Instanzen benötigt, die auf eine Klasse angewendet werden können. (Geerbt von RegistrationAttribute)
Version	Eigenschaft, die die Version der Toolboxelemente zurückgibt, die ein VSPackage bereitstellt.

Methoden

GetPackageRegKeyPath(Guid)	Ruft den Registrierungspfad (relativ zum Registrierungsstamm der Anwendung) des VSPackages ab. (Geerbt von RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	Registriert ein VSPackage als Toolboxelementanbieter für angegebene Formate, wenn es von einem externen Registrierungstool wie regpkg.exe aufgerufen wird. Weitere Informationen finden Sie unter Registrieren von VSPackages.
Unregister(RegistrationAttribute+RegistrationContext)	Kehrt die Änderungen um, die die Register(RegistrationAttribute+RegistrationContext)-Methode zur Registrierung angewendet hat.

Gilt für:

Freigeben über