Bagikan melalui

Mengelola pengaturan aplikasi (.NET)

  • Artikel

Pengaturan aplikasi memungkinkan Anda menyimpan informasi aplikasi secara dinamis. Dengan pengaturan aplikasi, Anda dapat menggunakan komputer klien untuk menyimpan informasi yang seharusnya tidak disertakan dalam kode aplikasi saat runtime. Pengaturan aplikasi dapat mencakup string koneksi, preferensi pengguna, dan banyak lagi.

Catatan

Pengaturan aplikasi menggantikan properti dinamis yang digunakan dalam versi Visual Studio yang lebih lama.

Setiap pengaturan aplikasi harus memiliki nama yang unik. Nama dapat berupa kombinasi huruf, angka, atau garis bawah apa pun. Nama tidak dapat dimulai dengan angka, dan tidak dapat memiliki spasi. Nama diubah melalui Name properti .

Pengaturan aplikasi dapat disimpan sebagai jenis data apa pun yang diserialisasikan/ToStringFromString ke XML atau memiliki TypeConverter yang mengimplementasikan . Jenis yang paling umum adalah String, , Integerdan Boolean. Anda juga dapat menyimpan nilai sebagai Color, Object, atau sebagai string koneksi.

Pengaturan aplikasi juga menyimpan nilai. Nilai diatur dengan properti Nilai dan harus cocok dengan jenis data pengaturan.

Selain itu, pengaturan aplikasi dapat terikat ke properti formulir atau kontrol pada waktu desain.

Ada dua jenis pengaturan aplikasi, berdasarkan cakupan:

  • Pengaturan cakupan aplikasi dapat digunakan untuk informasi seperti URL untuk layanan web atau string koneksi database. Nilai-nilai ini dikaitkan dengan aplikasi. Oleh karena itu, pengguna tidak dapat mengubahnya saat runtime.

  • Pengaturan cakupan pengguna dapat digunakan untuk informasi seperti mempertahankan posisi terakhir formulir atau preferensi font. Pengguna dapat mengubah nilai-nilai ini saat runtime.

Anda dapat mengubah jenis pengaturan dengan menggunakan properti Cakupan .

Sistem proyek menyimpan pengaturan aplikasi dalam dua file XML:

  • File app.config , yang dibuat pada waktu desain saat Anda membuat pengaturan aplikasi pertama

  • File user.config , yang dibuat pada runtime ketika pengguna yang menjalankan aplikasi mengubah nilai pengaturan pengguna apa pun

Perubahan pengaturan pengguna tidak ditulis ke disk kecuali aplikasi secara khusus memanggil metode untuk melakukannya.

Membuat pengaturan aplikasi pada waktu desain

Pada waktu desain, Anda dapat membuat pengaturan aplikasi dengan dua cara:

  • Gunakan halaman Pengaturan Perancang Proyek.

  • Gunakan jendela Properti untuk formulir atau kontrol, yang memungkinkan Anda mengikat pengaturan ke properti.

Saat Anda membuat pengaturan cakupan aplikasi (misalnya, database string koneksi, atau referensi ke sumber daya server), Visual Studio menyimpannya di file app.config dengan <applicationSettings> tag. String koneksi disimpan di <connectionStrings> bawah tag.

Saat Anda membuat pengaturan cakupan pengguna (misalnya, font default, halaman beranda, atau ukuran jendela), Visual Studio menyimpannya di file app.config dengan <userSettings> tag.

Penting

Saat menyimpan string koneksi di app.config, Anda harus mengambil tindakan pencegahan untuk menghindari mengungkapkan informasi sensitif, seperti kata sandi atau jalur server, di string koneksi.

Jika Anda mengambil informasi string koneksi dari sumber eksternal, seperti pengguna yang menyediakan ID pengguna dan kata sandi mereka, pastikan bahwa nilai yang Anda gunakan untuk membangun string koneksi Anda tidak berisi parameter string koneksi tambahan yang mengubah perilaku koneksi Anda.

Pertimbangkan untuk menggunakan fitur Konfigurasi Terproteksi untuk mengenkripsi informasi sensitif dalam file konfigurasi. Untuk informasi selengkapnya, lihat Melindungi informasi koneksi.

Catatan

