對大部分的編輯器外掛程式而言,對話方塊視窗和側欄面板是主要的外掛程式使用者介面。兩者都可以使用標準 HTML 和 CSS 完全自訂,您也可以使用 Apps Script 的用戶端伺服器通訊模型,在使用者與側欄或對話方塊互動時執行 Apps Script 函式。外掛程式可以定義多個側欄和對話方塊,但外掛程式一次只能顯示一個側欄。
如果您想禁止使用者與編輯器互動,直到在外掛程式介面中做出選擇,請使用對話方塊;否則請使用側欄。
對話方塊
對話方塊是重疊在主要編輯器內容的視窗面板。Apps Script 對話方塊是強制回應;當應用程式開啟時,使用者就無法與編輯器介面的其他元素互動。您可以自訂對話方塊的內容和大小。
建構外掛程式對話方塊的方式與 Apps Script 自訂對話方塊相同,一般的建議程序如下:
- 建立指令碼專案檔案,以定義對話方塊的 HTML 結構、CSS 和用戶端 JavaScript 行為。定義對話方塊時,請參閱編輯器外掛程式樣式指南。
- 在您想開啟對話方塊的伺服器端程式碼中,呼叫
HtmlService.createHtmlOutputFromFile(filename)
以建立代表對話方塊的HtmlOutput
物件。或者,如果您使用的是範本 HTML,可以呼叫HtmlService.createTemplateFromFile(filename)
來產生範本,然後用HtmlTemplate.evaluate()
將範本轉換為HtmlOutput
物件。 - 呼叫
Ui.showModalDialog(htmlOutput, dialogTitle)
即可使用HtmlOutput
顯示對話方塊。
對話方塊不會在開啟時暫停伺服器端指令碼。用戶端 JavaScript 可以使用 google.script.run()
和相關處理常式函式,對伺服器端進行非同步呼叫。詳情請參閱「用戶端對伺服器通訊」。
檔案開啟對話方塊
檔案開啟對話方塊是預先建立的對話方塊,可讓使用者從 Google 雲端硬碟中選取檔案。您可以在外掛程式中新增一個開啟檔案的對話方塊,而不必設計,但需要進行一些額外設定。您也必須存取外掛程式的 Cloud Platform 專案,才能啟用 Google Picker API。
詳情請參閱「檔案開啟對話方塊」。
Sidebars
側欄是顯示在編輯器介面右側的面板,是最常見的外掛程式介面類型。與對話方塊不同,您可以在側欄開啟時繼續與編輯器介面的其他元素互動。側欄的寬度固定,但您可以自訂側欄內容。
建構外掛程式側欄的方式與 Apps Script 自訂側欄相同,一般建議程序如下:
- 建立指令碼專案檔案,以定義側欄的 HTML 結構、CSS 和用戶端 JavaScript 行為。定義側欄時,請參閱編輯器外掛程式樣式指南。
在要開啟側欄的伺服器端程式碼中,呼叫
HtmlService.createHtmlOutputFromFile(filename)
以建立代表側欄的HtmlOutput
物件。或者,如果您使用的是範本 HTML,可以呼叫HtmlService.createTemplateFromFile(filename)
來產生範本,然後用HtmlTemplate.evaluate()
將範本轉換為HtmlOutput
物件。呼叫
Ui.showSidebar(htmlOutput)
即可使用HtmlOutput
顯示側欄。
啟用伺服器端指令碼時,側欄不會暫停。用戶端 JavaScript 可以使用 google.script.run()
和相關處理常式函式,對伺服器端進行非同步呼叫。詳情請參閱「用戶端對伺服器通訊」。