อินสแตนซ์ของสภาพแวดล้อมอินเทอร์เฟซผู้ใช้สำหรับแอป Google ที่อนุญาตให้สคริปต์สามารถเพิ่มฟีเจอร์ต่างๆ เช่น เมนู กล่องโต้ตอบ และแถบด้านข้าง สคริปต์จะโต้ตอบกับ UI ได้เฉพาะสำหรับอินสแตนซ์ปัจจุบันของตัวแก้ไขแบบเปิดเท่านั้น และสคริปต์จะผูกกับคอนเทนเนอร์กับตัวแก้ไขได้เท่านั้น
// Display a dialog box with a title, message, input field, and "Yes" and "No" buttons. The // user can also close the dialog by clicking the close button in its title bar. var ui = SpreadsheetApp.getUi(); var response = ui.prompt('Getting to know you', 'May I know your name?', ui.ButtonSet.YES_NO); // Process the user's response. if (response.getSelectedButton() == ui.Button.YES) { Logger.log('The user\'s name is %s.', response.getResponseText()); } else if (response.getSelectedButton() == ui.Button.NO) { Logger.log('The user didn\'t want to provide a name.'); } else { Logger.log('The user clicked the close button in the dialog\'s title bar.'); }
พร็อพเพอร์ตี้
พร็อพเพอร์ตี้ | Type | คำอธิบาย |
---|---|---|
Button | Button | enum ที่แสดงถึงปุ่มตัวเลือกของกล่องโต้ตอบที่กำหนดไว้ล่วงหน้าซึ่งแสดงผลโดยการแจ้งเตือนหรือ PromptResponse.getSelectedButton() เพื่อระบุว่าปุ่มใดในกล่องโต้ตอบที่ผู้ใช้คลิก |
ButtonSet | ButtonSet | enum ที่แสดงชุดปุ่มกล่องโต้ตอบที่กำหนดไว้ล่วงหน้าอย่างน้อย 1 ปุ่ม ซึ่งสามารถเพิ่มในการแจ้งเตือนหรือข้อความแจ้งได้ |
วิธีการ
วิธีการ | ประเภทการแสดงผล | รายละเอียดแบบย่อ |
---|---|---|
alert(prompt) | Button | เปิดกล่องโต้ตอบในเครื่องมือแก้ไขของผู้ใช้พร้อมข้อความที่ระบุและปุ่ม "ตกลง" |
alert(prompt, buttons) | Button | เปิดกล่องโต้ตอบในเครื่องมือแก้ไขของผู้ใช้ที่มีข้อความที่ระบุและชุดปุ่ม |
alert(title, prompt, buttons) | Button | เปิดกล่องโต้ตอบในเครื่องมือแก้ไขของผู้ใช้ที่มีชื่อ ข้อความ และชุดปุ่มที่ระบุ |
createAddonMenu() | Menu | สร้างเครื่องมือสร้างที่สามารถใช้เพื่อแทรกเมนูย่อยลงในเมนูส่วนขยายของตัวแก้ไข |
createMenu(caption) | Menu | สร้างเครื่องมือสร้างที่ใช้เพื่อเพิ่มเมนูลงในอินเทอร์เฟซผู้ใช้ของตัวแก้ไขได้ |
prompt(prompt) | PromptResponse | เปิดกล่องโต้ตอบอินพุตในเครื่องมือแก้ไขของผู้ใช้ที่มีข้อความที่ระบุและปุ่ม "ตกลง" |
prompt(prompt, buttons) | PromptResponse | เปิดกล่องโต้ตอบการป้อนข้อมูลในเครื่องมือแก้ไขของผู้ใช้ที่มีข้อความที่ระบุและชุดปุ่ม |
prompt(title, prompt, buttons) | PromptResponse | เปิดกล่องโต้ตอบการป้อนข้อมูลในเครื่องมือแก้ไขของผู้ใช้พร้อมด้วยชื่อ ข้อความ และชุดปุ่มที่ระบุ |
showModalDialog(userInterface, title) | void | เปิดกล่องโต้ตอบโมดัลในเครื่องมือแก้ไขของผู้ใช้ที่มีเนื้อหาฝั่งไคลเอ็นต์ที่กำหนดเอง |
showModelessDialog(userInterface, title) | void | เปิดกล่องโต้ตอบแบบไม่มีโหมดในเครื่องมือแก้ไขของผู้ใช้ที่มีเนื้อหาฝั่งไคลเอ็นต์ที่กำหนดเอง |
showSidebar(userInterface) | void | เปิดแถบด้านข้างในเครื่องมือแก้ไขของผู้ใช้พร้อมเนื้อหาฝั่งไคลเอ็นต์ที่กําหนดเอง |
เอกสารประกอบโดยละเอียด
alert(prompt)
เปิดกล่องโต้ตอบในเครื่องมือแก้ไขของผู้ใช้พร้อมข้อความที่ระบุและปุ่ม "ตกลง" วิธีนี้จะระงับสคริปต์ฝั่งเซิร์ฟเวอร์ขณะที่กล่องโต้ตอบเปิดอยู่ สคริปต์จะกลับมาทำงานอีกครั้งหลังจากที่ผู้ใช้ปิดกล่องโต้ตอบ แต่การเชื่อมต่อ Jdbc
และการล็อก LockService
จะไม่คงอยู่ตลอดการระงับ โปรดดูข้อมูลเพิ่มเติมที่คำแนะนำเกี่ยวกับกล่องโต้ตอบและแถบด้านข้าง
// Display "Hello, world" in a dialog box with an "OK" button. The user can also close the // dialog by clicking the close button in its title bar. SpreadsheetApp.getUi().alert('Hello, world');
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
prompt | String | ข้อความที่จะแสดงในกล่องโต้ตอบ |
รีเทิร์น
Button
— ปุ่มที่ผู้ใช้คลิก
alert(prompt, buttons)
เปิดกล่องโต้ตอบในเครื่องมือแก้ไขของผู้ใช้ที่มีข้อความที่ระบุและชุดปุ่ม วิธีนี้จะระงับสคริปต์ฝั่งเซิร์ฟเวอร์ขณะที่กล่องโต้ตอบเปิดอยู่ สคริปต์จะกลับมาทำงานอีกครั้งหลังจากที่ผู้ใช้ปิดกล่องโต้ตอบ แต่การเชื่อมต่อ Jdbc
และการล็อก LockService
จะไม่คงอยู่ตลอดการระงับ โปรดดูข้อมูลเพิ่มเติมที่คำแนะนำเกี่ยวกับกล่องโต้ตอบและแถบด้านข้าง
// Display a dialog box with a message and "Yes" and "No" buttons. The user can also close the // dialog by clicking the close button in its title bar. var ui = SpreadsheetApp.getUi(); var response = ui.alert('Are you sure you want to continue?', ui.ButtonSet.YES_NO); // Process the user's response. if (response == ui.Button.YES) { Logger.log('The user clicked "Yes."'); } else { Logger.log('The user clicked "No" or the close button in the dialog\'s title bar.'); }
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
prompt | String | ข้อความที่จะแสดงในกล่องโต้ตอบ |
buttons | ButtonSet | ปุ่มที่กำหนดให้แสดงในกล่องโต้ตอบ |
รีเทิร์น
Button
— ปุ่มที่ผู้ใช้คลิก
alert(title, prompt, buttons)
เปิดกล่องโต้ตอบในเครื่องมือแก้ไขของผู้ใช้ที่มีชื่อ ข้อความ และชุดปุ่มที่ระบุ เมธอดนี้จะระงับสคริปต์ฝั่งเซิร์ฟเวอร์ขณะที่กล่องโต้ตอบเปิดอยู่ สคริปต์จะกลับมาทำงานอีกครั้งหลังจากที่ผู้ใช้ปิดกล่องโต้ตอบ แต่การเชื่อมต่อ Jdbc
และการล็อก LockService
จะไม่คงอยู่ตลอดการระงับ โปรดดูข้อมูลเพิ่มเติมที่คำแนะนำเกี่ยวกับกล่องโต้ตอบและแถบด้านข้าง
// Display a dialog box with a title, message, and "Yes" and "No" buttons. The user can also // close the dialog by clicking the close button in its title bar. var ui = SpreadsheetApp.getUi(); var response = ui.alert('Confirm', 'Are you sure you want to continue?', ui.ButtonSet.YES_NO); // Process the user's response. if (response == ui.Button.YES) { Logger.log('The user clicked "Yes."'); } else { Logger.log('The user clicked "No" or the close button in the dialog\'s title bar.'); }
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
title | String | ชื่อที่จะแสดงเหนือกล่องโต้ตอบ |
prompt | String | ข้อความที่จะแสดงในกล่องโต้ตอบ |
buttons | ButtonSet | ปุ่มที่กำหนดให้แสดงในกล่องโต้ตอบ |
รีเทิร์น
Button
— ปุ่มที่ผู้ใช้คลิก
createAddonMenu()
สร้างเครื่องมือสร้างที่สามารถใช้เพื่อแทรกเมนูย่อยลงในเมนูส่วนขยายของตัวแก้ไข เมนูจะไม่อัปเดตจริงๆ จนกว่าจะมีการเรียก Menu.addToUi()
หากสคริปต์ทำงานเป็นส่วนเสริม ชื่อเมนูย่อยจะตรงกับชื่อของส่วนเสริมในเว็บสโตร์ หากสคริปต์เชื่อมโยงกับเอกสารโดยตรง ชื่อเมนูย่อยจะตรงกับชื่อสคริปต์ ดูข้อมูลเพิ่มเติมได้ที่คำแนะนำเกี่ยวกับเมนู
// Add an item to the Add-on menu, under a sub-menu whose name is set automatically. function onOpen(e) { SpreadsheetApp.getUi() .createAddonMenu() .addItem('Show', 'showSidebar') .addToUi(); }
รีเทิร์น
Menu
— เครื่องมือสร้างเมนูแบบใหม่
createMenu(caption)
สร้างเครื่องมือสร้างที่ใช้เพื่อเพิ่มเมนูลงในอินเทอร์เฟซผู้ใช้ของตัวแก้ไขได้ ระบบจะไม่เพิ่มเมนูจริงๆ จนกว่าจะมีการเรียก Menu.addToUi()
ดูข้อมูลเพิ่มเติมได้ที่คำแนะนำเกี่ยวกับเมนู ป้ายกำกับสำหรับเมนูระดับบนสุดควรอยู่ในตัวพิมพ์ของบรรทัดแรก (คำหลักทั้งหมดที่เป็นตัวพิมพ์ใหญ่) แม้ว่าป้ายกำกับสำหรับเมนูย่อยควรอยู่ในตัวพิมพ์ของประโยค (เฉพาะคำแรกที่เป็นตัวพิมพ์ใหญ่) หากเผยแพร่สคริปต์เป็นส่วนเสริม ระบบจะไม่สนใจพารามิเตอร์ caption
และจะเพิ่มเมนูเป็นเมนูย่อยของเมนูส่วนขยาย ซึ่งเทียบเท่ากับ createAddonMenu()
// Add a custom menu to the active document, including a separator and a sub-menu. function onOpen(e) { SpreadsheetApp.getUi() .createMenu('My Menu') .addItem('My menu item', 'myFunction') .addSeparator() .addSubMenu(SpreadsheetApp.getUi().createMenu('My sub-menu') .addItem('One sub-menu item', 'mySecondFunction') .addItem('Another sub-menu item', 'myThirdFunction')) .addToUi(); }
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
caption | String | ป้ายกำกับสำหรับเมนูที่มีคำสำคัญทั้งหมดเป็นตัวพิมพ์ใหญ่สำหรับเมนูระดับบนสุด หรือเฉพาะคำแรกที่เป็นตัวพิมพ์ใหญ่สำหรับเมนูย่อย |
รีเทิร์น
Menu
— เครื่องมือสร้างเมนูแบบใหม่
prompt(prompt)
เปิดกล่องโต้ตอบอินพุตในเครื่องมือแก้ไขของผู้ใช้ที่มีข้อความที่ระบุและปุ่ม "ตกลง" เมธอดนี้จะระงับสคริปต์ฝั่งเซิร์ฟเวอร์ขณะที่กล่องโต้ตอบเปิดอยู่ สคริปต์จะกลับมาทำงานอีกครั้งหลังจากที่ผู้ใช้ปิดกล่องโต้ตอบ แต่การเชื่อมต่อ Jdbc
และการล็อก LockService
จะไม่คงอยู่ตลอดการระงับ โปรดดูข้อมูลเพิ่มเติมที่คำแนะนำเกี่ยวกับกล่องโต้ตอบและแถบด้านข้าง
// Display a dialog box with a message, input field, and an "OK" button. The user can also // close the dialog by clicking the close button in its title bar. var ui = SpreadsheetApp.getUi(); var response = ui.prompt('Enter your name:'); // Process the user's response. if (response.getSelectedButton() == ui.Button.OK) { Logger.log('The user\'s name is %s.', response.getResponseText()); } else { Logger.log('The user clicked the close button in the dialog\'s title bar.'); }
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
prompt | String | ข้อความที่จะแสดงในกล่องโต้ตอบ |
รีเทิร์น
PromptResponse
— การนำเสนอคำตอบของผู้ใช้
prompt(prompt, buttons)
เปิดกล่องโต้ตอบการป้อนข้อมูลในเครื่องมือแก้ไขของผู้ใช้ที่มีข้อความที่ระบุและชุดปุ่ม เมธอดนี้จะระงับสคริปต์ฝั่งเซิร์ฟเวอร์ขณะที่กล่องโต้ตอบเปิดอยู่ สคริปต์จะกลับมาทำงานอีกครั้งหลังจากที่ผู้ใช้ปิดกล่องโต้ตอบ แต่การเชื่อมต่อ Jdbc
และการล็อก LockService
จะไม่คงอยู่ตลอดการระงับ โปรดดูข้อมูลเพิ่มเติมที่คำแนะนำเกี่ยวกับกล่องโต้ตอบและแถบด้านข้าง
// Display a dialog box with a message, input field, and "Yes" and "No" buttons. The user can // also close the dialog by clicking the close button in its title bar. var ui = SpreadsheetApp.getUi(); var response = ui.prompt('May I know your name?', ui.ButtonSet.YES_NO); // Process the user's response. if (response.getSelectedButton() == ui.Button.YES) { Logger.log('The user\'s name is %s.', response.getResponseText()); } else if (response.getSelectedButton() == ui.Button.NO) { Logger.log('The user didn\'t want to provide a name.'); } else { Logger.log('The user clicked the close button in the dialog\'s title bar.'); }
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
prompt | String | ข้อความที่จะแสดงในกล่องโต้ตอบ |
buttons | ButtonSet | ปุ่มที่กำหนดให้แสดงในกล่องโต้ตอบ |
รีเทิร์น
PromptResponse
— การนำเสนอคำตอบของผู้ใช้
prompt(title, prompt, buttons)
เปิดกล่องโต้ตอบการป้อนข้อมูลในเครื่องมือแก้ไขของผู้ใช้พร้อมด้วยชื่อ ข้อความ และชุดปุ่มที่ระบุ เมธอดนี้จะระงับสคริปต์ฝั่งเซิร์ฟเวอร์ขณะที่กล่องโต้ตอบเปิดอยู่ สคริปต์จะทำงานต่อหลังจากผู้ใช้ปิดกล่องโต้ตอบ แต่การเชื่อมต่อ Jdbc
และการล็อก LockService
จะไม่คงอยู่ในการระงับ ดูข้อมูลเพิ่มเติมได้ในคำแนะนำเกี่ยวกับกล่องโต้ตอบและแถบด้านข้าง
// Display a dialog box with a title, message, input field, and "Yes" and "No" buttons. The // user can also close the dialog by clicking the close button in its title bar. var ui = SpreadsheetApp.getUi(); var response = ui.prompt('Getting to know you', 'May I know your name?', ui.ButtonSet.YES_NO); // Process the user's response. if (response.getSelectedButton() == ui.Button.YES) { Logger.log('The user\'s name is %s.', response.getResponseText()); } else if (response.getSelectedButton() == ui.Button.NO) { Logger.log('The user didn\'t want to provide a name.'); } else { Logger.log('The user clicked the close button in the dialog\'s title bar.'); }
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
title | String | ชื่อที่จะแสดงเหนือกล่องโต้ตอบ |
prompt | String | ข้อความที่จะแสดงในกล่องโต้ตอบ |
buttons | ButtonSet | ปุ่มที่กำหนดให้แสดงในกล่องโต้ตอบ |
รีเทิร์น
PromptResponse
— การนำเสนอคำตอบของผู้ใช้
showModalDialog(userInterface, title)
เปิดกล่องโต้ตอบโมดัลในเครื่องมือแก้ไขของผู้ใช้ที่มีเนื้อหาฝั่งไคลเอ็นต์ที่กำหนดเอง วิธีนี้จะไม่ระงับสคริปต์ฝั่งเซิร์ฟเวอร์ขณะที่กล่องโต้ตอบเปิดอยู่ หากต้องการสื่อสารกับสคริปต์ฝั่งเซิร์ฟเวอร์ คอมโพเนนต์ฝั่งไคลเอ็นต์จะต้องสร้างการเรียกกลับแบบไม่พร้อมกันโดยใช้ google.script
API สำหรับ HtmlService
หากต้องการปิดกล่องโต้ตอบแบบเป็นโปรแกรม ให้เรียกใช้
google.script.host.close()
ในฝั่งไคลเอ็นต์ของเว็บแอป HtmlService
ดูข้อมูลเพิ่มเติมได้ที่คำแนะนำเกี่ยวกับกล่องโต้ตอบและแถบด้านข้าง
กล่องโต้ตอบโมดัลป้องกันไม่ให้ผู้ใช้โต้ตอบกับสิ่งอื่นที่ไม่ใช่กล่องโต้ตอบ ในทางตรงกันข้าม กล่องโต้ตอบแบบไม่มีโหมดและแถบด้านข้างช่วยให้ผู้ใช้โต้ตอบกับเอดิเตอร์ได้ ในเกือบทุกกรณี กล่องโต้ตอบโมดัลหรือแถบด้านข้างเป็นตัวเลือกที่ดีกว่ากล่องโต้ตอบแบบไร้โหมด
// Display a modal dialog box with custom HtmlService content. var htmlOutput = HtmlService .createHtmlOutput('<p>A change of speed, a change of style...</p>') .setWidth(250) .setHeight(300); SpreadsheetApp.getUi().showModalDialog(htmlOutput, 'My add-on');
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
userInterface | Object | HtmlOutput ที่แสดงถึงอินเทอร์เฟซที่จะแสดง |
title | String | ชื่อของกล่องโต้ตอบ ลบล้างชื่อที่ตั้งไว้ด้วยการเรียกใช้ setTitle() ในออบเจ็กต์ userInterface |
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/script.container.ui
showModelessDialog(userInterface, title)
เปิดกล่องโต้ตอบแบบไม่มีโหมดในเครื่องมือแก้ไขของผู้ใช้ที่มีเนื้อหาฝั่งไคลเอ็นต์ที่กำหนดเอง วิธีนี้จะไม่ระงับสคริปต์ฝั่งเซิร์ฟเวอร์ขณะที่กล่องโต้ตอบเปิดอยู่ หากต้องการสื่อสารกับสคริปต์ฝั่งเซิร์ฟเวอร์ คอมโพเนนต์ฝั่งไคลเอ็นต์จะต้องสร้างการเรียกกลับแบบไม่พร้อมกันโดยใช้ google.script
API สำหรับ HtmlService
หากต้องการปิดกล่องโต้ตอบแบบเป็นโปรแกรม ให้เรียกใช้
google.script.host.close()
ในฝั่งไคลเอ็นต์ของเว็บแอป HtmlService
ดูข้อมูลเพิ่มเติมได้ที่คำแนะนำเกี่ยวกับกล่องโต้ตอบและแถบด้านข้าง
กล่องโต้ตอบแบบไร้โหมดช่วยให้ผู้ใช้สามารถโต้ตอบกับตัวแก้ไขที่อยู่หลังกล่องโต้ตอบได้ แต่กล่องโต้ตอบโมดัลจะไม่ทำเช่นนั้น ในเกือบทุกกรณี กล่องโต้ตอบโมดัลหรือแถบด้านข้างจะเป็นทางเลือกที่ดีกว่ากล่องโต้ตอบแบบไร้โหมด
// Display a modeless dialog box with custom HtmlService content. var htmlOutput = HtmlService .createHtmlOutput('<p>A change of speed, a change of style...</p>') .setWidth(250) .setHeight(300); SpreadsheetApp.getUi().showModelessDialog(htmlOutput, 'My add-on');
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
userInterface | Object | HtmlOutput ที่แสดงถึงอินเทอร์เฟซที่จะแสดง |
title | String | ชื่อของกล่องโต้ตอบ ลบล้างชื่อที่ตั้งไว้ด้วยการเรียกใช้ setTitle() ในออบเจ็กต์ userInterface |
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/script.container.ui
showSidebar(userInterface)
เปิดแถบด้านข้างในเครื่องมือแก้ไขของผู้ใช้พร้อมเนื้อหาฝั่งไคลเอ็นต์ที่กําหนดเอง วิธีนี้จะไม่ระงับสคริปต์ฝั่งเซิร์ฟเวอร์ขณะที่แถบด้านข้างเปิดอยู่ หากต้องการสื่อสารกับสคริปต์ฝั่งเซิร์ฟเวอร์ คอมโพเนนต์ฝั่งไคลเอ็นต์จะต้องสร้างการเรียกกลับแบบไม่พร้อมกันโดยใช้ google.script
API สำหรับ HtmlService
หากต้องการปิดแถบด้านข้างโดยใช้โปรแกรม ให้เรียกใช้
google.script.host.close()
ในฝั่งไคลเอ็นต์ของเว็บแอป HtmlService
ดูข้อมูลเพิ่มเติมได้ที่คำแนะนำเกี่ยวกับกล่องโต้ตอบและแถบด้านข้าง
แถบด้านข้างจะแสดงทางด้านขวาของเครื่องมือแก้ไขสำหรับผู้ใช้ในสภาพแวดล้อมที่ใช้ภาษาจากซ้ายไปขวา และทางด้านซ้ายของเครื่องมือแก้ไขสำหรับภาษาที่อ่านจากขวาไปซ้าย แถบด้านข้างทั้งหมดที่แสดงโดยสคริปต์จะมีความกว้าง 300 พิกเซล
// Display a sidebar with custom HtmlService content. var htmlOutput = HtmlService .createHtmlOutput('<p>A change of speed, a change of style...</p>') .setTitle('My add-on'); SpreadsheetApp.getUi().showSidebar(htmlOutput);
พารามิเตอร์
ชื่อ | Type | คำอธิบาย |
---|---|---|
userInterface | Object | HtmlOutput ที่แสดงถึงอินเทอร์เฟซที่จะแสดง |
การให้สิทธิ์
สคริปต์ที่ใช้วิธีการนี้ต้องได้รับสิทธิ์จากขอบเขตต่อไปนี้อย่างน้อย 1 รายการ
-
https://www.googleapis.com/auth/script.container.ui