Karena tidak ada model file konfigurasi untuk pustaka kelas, pengaturan aplikasi tidak berlaku untuk proyek Pustaka Kelas. Pengecualiannya adalah proyek VISUAL Studio Tools for Office Runtime DLL, yang dapat memiliki file konfigurasi.

Menggunakan file pengaturan yang dikustomisasi

Anda dapat menambahkan file pengaturan yang disesuaikan ke proyek Anda untuk manajemen grup pengaturan yang nyaman. Pengaturan yang terkandung dalam satu file dimuat dan disimpan sebagai unit. Menyimpan pengaturan dalam file terpisah untuk grup yang sering digunakan dan jarang digunakan dapat menghemat waktu dalam memuat dan menyimpan pengaturan.

Misalnya, Anda dapat menambahkan file SpecialSettings.settings ke proyek Anda. Meskipun kelas Anda SpecialSettings tidak diekspos di My namespace, View Code dapat membaca file pengaturan kustom yang berisi Partial Class SpecialSettings.

Perancang Pengaturan pertama-tama mencari file Pengaturan.pengaturan yang dibuat sistem proyek. File Pengaturan.pengaturan ini adalah file default yang ditampilkan Perancang Proyek di tab Pengaturan. File Pengaturan.pengaturan terletak di folder Proyek Saya untuk proyek Visual Basic dan di folder Properti untuk proyek Visual C#. Perancang Proyek kemudian mencari file pengaturan lain di folder akar proyek. Oleh karena itu, Anda harus meletakkan file pengaturan kustom Anda di sana. Jika Anda menambahkan file .settings di tempat lain dalam proyek Anda, Perancang Proyek tidak dapat menemukannya.

Mengakses atau mengubah pengaturan aplikasi saat runtime di Visual Basic

Di proyek Visual Basic, Anda dapat mengakses pengaturan aplikasi saat runtime dengan menggunakan My.Settings objek . Pada halaman Pengaturan , pilih tombol Tampilkan kode untuk melihat file Settings.vb . Settings.vb menentukan Settings kelas , yang memungkinkan Anda menangani peristiwa ini pada kelas pengaturan:

Kelas Settings di Settings.vb adalah kelas parsial yang hanya menampilkan kode milik pengguna, bukan seluruh kelas yang dihasilkan. Untuk informasi selengkapnya tentang mengakses pengaturan aplikasi dengan menggunakan My.Settings objek, lihat Mengakses pengaturan aplikasi (.NET Framework).

Nilai pengaturan yang dilingkup pengguna yang diubah pengguna saat runtime, misalnya, posisi formulir, disimpan dalam file user.config . Nilai default masih disimpan di app.config.

Jika ada pengaturan yang dicakup pengguna diubah selama runtime, misalnya dalam menguji aplikasi, dan Anda ingin mengatur ulang pengaturan ini ke nilai defaultnya, pilih tombol Sinkronkan .

Kami menyarankan agar Anda menggunakan My.Settings objek dan file .settings default untuk mengakses pengaturan. Anda dapat menggunakan Perancang Pengaturan untuk menetapkan properti ke pengaturan, dan, juga, pengaturan pengguna disimpan secara otomatis sebelum penonaktifan aplikasi. Namun, aplikasi Visual Basic Anda dapat mengakses pengaturan secara langsung. Dalam hal ini Anda harus mengakses MySettings kelas dan menggunakan file .settings kustom di akar proyek. Anda harus menyimpan pengaturan pengguna sebelum mengakhiri aplikasi, seperti yang akan Anda lakukan untuk aplikasi C#, seperti yang dijelaskan di bagian berikut.

Mengakses atau mengubah pengaturan aplikasi saat runtime di C#

Dalam bahasa selain Visual Basic, seperti C#, Anda harus mengakses kelas secara Settings langsung, seperti yang ditunjukkan dalam contoh Visual C# berikut.

Properties.Settings.Default.FirstUserSetting = "abc";

Anda harus secara eksplisit memanggil Save metode kelas pembungkus ini untuk mempertahankan pengaturan pengguna. Anda biasanya melakukannya dalam Closing penanganan aktivitas formulir utama. Contoh C# berikut menunjukkan panggilan ke Save metode .

Properties.Settings.Default.Save();

Untuk informasi umum tentang mengakses pengaturan aplikasi melalui Settings kelas, lihat Gambaran umum pengaturan aplikasi (.NET Framework).

Konten terkait