ตัวควบคุม (การอ้างอิง Client API)

ในแอปแบบจําลองตัวควบคุมแสดงองค์ประกอบ HTML บนฟอร์ม ตัวควบคุมบางตัวถูกผูกไว้กับคอลัมน์ที่ระบุ ในขณะที่ตัวควบคุมอื่นแสดงถึงตัวควบคุมที่ไม่ถูกผูกไว้ เช่น IFRAME ทรัพยากรบนเว็บ หรือตารางย่อยที่เพิ่มลงในฟอร์ม

วัตถุ ตัวควบคุม มีวิธีการในการเปลี่ยนแปลงงานนําเสนอหรือลักษณะการทํางานของตัวควบคุม และระบุคอลัมน์ที่สอดคล้องกัน เข้าถึงตัวควบคุมโดยใช้หนึ่งในคอลเลกชันต่อไปนี้:

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

ฟอร์มข้อความgetControl method เป็นเมธอดทางลัดเพื่อเข้าถึง formContext.ui.controls.get

Note

เมื่อคุณดําเนินการกับตัวควบคุมที่เชื่อมโยงกับคอลัมน์ ให้พิจารณาว่าตัวควบคุมอาจปรากฏบนหน้ามากกว่าหนึ่งครั้ง โดยทั่วไปแล้ว คุณควรดําเนินการเหมือนกันสําหรับแต่ละตัวควบคุมสําหรับคอลัมน์ คุณสามารถวนรอบผ่าน คอลเลกชันตัวควบคุม คอลัมน์และดําเนินการกับตัวควบคุมแต่ละตัวได้

ตัวควบคุมจะถูกจัดประเภทตามชนิด ใช้เมธอด getControlType เพื่อกําหนดชนิดของตัวควบคุม บางวิธีการควบคุมจะพร้อมใช้งานสําหรับตัวควบคุมบางชนิดเท่านั้น

บทความนี้ให้ข้อมูลเกี่ยวกับวิธีการที่พร้อมใช้งานสําหรับตัวควบคุมแต่ละชนิด

ประเภทการควบคุมมาตรฐาน

วิธีการเหล่านี้จะพร้อมใช้งานสําหรับตัวควบคุม มาตรฐาน

วิธีการ คำอธิบาย
addNotification แสดงข้อผิดพลาดหรือการแจ้งเตือนคําแนะนําด้วยการดําเนินการทางเลือก
clearNotification ลบการแจ้งเตือนออกจากตัวควบคุม
getAttribute แสดงคอลัมน์ที่ตัวควบคุมผูกไว้
getControlType แสดงชนิดของตัวควบคุม
getDisabled แสดงว่าตัวควบคุมถูกปิดใช้งานหรือไม่
getLabel แสดงป้ายชื่อของตัวควบคุม
getName แสดงชื่อของตัวควบคุม
getOutputs แสดงพจนานุกรมของคุณสมบัติผลลัพธ์ของตัวควบคุม
getParent แสดงส่วนที่มีตัวควบคุม
getVisible ส่งกลับว่าตัวควบคุมมองเห็นได้หรือไม่
setDisabled เปิดหรือปิดใช้งานตัวควบคุม
setFocus ย้ายโฟกัสไปยังตัวควบคุม
setLabel เปลี่ยนแปลงป้ายชื่อของตัวควบคุม
setNotification แสดงข้อความแสดงข้อผิดพลาดเพื่อระบุว่าข้อมูลไม่ถูกต้อง
setVisible แสดงหรือซ่อนตัวควบคุม

วิธีการต่อไปนี้สําหรับตัวควบคุมมาตรฐานไม่ได้รับการสนับสนุน: addOnKeyPress, fireOnKeyPress และ removeOnKeyPress

ชนิดตัวควบคุม IFRAME

วิธีการเหล่านี้จะพร้อมใช้งานสําหรับตัวควบคุม IFRAME

