תיבות דו-שיח וסרגלי צד בתוסף העריכה

לרוב תוסף העריכה, חלונות של תיבת דו-שיח וחלוניות של סרגל הצד הם ממשקי המשתמש הראשיים לתוספים. אפשר להתאים אישית את שניהם באופן מלא באמצעות HTML ו-CSS רגילים, ואפשר להשתמש מודל תקשורת שרת-לקוח כדי להריץ פונקציות של Apps Script כשהמשתמש מקיים אינטראקציה עם סרגל הצד או עם תיבת הדו-שיח. לתוסף שלך אפשר להגדיר כמה סרגלי צד ותיבות דו-שיח, אבל הוא יכול להציג רק מילה אחת בכל פעם.

כשרוצים למנוע מהמשתמש ליצור אינטראקציה עם העורך עד לבחור אפשרות בממשק של התוסף, להשתמש בתיבת דו-שיח. אחרת, יש להשתמש סרגל הצד.

תיבות דו-שיח

תיבות דו-שיח הן חלוניות בחלון שמכסות את התוכן של העורך הראשי. סקריפט של Apps תיבות דו-שיח הן חלון עזר, בזמן שהן פתוחות, המשתמש לא יכול לבצע פעולות רכיבים אחרים של ממשק העריכה. אפשר להתאים אישית את התוכן והגודל של תיבות דו-שיח.

יוצרים תיבות דו-שיח של תוספים בדיוק כמו ב-Apps Script תיבות דו-שיח בהתאמה אישית; הכללי יש לבצע את הפעולות הבאות:

  1. יוצרים קובץ פרויקט סקריפט שמגדיר את מבנה ה-HTML של תיבת הדו-שיח. CSS והתנהגות JavaScript בצד הלקוח. כשמגדירים את תיבת הדו-שיח, מעיינים להנחיות הסגנון לתוספי עריכה.
  2. בקוד בצד השרת שבו רוצים לפתוח את תיבת הדו-שיח, מבצעים קריאה HtmlService.createHtmlOutputFromFile(filename) כדי ליצור HtmlOutput שמייצג את תיבת הדו-שיח. לחלופין, אם משתמשים HTML מותאם שאליו אפשר לקרוא HtmlService.createTemplateFromFile(filename) כדי ליצור תבנית, HtmlTemplate.evaluate() כדי להמיר אותו אובייקט HtmlOutput.
  3. התקשרות אל Ui.showModalDialog(htmlOutput, dialogTitle) כדי להציג את תיבת הדו-שיח באמצעות HtmlOutput

תיבות דו-שיח לא משעה את הסקריפט בצד השרת בזמן שהן פתוחות. JavaScript בצד הלקוח יכול לבצע קריאות אסינכרוניות בצד השרת באמצעות google.script.run() של פונקציות ה-handler שמשויכות אליו. פרטים נוספים זמינים במאמר תקשורת בין לקוח לשרת.

תיבות דו-שיח לפתיחת קבצים

תיבות דו-שיח לפתיחת קובץ הן תיבות דו-שיח שנוצרו מראש שמאפשרות למשתמשים לבחור קבצים מ-Google Drive. אפשר להוסיף לתוסף תיבת דו-שיח לפתיחת קבצים בלי שצריך לעצב, אבל צריך הגדרות נוספות. בנוסף, הם צריכים גישה פרויקט ב-Cloud Platform כדי להפעיל את Google Picker API.

פרטים מלאים מופיעים במאמר תיבות דו-שיח לפתיחת קבצים.

סרגלי צד הם לוחות שמופיעים בצד שמאל של ממשק העריכה. הסוג הנפוץ ביותר של ממשקי תוספים. בניגוד לתיבות דו-שיח, אפשר להמשיך לקיים אינטראקציה עם הרכיבים האחרים של ממשק העורך, בזמן שסרגל הצד פתיחה. לסרגלי הצד יש רוחב קבוע, אבל ניתן להתאים אישית את התוכן שלהם.

יוצרים סרגלי צד של תוספים כמו ב-Apps Script סרגלי צד בהתאמה אישית; הכללי יש לבצע את הפעולות הבאות:

  1. ליצור קובץ פרויקט סקריפט שמגדיר את מבנה ה-HTML של סרגל הצד: CSS והתנהגות JavaScript בצד הלקוח. כשמגדירים את סרגל הצד, מעיינים להנחיות הסגנון לתוספי עריכה.

  2. בקוד בצד השרת שבו רוצים לפתוח את סרגל הצד, מבצעים קריאה HtmlService.createHtmlOutputFromFile(filename) כדי ליצור HtmlOutput שמייצג את סרגל הצד. לחלופין, אם משתמשים HTML מותאם שאליו אפשר לקרוא HtmlService.createTemplateFromFile(filename) כדי ליצור תבנית, HtmlTemplate.evaluate() כדי להמיר אותו אובייקט HtmlOutput.

  3. התקשרות אל Ui.showSidebar(htmlOutput) להציג את סרגל הצד באמצעות HtmlOutput

סרגלי צד לא משעים את הסקריפט של צד השרת כשהוא פתוח. JavaScript בצד הלקוח יכול לבצע קריאות אסינכרוניות בצד השרת באמצעות google.script.run() של פונקציות ה-handler שמשויכות אליו. פרטים נוספים זמינים במאמר תקשורת בין לקוח לשרת.