Kawalan (Rujukan API Klien)

Dalam aplikasi berasaskan model, kawalan mewakili elemen HTML pada borang. Sesetengah kawalan terikat kepada lajur tertentu, manakala yang lain mewakili kawalan tidak terikat seperti IFRAME, sumber web, atau subgrid yang ditambah ke borang.

Objek kawalan menyediakan kaedah untuk mengubah persembahan atau tingkah laku kawalan dan mengenal pasti lajur yang sepadan. Kawalan akses menggunakan salah satu koleksi berikut:

  • formContext.ui.controls
  • Seksyen formContext.ui.kawalan
  • formContext.data.entityAttribute.controls

BentukKonteks.Kaedah getControl ialah kaedah pintasan untuk mengakses formContext.ui.controls.get.

Nota

Apabila anda melakukan tindakan pada kawalan yang terikat kepada lajur, pertimbangkan bahawa kawalan tersebut mungkin muncul di halaman lebih daripada sekali. Secara amnya, anda harus melakukan tindakan yang sama untuk setiap kawalan bagi lajur. Anda boleh berulang melalui koleksi kawalan lajur dan melakukan tindakan pada setiap kawalan.

Kawalan dikategorikan mengikut jenis. Gunakan kaedah getControlType untuk menentukan jenis kawalan. Sesetengah kaedah kawalan hanya tersedia untuk jenis kawalan tertentu.

Artikel ini menyediakan maklumat tentang kaedah yang tersedia untuk setiap jenis kawalan.

Jenis kawalan standard

Kaedah-kaedah ini tersedia untuk kawalan Standard.

Kaedah Perihalan
addPemberitahuan Memaparkan pemberitahuan ralat atau cadangan dengan tindakan pilihan.
jelasPemberitahuan Mengeluarkan pemberitahuan daripada kawalan.
dapatkanAtribut Mengembalikan lajur yang terikat kepada kawalan.
getControlType Mengembalikan jenis kawalan.
dapatHilang Upaya Mengembalikan sama ada kawalan dilumpuhkan.
dapatLabel Mengembalikan label kawalan.
dapatNama Mengembalikan nama kawalan.
dapatKeluaran Mengembalikan kamus sifat output kawalan.
dapatIbu Bapa Mengembalikan bahagian yang mengandungi kawalan.
dapatkanBoleh Dilihat Mengembalikan sama ada kawalan kelihatan.
setLumpuhkan Mengaktifkan atau menyahaktifkan kawalan.
setFokus Mengalihkan fokus ke kawalan.
setLabel Menukar label kawalan.
setPemberitahuan Memaparkan mesej ralat untuk menunjukkan data tidak sah.
setBoleh dilihat Tunjuk atau sembunyikan kawalan.

Kaedah berikut untuk kawalan Standard telah tidak lagi digunakan: addOnKeyPress, fireOnKeyPress, dan removeOnKeyPress.

Jenis kawalan IFRAME

Kaedah ini tersedia untuk kawalan IFRAME.

Kaedah Perihalan
dapatkanTetingkapKandungannya Mengembalikan tetingkap kandungan bagi IFRAME atau sumber web.
getControlType Mengembalikan jenis kawalan.
dapatHilang Upaya Mengembalikan sama ada kawalan dilumpuhkan.
getInitialUrl Mengembalikan URL lalai yang dikonfigurasikan untuk IFRAME.
dapatLabel Mengembalikan label kawalan.
dapatNama Mengembalikan nama kawalan.
dapatObjek Mengembalikan objek borang yang mewakili IFRAME atau sumber web.
dapatIbu Bapa Mengembalikan bahagian yang mengandungi kawalan.
getSrc Mengembalikan URL yang sedang dipaparkan dalam IFRAME atau sumber web.
dapatkanBoleh Dilihat Mengembalikan sama ada kawalan kelihatan.
setLumpuhkan Mengaktifkan atau menyahaktifkan kawalan.
setFokus Mengalihkan fokus ke kawalan.
setLabel Menukar label kawalan.
setSrc Menetapkan URL untuk dipaparkan dalam IFRAME atau sumber web.
setBoleh dilihat Tunjuk atau sembunyikan kawalan.

