CreateUiDefinition elements

Artikel ini menjelaskan skema dan properti untuk semua elemen CreateUiDefinition yang didukung.

Skema

Skema untuk sebagian besar elemen adalah sebagai berikut:

{
  "name": "element1",
  "type": "Microsoft.Common.TextBox",
  "label": "Some text box",
  "defaultValue": "my value",
  "toolTip": "Provide a descriptive name.",
  "constraints": {},
  "options": {},
  "visible": true
}
Properti Wajib Deskripsi
nama Ya Pengidentifikasi internal untuk mereferensikan contoh tertentu dari elemen. Penggunaan nama elemen yang paling umum adalah di outputs, di mana nilai output dari elemen yang ditentukan dipetakan ke parameter templat. Anda juga dapat menggunakannya untuk mengikat nilai output elemen ke defaultValue elemen lain.
jenis Ya Kontrol UI untuk merender elemen. Untuk daftar jenis yang didukung, lihat Elemen.
label Ya Teks tampilan elemen. Beberapa jenis elemen berisi beberapa label, sehingga nilainya bisa menjadi objek yang berisi beberapa string.
defaultValue No Nilai default elemen. Beberapa tipe elemen mendukung nilai default yang kompleks, sehingga nilainya bisa menjadi objek.
toolTip No Teks yang akan ditampilkan di ujung alat elemen. Mirip dengan label, beberapa elemen mendukung beberapa string tip alat. Tautan sebaris dapat disematkan menggunakan sintaks Markdown.
batasan No Satu atau beberapa properti yang digunakan untuk menyesuaikan perilaku validasi elemen. Properti yang didukung untuk batasan bervariasi menurut jenis elemen. Beberapa jenis elemen tidak mendukung kustomisasi perilaku validasi, sehingga tidak memiliki batasan properti.
opsi No Properti tambahan yang mengkustomisasi perilaku elemen. Mirip dengan constraints, properti yang didukung bervariasi menurut jenis elemen.
dapat dilihat No Menunjukkan apakah elemen ditampilkan. Jika true, elemen dan elemen turunan yang berlaku ditampilkan. Nilai defaultnya adalah true. Gunakan fungsi logis untuk mengontrol nilai properti ini secara dinamis.

Elemen

Dokumentasi untuk setiap elemen berisi sampel UI, skema, komentar pada perilaku elemen (biasanya mengenai validasi dan kustomisasi yang didukung), dan output sampel.

Langkah berikutnya

Untuk pengantar mengenai cara membuat definisi antarmuka pengguna, lihat Mulai menggunakan CreateUiDefinition.