วิธีการ คำอธิบาย
getContentWindow แสดงหน้าต่างเนื้อหาของ IFRAME หรือทรัพยากรบนเว็บ
getControlType แสดงชนิดของตัวควบคุม
getDisabled แสดงว่าตัวควบคุมถูกปิดใช้งานหรือไม่
getInitialUrl แสดง URL ค่าเริ่มต้นที่กําหนดค่าไว้สําหรับ IFRAME
getLabel แสดงป้ายชื่อของตัวควบคุม
getName แสดงชื่อของตัวควบคุม
getObject แสดงวัตถุฟอร์มที่แสดงถึง IFRAME หรือทรัพยากรบนเว็บ
getParent แสดงส่วนที่มีตัวควบคุม
getSrc แสดง URL ที่แสดงอยู่ใน IFRAME หรือทรัพยากรบนเว็บในปัจจุบัน
getVisible ส่งกลับว่าตัวควบคุมมองเห็นได้หรือไม่
setDisabled เปิดหรือปิดใช้งานตัวควบคุม
setFocus ย้ายโฟกัสไปยังตัวควบคุม
setLabel เปลี่ยนแปลงป้ายชื่อของตัวควบคุม
setSrc ตั้งค่า URL ที่จะแสดงใน IFRAME หรือทรัพยากรบนเว็บ
setVisible แสดงหรือซ่อนตัวควบคุม

ชนิดตัวควบคุม Kbsearch (การค้นหาฐานความรู้)

วิธีการเหล่านี้มีให้สําหรับตัวควบคุมการค้นหาฐานความรู้

วิธีการ คำอธิบาย
addOnPostSearch เพิ่มตัวจัดการเหตุการณ์ที่ทํางานหลังจากการค้นหาเสร็จสมบูรณ์
addOnResultOpened เพิ่มตัวจัดการเหตุการณ์ที่ทํางานเมื่อผลการค้นหาเปิดขึ้น
addOnSelection เพิ่มตัวจัดการเหตุการณ์ที่ทํางานเมื่อเลือกผลลัพธ์การค้นหา
getControlType แสดงชนิดของตัวควบคุม
getDisabled แสดงว่าตัวควบคุมถูกปิดใช้งานหรือไม่
getLabel แสดงป้ายชื่อของตัวควบคุม
getName แสดงชื่อของตัวควบคุม
getParent แสดงส่วนที่มีตัวควบคุม
getSearchQuery แสดงข้อความที่ใช้เป็นเกณฑ์การค้นหา
getSelectedResults แสดงผลลัพธ์การค้นหาที่เลือกในปัจจุบัน
getTotalResultCount แสดงจํานวนผลลัพธ์การค้นหา
getVisible ส่งกลับว่าตัวควบคุมมองเห็นได้หรือไม่
openSearchResult เปิดผลลัพธ์การค้นหาที่ระบุ
removeOnPostSearch ลบตัวจัดการเหตุการณ์สําหรับการดําเนินการค้นหาจนเสร็จสมบูรณ์
removeOnResultOpened ลบตัวจัดการเหตุการณ์สําหรับการเปิดผลลัพธ์การค้นหา
removeOnSelection ลบตัวจัดการเหตุการณ์สําหรับการเลือกผลลัพธ์การค้นหา
setFocus ย้ายโฟกัสไปยังตัวควบคุม
setLabel เปลี่ยนแปลงป้ายชื่อของตัวควบคุม
setSearchQuery ตั้งค่าข้อความที่ใช้เป็นเกณฑ์การค้นหา
setVisible แสดงหรือซ่อนตัวควบคุม

Note

เมื่อคุณเพิ่มตัวควบคุมการค้นหาฐานความรู้ไปยังบานหน้าต่างสังคม ชื่อตัวควบคุมคือsearchwidgetcontrol_notescontrol คุณไม่สามารถเปลี่ยนชื่อนี้ได้

