ProvideOptionPageAttribute Kelas

Referensi

Definisi

Ruang nama:: Microsoft.VisualStudio.Shell

Rakitan:: Microsoft.VisualStudio.Shell.14.0.dll

Rakitan:: Microsoft.VisualStudio.Shell.15.0.dll

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

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 objek independen untuk memungkinkan pengguna mengonfigurasi VSPackages melalui halaman Opsi Alat kustom.

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

Warisan: Attribute

RegistrationAttribute

ProvideOptionDialogPageAttribute
ProvideOptionPageAttribute

Atribut: AttributeUsageAttribute

Contoh

Dalam contoh di bawah ini, instans ProvideOptionPageAttribute diterapkan ke implementasi VSPackage untuk mendaftarkan kelas DesignerOptionsPage, yang berasal dari DialogPage, seperti yang menyediakan VSPackage dengan halaman Opsi Alat .

Kelas yang berasal dari DialogPage disediakan dengan implementasi default fungsionalitas pengaturan Visual Studio, yang dapat ditimpa. IDE menggunakan dukungan pengaturan Visual Studio ini jika, seperti dalam contoh, ProvideProfileAttribute diterapkan ke implementasi VSPackage. Untuk informasi selengkapnya tentang dukungan pengaturan Visual Studio, lihat Memperluas Pengaturan dan Opsi Pengguna.

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  
}

Keterangan

Catatan untuk Pelaksana

Terapkan ke ProvideOptionPageAttribute kelas yang mengimplementasikan VSPackage. Atribut ini memungkinkan untuk mendaftarkan bahwa objek independen tertentu memberi pengguna VSPackage akses konfigurasi melalui halaman Opsi Alat kustom.

Konteks Atribut


Berlaku untuk	VSPackages memungkinkan konfigurasi melalui halaman Opsi Alat kustom yang diterapkan baik melalui Kerangka Kerja DialogPage Paket Terkelola atau dengan menggunakan kode Visual Studio SDK.
Berulang	Ya
Atribut yang diperlukan	DefaultRegistryRootAttribute
Atribut tidak valid	Tidak ada

Catatan untuk Penelepon

Atribut ini hanya digunakan untuk tujuan pendaftaran dan tidak memengaruhi perilaku runtime kode.

mendaftarkan ProvideOptionPageAttribute penerapan IProfileManager kelas tertentu atau DialogPage sebagai memberikan dukungan VSPackage tertentu untuk bagian bertahan atau semua status VSPackage melalui mekanisme pengaturan Visual Studio. Informasi status yang dipertahankan oleh kelas penerapan disebut sebagai kategori pengaturan Visual Studio dan entri yang menentukan dalam registri disebut sebagai Titik Pengaturan Kustom.

Catatan

Saat halaman Opsi Alat kustom berbasis Kerangka Kerja Paket Terkelola dimuat, IDE membuat instans objek yang didaftarkan sebagai ProvideOptionPageAttribute penerapannya. Dukungan halaman Opsi Alat Kerangka Kerja Paket Terkelola harus diimplementasikan pada objeknya sendiri dan bukan pada VSPackage itu sendiri.

Untuk informasi selengkapnya tentang membuat dan menerapkan instans ProvideOptionPageAttribute, lihat contoh di bawah ini dan ProvideOptionPageAttribute.

Konstruktor

ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, Int32)	Membuat instans baru Dari ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String)	Membuat instans baru Dari ProvideOptionPageAttribute.
ProvideOptionPageAttribute(Type, String, String, Int16, Int16, Boolean, String[])	Membuat instans baru Dari ProvideOptionPageAttribute.

Properti