Jenis kawalan Kbsearch (carian pangkalan pengetahuan)

Kaedah-kaedah ini tersedia untuk kawalan carian pangkalan pengetahuan.

Kaedah Perihalan
addOnPostSearch Menambah pengendali acara yang berjalan selepas carian selesai.
addOnResultDibuka Menambah pengendali acara yang berjalan apabila hasil carian dibuka.
addOnSelection Menambah pengendali acara yang berjalan apabila hasil carian dipilih.
getControlType Mengembalikan jenis kawalan.
dapatHilang Upaya Mengembalikan sama ada kawalan dilumpuhkan.
dapatLabel Mengembalikan label kawalan.
dapatNama Mengembalikan nama kawalan.
dapatIbu Bapa Mengembalikan bahagian yang mengandungi kawalan.
dapatSearchQuery Mengembalikan teks yang digunakan sebagai kriteria carian.
getSelectedResults Mengembalikan hasil carian yang sedang dipilih.
getTotalResultCount Mengembalikan bilangan hasil carian.
dapatkanBoleh Dilihat Mengembalikan sama ada kawalan kelihatan.
openSearchResult Membuka hasil carian yang ditentukan.
removeOnPostSearch Mengeluarkan pengendali acara untuk penyelesaian carian.
removeOnResultDibuka Mengeluarkan pengendali acara untuk membuka hasil carian.
removeOnSelection Mengeluarkan pengendali acara untuk memilih hasil carian.
setFokus Mengalihkan fokus ke kawalan.
setLabel Menukar label kawalan.
setSearchQuery Menetapkan teks yang digunakan sebagai kriteria carian.
setBoleh dilihat Tunjuk atau sembunyikan kawalan.

Nota

Apabila anda menambah kawalan carian pangkalan pengetahuan ke panel sosial, nama kawalan adalah searchwidgetcontrol_notescontrol. Kamu tak boleh tukar nama ini.

Jenis kawalan carian

Kaedah ini tersedia untuk kawalan carian.

Kaedah Perihalan
tambahPenapis Tersuai Menambah penapis pada hasil carian, digabungkan dengan penapis sedia ada menggunakan AND.
addCustomView Menambah paparan ke dialog carian.
addPemberitahuan Memaparkan pemberitahuan ralat atau cadangan dengan tindakan pilihan.
addOnLookupTagClick Menambah pengendali acara yang berjalan apabila tag carian diklik.
addPreSearch Menambah pengendali acara yang dijalankan sebelum carian carian.
jelasPemberitahuan Mengeluarkan pemberitahuan daripada kawalan.
dapatkanAtribut Mengembalikan lajur yang terikat kepada kawalan.
getControlType Mengembalikan jenis kawalan.
getDefaultView Mengembalikan ID bagi paparan carian lalai.
dapatHilang Upaya Mengembalikan sama ada kawalan dilumpuhkan.
getEntityTypes Mengembalikan jenis jadual yang dibenarkan dalam carian.
dapatLabel Mengembalikan label kawalan.
dapatNama Mengembalikan nama kawalan.
dapatIbu Bapa Mengembalikan bahagian yang mengandungi kawalan.
dapatkanBoleh Dilihat Mengembalikan sama ada kawalan kelihatan.
removeOnLookupTagClick Menghapuskan pengendali acara untuk klik tag carian.
alih keluarPracarian Menghapuskan pengendali acara yang berjalan sebelum carian carian.
setDefaultView Menetapkan paparan lalai dalam dialog carian.
setLumpuhkan Mengaktifkan atau menyahaktifkan kawalan.
setEntityTypes Menetapkan jenis jadual yang dibenarkan dalam carian.
setFokus Mengalihkan fokus ke kawalan.
setLabel Menukar label kawalan.
setPemberitahuan Memaparkan mesej ralat untuk menunjukkan data tidak sah.
setBoleh dilihat Tunjuk atau sembunyikan kawalan.

Pilihan dan jenis kawalan pilihan