ชนิดตัวควบคุมการค้นหา

วิธีการเหล่านี้จะพร้อมใช้งานสําหรับตัวควบคุมการค้นหา

วิธีการ คำอธิบาย
addCustomFilter เพิ่มตัวกรองให้กับผลลัพธ์การค้นหา โดยรวมกับตัวกรองที่มีอยู่โดยใช้ AND
addCustomView เพิ่มมุมมองลงในกล่องโต้ตอบการค้นหา
addNotification แสดงข้อผิดพลาดหรือการแจ้งเตือนคําแนะนําด้วยการดําเนินการทางเลือก
addOnLookupTagClick เพิ่มตัวจัดการเหตุการณ์ที่ทํางานเมื่อมีการคลิกแท็กการค้นหา
addPreSearch เพิ่มตัวจัดการเหตุการณ์ที่เรียกใช้ก่อนการค้นหาการค้นหา
clearNotification ลบการแจ้งเตือนออกจากตัวควบคุม
getAttribute แสดงคอลัมน์ที่ตัวควบคุมผูกไว้
getControlType แสดงชนิดของตัวควบคุม
getDefaultView แสดง ID ของมุมมองการค้นหาเริ่มต้น
getDisabled แสดงว่าตัวควบคุมถูกปิดใช้งานหรือไม่
getEntityTypes ส่งกลับชนิดตารางที่อนุญาตในการค้นหา
getLabel แสดงป้ายชื่อของตัวควบคุม
getName แสดงชื่อของตัวควบคุม
getParent แสดงส่วนที่มีตัวควบคุม
getVisible ส่งกลับว่าตัวควบคุมมองเห็นได้หรือไม่
removeOnLookupTagClick ลบตัวจัดการเหตุการณ์สําหรับการคลิกแท็กการค้นหา
removePreSearch ลบตัวจัดการเหตุการณ์ที่เรียกใช้ก่อนการค้นหาการค้นหา
setDefaultView ตั้งค่ามุมมองเริ่มต้นในกล่องโต้ตอบการค้นหา
setDisabled เปิดหรือปิดใช้งานตัวควบคุม
setEntityTypes ตั้งค่าชนิดตารางที่อนุญาตในการค้นหา
setFocus ย้ายโฟกัสไปยังตัวควบคุม
setLabel เปลี่ยนแปลงป้ายชื่อของตัวควบคุม
setNotification แสดงข้อความแสดงข้อผิดพลาดเพื่อระบุว่าข้อมูลไม่ถูกต้อง
setVisible แสดงหรือซ่อนตัวควบคุม

ตัวเลือกและชนิดการควบคุมตัวเลือก

ตัวควบคุมตัวเลือกและตัวเลือกมีชุดเดียวกันของวิธีการที่พร้อมใช้งาน

วิธีการ คำอธิบาย
addNotification แสดงข้อผิดพลาดหรือการแจ้งเตือนคําแนะนําด้วยการดําเนินการทางเลือก
addOption เพิ่มตัวเลือกลงในตัวควบคุม
clearNotification ลบการแจ้งเตือนออกจากตัวควบคุม
clearOptions ลบตัวเลือกทั้งหมดออกจากตัวควบคุม
getAttribute แสดงคอลัมน์ที่ตัวควบคุมผูกไว้
getControlType แสดงชนิดของตัวควบคุม
getDisabled แสดงว่าตัวควบคุมถูกปิดใช้งานหรือไม่
getLabel แสดงป้ายชื่อของตัวควบคุม
getName แสดงชื่อของตัวควบคุม
getOptions แสดงตัวเลือกที่พร้อมใช้งาน รวมถึงตัวเลือกว่างและไม่รวมตัวเลือกที่ถูกลบออก
getParent แสดงส่วนที่มีตัวควบคุม
getVisible ส่งกลับว่าตัวควบคุมมองเห็นได้หรือไม่
removeOption เอาตัวเลือกออกจากตัวควบคุม
setDisabled เปิดหรือปิดใช้งานตัวควบคุม
setFocus ย้ายโฟกัสไปยังตัวควบคุม
setLabel เปลี่ยนแปลงป้ายชื่อของตัวควบคุม
setNotification แสดงข้อความแสดงข้อผิดพลาดเพื่อระบุว่าข้อมูลไม่ถูกต้อง
setVisible แสดงหรือซ่อนตัวควบคุม

