ProvideToolboxItemsAttribute Kelas
Definisi
Penting
Beberapa informasi terkait produk prarilis yang dapat diubah secara signifikan sebelum dirilis. Microsoft tidak memberikan jaminan, tersirat maupun tersurat, sehubungan dengan informasi yang diberikan di sini.
Terapkan atribut ini ke kelas yang menerapkan VSPackages untuk mendeklarasikan apakah mereka menawarkan sekumpulan item ke Visual Studio Toolbox.
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
- Warisan
- Atribut
Contoh
Dalam contoh di bawah ini, atribut yang diterapkan ke kelas MyPackage
menunjukkan bahwa ia mendukung item Toolbox versi 1 dengan dua format clipboard "CF_XMLCODE" dan "InPlaceMenuEditorMenu".
[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
Keterangan
Konteks Atribut
Berlaku untuk | Kelas yang menyediakan VSPackages dengan mengimplementasikan IVsPackage, Package. |
Berulang | Tidak |
Atribut yang diperlukan | ProvideToolboxFormatAttribute |
Atribut tidak valid | Tidak ada |
Terapkan atribut ini ke Packagekelas turunan atau kelas yang mengimplementasikan IVsPackage yang diperlukan untuk mengaktifkan dukungan bagi pengguna untuk menyeret objek data dari format ini, yang disediakan oleh kelas, ke Kotak Alat. Kelas penerapan ini harus menangani pemberitahuan drop itu sendiri.
Atribut ini hanya digunakan untuk tujuan pendaftaran, dan tidak memengaruhi bagaimana kode berperilaku pada runtime.
Bergantung pada argumen yang ditentukan dalam konstruktornya, atribut ini dapat menunjukkan bahwa VSPackage tidak menyediakan item Kotak Alat apa pun. Jika atribut ProvideToolboxFormatAttribute ditambahkan ke kelas untuk menunjukkan bahwa atribut menyediakan item Kotak Alat , satu atau beberapa instans ProvideToolboxFormatAttribute juga harus ditambahkan.
Atribut ini menggunakan ProvideToolboxFormatAttribute untuk mendaftarkan VSPackage sebagai penyediaan item Kotak Alat dari format tertentu.
Jika atribut ini menentukan bahwa item Kotak Alat disediakan, VSPackage harus menangani ToolboxInitialized peristiwa dan ToolboxUpgraded .
Setiap VSPackage yang menggunakan atribut ini harus menyediakan handler untuk ToolboxInitialized peristiwa dan ToolboxUpgraded .
Konstruktor
ProvideToolboxItemsAttribute(Int32) |
Membuat instans ProvideToolboxItemsAttribute baru yang menunjukkan apakah kelas yang mengimplementasikan VSPackage menyediakan item Kotak Alat. |
ProvideToolboxItemsAttribute(Int32, Boolean) |
Menginisialisasi instans ProvideToolboxItemsAttribute baru untuk versi yang ditentukan. |
Properti
NeedsCallBackAfterReset |
Mengatur ini ke true akan memaksa peristiwa ToolboxInitialized setelah setiap reset kotak alat. Ini dapat digunakan saat mengembangkan paket Anda untuk memaksa kotak alat menanyakan daftar item ke paket setiap kali (jika telah berubah). Untuk produk yang dikirim, yang terbaik adalah membiarkannya menjadi false sehingga cache dapat digunakan untuk performa yang lebih baik. Beberapa skenario (seperti daftar item yang tidak dapat dipertahankan ke cache) mungkin perlu mengatur bendera ini ke true |
TypeId |
Ambil alih properti TypeID untuk membiarkan RegistrationAttribute memperoleh kelas untuk bekerja dengan System.ComponentModel.TypeDescriptor.GetAttributes(...). Atribut yang berasal dari atribut ini harus mengambil alih properti ini hanya jika membutuhkan kontrol yang lebih baik pada instans yang dapat diterapkan ke kelas. (Diperoleh dari RegistrationAttribute) |
Version |
Properti yang mengembalikan versi item Kotak Alat yang disediakan VSPackage. |
Metode
GetPackageRegKeyPath(Guid) |
Mendapatkan jalur registri (relatif terhadap akar registri aplikasi) dari VSPackage. (Diperoleh dari RegistrationAttribute) |
Register(RegistrationAttribute+RegistrationContext) |
Mendaftarkan VSPackage sebagai penyedia item Kotak Alat untuk format tertentu saat dipanggil oleh alat pendaftaran eksternal seperti regpkg.exe. Untuk informasi selengkapnya, lihat Mendaftarkan VSPackages. |
Unregister(RegistrationAttribute+RegistrationContext) |
Membalikkan perubahan yang Register(RegistrationAttribute+RegistrationContext) telah diterapkan metode ke registri. |