ProvideToolboxItemsAttribute Klasa
Definicja
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 klas implementowania pakietów VSPackage, aby zadeklarować, czy oferują zestaw elementów do przybornika programu Visual Studio.
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
- Dziedziczenie
- Atrybuty
Przykłady
W poniższym przykładzie atrybuty zastosowane do klasy MyPackage
wskazują, że obsługuje wersję 1 elementów przybornika z dwoma formatami schowka "CF_XMLCODE" i "InPlaceMenuEditorMenuMenu".
[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
Uwagi
Kontekst atrybutu
Dotyczy | Klasy dostarczające pakiet VSPackages przez implementację IVsPackage, Package. |
Powtarzalność | Nie |
Wymagane atrybuty | ProvideToolboxFormatAttribute |
Nieprawidłowe atrybuty | Brak |
Zastosuj ten atrybut do klasy pochodnej Packagelub klasy, która implementuje IVsPackage , która jest wymagana, aby umożliwić użytkownikom przeciąganie obiektów danych tego formatu dostarczonego przez klasę do przybornika. Ta klasa implementowania musi obsługiwać same powiadomienia o upuszczaniu.
Ten atrybut jest używany tylko do celów rejestracji i nie ma wpływu na sposób działania kodu w czasie wykonywania.
W zależności od argumentów określonych w konstruktorze ten atrybut może wskazywać, że pakiet VSPackage nie udostępnia żadnych elementów przybornika . Jeśli atrybut ProvideToolboxFormatAttribute zostanie dodany do klasy, aby wskazać, że udostępnia elementy przybornika , należy również dodać co najmniej jedno wystąpienie ProvideToolboxFormatAttribute .
Ten atrybut służy ProvideToolboxFormatAttribute do rejestrowania pakietu VSPackage jako udostępniania elementów przybornika danego formatu.
Jeśli ten atrybut określa, że podano elementy przybornika , pakiet VSPackage musi obsługiwać ToolboxInitialized zdarzenia i ToolboxUpgraded .
Każdy pakiet VSPackage używający tego atrybutu musi zapewnić procedurę obsługi dla zdarzeń ToolboxInitialized i ToolboxUpgraded .
Konstruktory
ProvideToolboxItemsAttribute(Int32) |
Tworzy nowe wystąpienie ProvideToolboxItemsAttribute wskazujące, czy klasa implementującą pakiet VSPackage udostępnia elementy przybornika. |
ProvideToolboxItemsAttribute(Int32, Boolean) |
Inicjuje ProvideToolboxItemsAttribute nowe wystąpienie dla określonej wersji. |
Właściwości
NeedsCallBackAfterReset |
Ustawienie wartości true spowoduje wymusi zdarzenie PrzybornikInitialized po zresetowaniu każdego przybornika. Może to być używane podczas tworzenia pakietu, aby wymusić na przyborniku monit o wyświetlenie listy elementów do pakietu za każdym razem (w przypadku zmiany). W przypadku dostarczonych produktów najlepiej pozostawić go na wartość false, aby pamięć podręczna mogła służyć do lepszej wydajności. W niektórych scenariuszach (takich jak lista elementów, których nie można utrwalić w pamięci podręcznej) może być konieczne ustawienie tej flagi na wartość true |
TypeId |
Zastąp właściwość TypeID, aby umożliwić klasom pochodnym RegistrationAttribute pracować z elementem System.ComponentModel.TypeDescriptor.GetAttributes(...). Atrybut pochodzący z tej właściwości będzie musiał zastąpić tę właściwość tylko wtedy, gdy potrzebuje lepszej kontroli nad wystąpieniami, które można zastosować do klasy. (Odziedziczone po RegistrationAttribute) |
Version |
Właściwość zwracająca wersję elementów przybornika zapewnianą przez pakiet VSPackage. |
Metody
GetPackageRegKeyPath(Guid) |
Pobiera ścieżkę rejestru (względem katalogu głównego rejestru aplikacji) pakietu VSPackage. (Odziedziczone po RegistrationAttribute) |
Register(RegistrationAttribute+RegistrationContext) |
Rejestruje pakiet VSPackage jako dostawca elementów przybornika dla określonych formatów, gdy jest wywoływany przez zewnętrzne narzędzie rejestracji, takie jak regpkg.exe. Aby uzyskać więcej informacji, zobacz Rejestrowanie pakietów VSPackage. |
Unregister(RegistrationAttribute+RegistrationContext) |
Odwraca zmiany zastosowane Register(RegistrationAttribute+RegistrationContext) przez metodę do rejestru. |