ชนิดตัวควบคุมฟอร์มด่วน

ดู formContext.ui.quickForms สําหรับข้อมูลเกี่ยวกับวิธีการที่สนับสนุนสําหรับตัวควบคุมชนิดนี้

ชนิดตัวควบคุมตารางย่อย

ดู ตารางและตารางย่อย สําหรับข้อมูลเกี่ยวกับวิธีการที่สนับสนุนสําหรับตัวควบคุมชนิดนี้

ประเภทการควบคุมไทม์ไลน์วอลล์

ตัวควบคุมไทม์ไลน์แสดงโพสต์ กิจกรรม และบันทึกย่อในมุมมองแบบรวมศูนย์ วิธีการเหล่านี้จะพร้อมใช้งานสําหรับชนิดตัวควบคุมนี้

วิธีการ คำอธิบาย
getControlType แสดงชนิดของตัวควบคุม
getDisabled แสดงว่าตัวควบคุมถูกปิดใช้งานหรือไม่
getLabel แสดงป้ายชื่อของตัวควบคุม
getName แสดงชื่อของตัวควบคุม
getParent แสดงส่วนที่มีตัวควบคุม
getVisible ส่งกลับว่าตัวควบคุมมองเห็นได้หรือไม่
ฟื้นฟู รีเฟรชข้อมูลที่แสดงในไทม์ไลน์
setDisabled เปิดหรือปิดใช้งานตัวควบคุม
setFocus ย้ายโฟกัสไปยังตัวควบคุม
setLabel เปลี่ยนแปลงป้ายชื่อของตัวควบคุม
setVisible แสดงหรือซ่อนตัวควบคุม

ชนิดตัวควบคุมตัวจับเวลา

วิธีการเหล่านี้จะพร้อมใช้งานสําหรับตัวควบคุมตัวจับเวลา

วิธีการ คำอธิบาย
getControlType แสดงชนิดของตัวควบคุม
getDisabled แสดงว่าตัวควบคุมถูกปิดใช้งานหรือไม่
getLabel แสดงป้ายชื่อของตัวควบคุม
getName แสดงชื่อของตัวควบคุม
getParent แสดงส่วนที่มีตัวควบคุม
getState แสดงสถานะปัจจุบันของตัวจับเวลา
getVisible ส่งกลับว่าตัวควบคุมมองเห็นได้หรือไม่
ฟื้นฟู รีเฟรชข้อมูลที่แสดงในตัวจับเวลา
setDisabled เปิดหรือปิดใช้งานตัวควบคุม
setFocus ย้ายโฟกัสไปยังตัวควบคุม
setLabel เปลี่ยนแปลงป้ายชื่อของตัวควบคุม
setVisible แสดงหรือซ่อนตัวควบคุม

ชนิดการควบคุมทรัพยากรบนเว็บ

ตัวควบคุมทรัพยากรเว็บมีชุดเดียวกันของวิธีการที่พร้อมใช้งานเป็นตัวควบคุม iframe ดูชนิดตัวควบคุม iframe

ชนิดตัวควบคุมคอมโพเนนต์ของฟอร์ม

ชนิดตัวควบคุมคอมโพเนนต์ของฟอร์มมีชุดเดียวกันของวิธีการที่พร้อมใช้งานเป็น formContext บนฟอร์มหลัก ดูลักษณะการทํางาน>ของคอมโพเนนต์ของฟอร์ม Client API

คอลัมน์