Kontrol (Referensi API Klien)

Dalam aplikasi berbasis model, kontrol mewakili elemen HTML pada formulir. Beberapa kontrol terikat ke kolom tertentu, sementara yang lain mewakili kontrol yang tidak terikat seperti IFRAME, sumber daya web, atau subgrid yang ditambahkan ke formulir.

Objek kontrol menyediakan metode untuk mengubah presentasi atau perilaku kontrol dan mengidentifikasi kolom yang sesuai. Kontrol akses dengan menggunakan salah satu koleksi berikut:

• formContext.ui.controls
• formContext.ui Section.controls
• formContext.data.entityAttribute.controls

FormContext. metode getControl adalah metode pintasan untuk mengakses formContext.ui.controls.get.

Nota

Saat Anda melakukan tindakan pada kontrol yang terkait dengan kolom, pertimbangkan bahwa kontrol mungkin muncul di halaman lebih dari sekali. Umumnya, Anda harus melakukan tindakan yang sama untuk setiap kontrol untuk kolom. Anda dapat mengulang koleksi kontrol kolom dan melakukan tindakan pada setiap kontrol.

Kontrol dikategorikan menurut jenis. Gunakan metode getControlType untuk menentukan jenis kontrol. Metode kontrol tertentu hanya tersedia untuk jenis kontrol tertentu.

Artikel ini menyediakan informasi tentang metode yang tersedia untuk setiap jenis kontrol.

Jenis kontrol standar

Metode ini tersedia untuk kontrol Standar.

Method	Description
addNotification	Menampilkan pemberitahuan kesalahan atau rekomendasi dengan tindakan opsional.
clearNotification	Menghapus pemberitahuan dari kontrol.
getAttribute	Mengembalikan kolom yang terikat dengan kontrol.
getControlType	Mengembalikan jenis kontrol.
getDisabled	Mengembalikan apakah kontrol dinonaktifkan.
getLabel	Mengembalikan label kontrol.
getName	Mengembalikan nama kontrol.
getOutputs	Mengembalikan kamus properti output kontrol.
getParent	Mengembalikan bagian yang berisi kontrol.
getVisible	Mengembalikan apakah kontrol terlihat.
setDisabled	Mengaktifkan atau menonaktifkan kontrol.
setFocus	Memindahkan fokus ke kontrol.
setLabel	Mengubah label kontrol.
setNotification	Menampilkan pesan kesalahan untuk menunjukkan bahwa data tidak valid.
setVisible	Menampilkan atau menyembunyikan kontrol.

Metode berikut untuk kontrol Standar tidak digunakan lagi: addOnKeyPress, fireOnKeyPress, dan removeOnKeyPress.

Jenis kontrol IFRAME

Metode ini tersedia untuk kontrol IFRAME.

Method	Description
getContentWindow	Mengembalikan jendela konten IFRAME atau sumber daya web.
getControlType	Mengembalikan jenis kontrol.
getDisabled	Mengembalikan apakah kontrol dinonaktifkan.
getInitialUrl	Mengembalikan URL default yang dikonfigurasi untuk IFRAME.
getLabel	Mengembalikan label kontrol.
getName	Mengembalikan nama kontrol.
getObject	Mengembalikan objek formulir yang mewakili IFRAME atau sumber daya web.
getParent	Mengembalikan bagian yang berisi kontrol.
getSrc	Mengembalikan URL yang saat ini ditampilkan di IFRAME atau sumber daya web.
getVisible	Mengembalikan apakah kontrol terlihat.
setDisabled	Mengaktifkan atau menonaktifkan kontrol.
setFocus	Memindahkan fokus ke kontrol.
setLabel	Mengubah label kontrol.
setSrc	Mengatur URL yang akan ditampilkan di IFRAME atau sumber daya web.
setVisible	Menampilkan atau menyembunyikan kontrol.

Jenis kontrol Kbsearch (pencarian pangkalan pengetahuan)

Metode ini tersedia untuk kontrol pencarian pangkalan pengetahuan.

Method	Description
addOnPostSearch	Menambahkan penanganan aktivitas yang berjalan setelah pencarian selesai.
addOnResultBuka	Menambahkan penanganan aktivitas yang berjalan saat hasil pencarian terbuka.
addOnSelection	Menambahkan penanganan aktivitas yang berjalan saat hasil pencarian dipilih.
getControlType	Mengembalikan jenis kontrol.
getDisabled	Mengembalikan apakah kontrol dinonaktifkan.
getLabel	Mengembalikan label kontrol.
getName	Mengembalikan nama kontrol.
getParent	Mengembalikan bagian yang berisi kontrol.
getSearchQuery	Mengembalikan teks yang digunakan sebagai kriteria pencarian.
getSelectedResults	Mengembalikan hasil pencarian yang saat ini dipilih.
getTotalResultCount	Mengembalikan jumlah hasil pencarian.
getVisible	Mengembalikan apakah kontrol terlihat.
openSearchResult	Membuka hasil pencarian tertentu.
removeOnPostSearch	Menghapus penanganan aktivitas untuk penyelesaian pencarian.
removeOnResultOpened	Menghapus penanganan aktivitas untuk membuka hasil pencarian.
removeOnSelection	Menghapus penanganan aktivitas untuk memilih hasil pencarian.
setFocus	Memindahkan fokus ke kontrol.
setLabel	Mengubah label kontrol.
setSearchQuery	Mengatur teks yang digunakan sebagai kriteria pencarian.
setVisible	Menampilkan atau menyembunyikan kontrol.

Nota

Saat Anda menambahkan kontrol pencarian pangkalan pengetahuan ke panel sosial, nama kontrolnya adalah searchwidgetcontrol_notescontrol. Kamu tidak bisa mengubah nama ini.

