IPersistComponentSettings.SettingsKey Properti
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.
Mendapatkan atau menetapkan nilai kunci pengaturan aplikasi untuk instans kontrol saat ini.
public:
property System::String ^ SettingsKey { System::String ^ get(); void set(System::String ^ value); };
public string SettingsKey { get; set; }
member this.SettingsKey : string with get, set
Public Property SettingsKey As String
Nilai Properti
yang String berisi kunci pengaturan untuk instans kontrol saat ini.
Keterangan
SettingsKey Gunakan properti untuk membedakan grup properti pengaturan aplikasi ketika ada beberapa instans kelas pembungkus yang sama. Misalnya, jika kontrol berisi kelas pembungkus terkait, maka menempatkan beberapa instans kontrol yang sama dalam aplikasi yang sama biasanya akan menghasilkan beberapa instans kelas pembungkus. Kunci pengaturan hanya diperlukan ketika data konfigurasi berbeda berdasarkan per instans; misalnya, lokasi kontrol yang diposisikan secara dinamis.
Aturan umum berikut berlaku untuk penggunaan SettingsKey:
Kontrol, seperti kelas apa pun, mungkin berisi nol atau lebih kelas pengaturan aplikasi, yang berasal dari ApplicationSettingsBase. Setiap kelas pengaturan berisi propertinya sendiri ApplicationSettingsBase.SettingsKey , yang membantu membedakan beberapa instans kelas tersebut.
Kontrol harus memisahkan data per instans dan data bersamanya ke dalam kelas pengaturan yang berbeda.
Untuk kontrol dengan data konfigurasi per instans apa pun,
get
aksesor SettingsKey properti harus default ke Name kontrol. Dalam kebanyakan kasus, nama kontrol akan unik dalam aplikasi. Jika kontrol hanya berisi data konfigurasi bersama,get
harus default kenull
.Pengakses
set
untuk properti ini harus diimplementasikan untuk membedakan antara kelas pengaturan yang berisi per instans dan data konfigurasi bersama. Untuk setiap kelas pengaturan yang berisi data per instans,set
cukup teruskan ApplicationSettingsBase.SettingsKey ke properti kelas pengaturan. Untuk kelas pengaturan yang berisi data bersama,set
tidak boleh melakukan tindakan untuk kelas pengaturan tersebut.