CategoryDescriptionResourceId	ID sumber daya yang berisi deskripsi yang dilokalkan dari kategori induk halaman. Properti ini hanya digunakan jika SupportsAutomation == true dan SupportsProfiles == true. Deskripsi yang dilokalkan muncul di wizard pengaturan impor/ekspor.
CategoryName	Mendapatkan nama nonlokalisasi kanonis dari kategori halaman Opsi Alat.
CategoryPackageGuid	ID paket yang memiliki kategori tempat halaman ini terdaftar. Jika ini tidak diatur, paket diasumsikan sebagai yang menerapkan atribut ini. Properti ini hanya digunakan jika SupportsAutomation == true dan SupportsProfiles == true. Hasilkan ini dari Guid dengan Guid.ToString("B").
CategoryResourceID	Mendapatkan ID sumber daya kategori untuk halaman Opsi Alat.
DescriptionResourceId	ID sumber daya yang berisi deskripsi halaman yang dilokalkan. Properti ini hanya digunakan jika SupportsAutomation == true dan SupportsProfiles == true. Deskripsi yang dilokalkan muncul di wizard pengaturan impor/ekspor.
IsInUnifiedSettings	Mendapatkan atau menetapkan nilai yang menunjukkan apakah pengaturan di halaman ini telah di-onboard ke Pengaturan Terpadu melalui pembuatan pendaftaran baru. Jika true, halaman disembunyikan saat Pengaturan Terpadu diaktifkan sehingga pengaturannya tidak diduplikasi.
IsServerAware	Mendapatkan atau menetapkan nilai yang menunjukkan apakah UI halaman ini menunjukkan pengaturan yang disinkronkan dengan server dalam skenario server klien yang terhubung dengan menggunakan ISettingsManager3 atau API dengan fungsionalitas serupa.
Keywords	Mendapatkan kata kunci yang dapat dicari untuk halaman opsi ini. Setiap kata kunci mungkin berupa string literal, nama/ID sumber daya (diawali dengan "@"/"#") yang menunjuk ke satu kata kunci, atau nama/ID sumber daya (diawali dengan "@"/"#") yang menunjuk ke daftar kata kunci yang dibatasi titik koma.
NoShowAllView	Mendapatkan atau mengatur apakah halaman Opsi Alat agregat ditampilkan.
PageName	Mendapatkan nama nonlokalisasi kanonis dari halaman Opsi Alat.
PageNameResourceId	Mendapatkan ID sumber daya nama halaman. (Diperoleh dari ProvideOptionDialogPageAttribute)
PageType	Mendapatkan jenis halaman. (Diperoleh dari ProvideOptionDialogPageAttribute)
ProfileMigrationType	Mengatur jenis migrasi profil.
ProvidesLocalizedCategoryName	Menentukan apakah paket memiliki sumber daya yang dilokalkan untuk nama kategori.
Sort	Urutan sortir untuk halaman opsi. Halaman opsi disusun dalam urutan berikut: `1. The General page 2. Pages with a Sort value, sorted from low to high. 3. Pages without a Sort value, sorted alphabetically.`
SupportsAutomation	Mendapatkan apakah implementasi halaman Opsi Alat mendukung otomatisasi.
SupportsProfiles	Mendapatkan atau mengatur apakah implementasi halaman Opsi Alat menggunakan mekanisme pengaturan Visual Studio untuk mempertahankan statusnya.
TypeId	Mendapatkan instans saat ini dari ProvideOptionPageAttribute.
UnifiedSettingsCategoryMoniker	Untuk halaman dengan IsInUnifiedSettings = false, mendapatkan atau mengatur moniker kategori induk dalam hierarki Pengaturan Terpadu. Ini bisa menjadi moniker yang sudah ada, atau yang ada ditambah satu '.' tambahan - Segmen yang dibatasi. Jika yang terakhir, kategori baru bernama oleh CategoryResourceID dibuat dalam hierarki Pengaturan Terpadu dan halaman ini disisipkan di dalamnya. Jika tidak, halaman ini disisipkan di bawah kategori yang ada.
VisibilityCmdUIContexts	Daftar GUID UIContext yang dibatasi titik koma. Halaman opsi terlihat ketika UIContext dalam daftar aktif. Jika ini tidak ditentukan, halaman opsi selalu terlihat.

Metode

GetPackageRegKeyPath(Guid)	Mendapatkan jalur registri (relatif terhadap akar registri aplikasi) dari VSPackage. (Diperoleh dari RegistrationAttribute)
Register(RegistrationAttribute+RegistrationContext)	Mendaftarkan halaman Opsi Alat.
Unregister(RegistrationAttribute+RegistrationContext)	Menghapus kunci halaman Opsi Alat dari registri.

Berlaku untuk

Bagikan melalui