Jenis kontrol pencarian

Metode ini tersedia untuk kontrol pencarian.

Method	Description
addCustomFilter	Menambahkan filter ke hasil pencarian, dikombinasikan dengan filter yang ada dengan menggunakan AND.
addCustomView	Menambahkan tampilan ke dialog pencarian.
addNotification	Menampilkan pemberitahuan kesalahan atau rekomendasi dengan tindakan opsional.
addOnLookupTagClick	Menambahkan penanganan aktivitas yang berjalan saat tag pencarian diklik.
addPreSearch	Menambahkan penanganan aktivitas yang berjalan sebelum pencarian pencarian.
clearNotification	Menghapus pemberitahuan dari kontrol.
getAttribute	Mengembalikan kolom yang terikat dengan kontrol.
getControlType	Mengembalikan jenis kontrol.
getDefaultView	Mengembalikan ID tampilan pencarian default.
getDisabled	Mengembalikan apakah kontrol dinonaktifkan.
getEntityTypes	Mengembalikan tipe tabel yang diizinkan dalam pencarian.
getLabel	Mengembalikan label kontrol.
getName	Mengembalikan nama kontrol.
getParent	Mengembalikan bagian yang berisi kontrol.
getVisible	Mengembalikan apakah kontrol terlihat.
removeOnLookupTagClick	Menghapus penanganan aktivitas untuk klik tag pencarian.
removePreSearch	Menghapus penanganan aktivitas yang berjalan sebelum pencarian pencarian.
setDefaultView	Mengatur tampilan default dalam dialog pencarian.
setDisabled	Mengaktifkan atau menonaktifkan kontrol.
setEntityTypes	Mengatur jenis tabel yang diizinkan dalam pencarian.
setFocus	Memindahkan fokus ke kontrol.
setLabel	Mengubah label kontrol.
setNotification	Menampilkan pesan kesalahan untuk menunjukkan bahwa data tidak valid.
setVisible	Menampilkan atau menyembunyikan kontrol.

Pilihan dan jenis kontrol pilihan

Pilihan dan kontrol pilihan memiliki sekumpulan metode yang sama yang tersedia.

Method	Description
addNotification	Menampilkan pemberitahuan kesalahan atau rekomendasi dengan tindakan opsional.
addOption	Menambahkan opsi ke kontrol.
clearNotification	Menghapus pemberitahuan dari kontrol.
clearOptions	Menghapus semua opsi dari kontrol.
getAttribute	Mengembalikan kolom yang terikat dengan kontrol.
getControlType	Mengembalikan jenis kontrol.
getDisabled	Mengembalikan apakah kontrol dinonaktifkan.
getLabel	Mengembalikan label kontrol.
getName	Mengembalikan nama kontrol.
getOptions	Mengembalikan opsi yang tersedia, termasuk opsi kosong dan tidak termasuk opsi yang dihapus.
getParent	Mengembalikan bagian yang berisi kontrol.
getVisible	Mengembalikan apakah kontrol terlihat.
removeOption	Menghapus opsi dari kontrol.
setDisabled	Mengaktifkan atau menonaktifkan kontrol.
setFocus	Memindahkan fokus ke kontrol.
setLabel	Mengubah label kontrol.
setNotification	Menampilkan pesan kesalahan untuk menunjukkan bahwa data tidak valid.
setVisible	Menampilkan atau menyembunyikan kontrol.

Jenis kontrol formulir cepat

Lihat formContext.ui.quickForms untuk informasi tentang metode yang didukung untuk jenis kontrol ini.

Jenis kontrol subgrid

Lihat Kisi dan subgrid untuk informasi tentang metode yang didukung untuk jenis kontrol ini.

Jenis kontrol dinding garis waktu

Kontrol garis waktu menyajikan postingan, aktivitas, dan catatan dalam tampilan terpadu. Metode ini tersedia untuk jenis kontrol ini.

Method	Description
getControlType	Mengembalikan jenis kontrol.
getDisabled	Mengembalikan apakah kontrol dinonaktifkan.
getLabel	Mengembalikan label kontrol.
getName	Mengembalikan nama kontrol.
getParent	Mengembalikan bagian yang berisi kontrol.
getVisible	Mengembalikan apakah kontrol terlihat.
Refresh	Menyegarkan data yang ditampilkan di garis waktu.
setDisabled	Mengaktifkan atau menonaktifkan kontrol.
setFocus	Memindahkan fokus ke kontrol.
setLabel	Mengubah label kontrol.
setVisible	Menampilkan atau menyembunyikan kontrol.

Jenis kontrol timer

Metode ini tersedia untuk kontrol timer.

Method	Description
getControlType	Mengembalikan jenis kontrol.
getDisabled	Mengembalikan apakah kontrol dinonaktifkan.
getLabel	Mengembalikan label kontrol.
getName	Mengembalikan nama kontrol.
getParent	Mengembalikan bagian yang berisi kontrol.
getState	Mengembalikan status timer saat ini.
getVisible	Mengembalikan apakah kontrol terlihat.
Refresh	Menyegarkan data yang ditampilkan di timer.
setDisabled	Mengaktifkan atau menonaktifkan kontrol.
setFocus	Memindahkan fokus ke kontrol.
setLabel	Mengubah label kontrol.
setVisible	Menampilkan atau menyembunyikan kontrol.

Jenis kontrol sumber daya web

Kontrol sumber daya web memiliki sekumpulan metode yang sama yang tersedia sebagai kontrol iframe. Lihat jenis kontrol iframe.

Jenis kontrol komponen formulir

Jenis kontrol komponen formulir memiliki set metode yang sama yang tersedia sebagai formContext pada formulir utama. Lihat Api Klien perilaku > komponen formulir.

Artikel terkait

Columns