Pilihan dan kawalan pilihan mempunyai set kaedah yang sama.

Kaedah Perihalan
addPemberitahuan Memaparkan pemberitahuan ralat atau cadangan dengan tindakan pilihan.
addOption Menambah pilihan pada kawalan.
jelasPemberitahuan Mengeluarkan pemberitahuan daripada kawalan.
clearOptions Mengeluarkan semua pilihan daripada kawalan.
dapatkanAtribut Mengembalikan lajur yang terikat kepada kawalan.
getControlType Mengembalikan jenis kawalan.
dapatHilang Upaya Mengembalikan sama ada kawalan dilumpuhkan.
dapatLabel Mengembalikan label kawalan.
dapatNama Mengembalikan nama kawalan.
dapatPilihan Mengembalikan pilihan yang tersedia, termasuk pilihan kosong dan mengecualikan pilihan yang telah dikeluarkan.
dapatIbu Bapa Mengembalikan bahagian yang mengandungi kawalan.
dapatkanBoleh Dilihat Mengembalikan sama ada kawalan kelihatan.
removeOption Menghapuskan satu pilihan daripada kawalan.
setLumpuhkan Mengaktifkan atau menyahaktifkan kawalan.
setFokus Mengalihkan fokus ke kawalan.
setLabel Menukar label kawalan.
setPemberitahuan Memaparkan mesej ralat untuk menunjukkan data tidak sah.
setBoleh dilihat Tunjuk atau sembunyikan kawalan.

Jenis kawalan borang pantas

Lihat formContext.ui.quickForms untuk mendapatkan maklumat tentang kaedah yang disokong untuk jenis kawalan ini.

Jenis kawalan subgrid

Lihat Grid dan subgrid untuk maklumat tentang kaedah yang disokong untuk jenis kawalan ini.

Jenis kawalan dinding garis masa

Kawalan garis masa memaparkan pos, aktiviti, dan nota dalam paparan yang bersatu. Kaedah ini tersedia untuk jenis kawalan ini.

Kaedah Perihalan
getControlType Mengembalikan jenis kawalan.
dapatHilang Upaya Mengembalikan sama ada kawalan dilumpuhkan.
dapatLabel Mengembalikan label kawalan.
dapatNama Mengembalikan nama kawalan.
dapatIbu Bapa Mengembalikan bahagian yang mengandungi kawalan.
dapatkanBoleh Dilihat Mengembalikan sama ada kawalan kelihatan.
Refresh Menyegarkan data yang dipaparkan dalam garis masa.
setLumpuhkan Mengaktifkan atau menyahaktifkan kawalan.
setFokus Mengalihkan fokus ke kawalan.
setLabel Menukar label kawalan.
setBoleh dilihat Tunjuk atau sembunyikan kawalan.

Jenis kawalan pemasa

Kaedah ini tersedia untuk kawalan pemasa.

Kaedah Perihalan
getControlType Mengembalikan jenis kawalan.
dapatHilang Upaya Mengembalikan sama ada kawalan dilumpuhkan.
dapatLabel Mengembalikan label kawalan.
dapatNama Mengembalikan nama kawalan.
dapatIbu Bapa Mengembalikan bahagian yang mengandungi kawalan.
dapatkan Negeri Mengembalikan keadaan semasa pemasa.
dapatkanBoleh Dilihat Mengembalikan sama ada kawalan kelihatan.
Refresh Menyegarkan data yang dipaparkan dalam pemasa.
setLumpuhkan Mengaktifkan atau menyahaktifkan kawalan.
setFokus Mengalihkan fokus ke kawalan.
setLabel Menukar label kawalan.
setBoleh dilihat Tunjuk atau sembunyikan kawalan.

Jenis kawalan sumber web

Kawalan sumber web mempunyai set kaedah yang sama yang tersedia seperti kawalan iframe. Lihat jenis kawalan iframe.

Jenis kawalan komponen borang

Jenis kawalan komponen borang mempunyai set kaedah yang sama tersedia seperti formContext pada borang utama. Lihat API Klien tingkah laku > komponen Borang.

Lajur