Class DocumentApp

DocumentApp

שירות המסמכים יוצר ופותח קובץ Documents שניתן לערוך.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

// Create and open a document.
doc = DocumentApp.create('Document Name');

תכונות

נכס	תיאור	התיאור
Attribute	Attribute	המספור Attribute.
ElementType	ElementType	המספור ElementType.
FontFamily	FontFamily	המספור FontFamily.
GlyphType	GlyphType	המספור GlyphType.
HorizontalAlignment	HorizontalAlignment	המספור HorizontalAlignment.
ParagraphHeading	ParagraphHeading	המספור ParagraphHeading.
PositionedLayout	PositionedLayout	המספור PositionedLayout.
TextAlignment	TextAlignment	המספור TextAlignment.
VerticalAlignment	VerticalAlignment	המספור VerticalAlignment.

שיטות

שיטה	סוג הערך שמוחזר	תיאור קצר
create(name)	Document	יצירה ומחזירה של מסמך חדש.
getActiveDocument()	Document	מחזירה את המסמך שאליו הסקריפט מקושר לקונטיינר.
getUi()	Ui	מחזירה מכונה של סביבת ממשק המשתמש של המסמך שמאפשרת לסקריפט להוסיף תכונות כמו תפריטים, תיבות דו-שיח וסרגלי צד.
openById(id)	Document	מחזירה את המסמך עם המזהה שצוין.
openByUrl(url)	Document	פתיחה והחזרת המסמך עם כתובת ה-URL שצוינה.

תיעוד מפורט

create(name)

יצירה ומחזירה של מסמך חדש.

// Create and open a new document.
var doc = DocumentApp.create('Document Name');

פרמטרים

שם	תיאור	התיאור
name	String	שם המסמך החדש

החזרות

Document – מופע המסמך החדש

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

• https://www.googleapis.com/auth/documents

---

getActiveDocument()

מחזירה את המסמך שאליו הסקריפט מקושר לקונטיינר. כדי לבצע אינטראקציה עם מסמך שהסקריפט לא מקושר אליו לקונטיינר, צריך להשתמש במקום זאת ב-openById(id) או ב-openByUrl(url).

// Get the document to which this script is bound.
var doc = DocumentApp.getActiveDocument();

החזרות

Document – מופע המסמך

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

• https://www.googleapis.com/auth/documents.currentonly
• https://www.googleapis.com/auth/documents

---

getUi()

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

// Add a custom menu to the active document, including a separator and a sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(DocumentApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

החזרות

Ui – מופע של סביבת ממשק המשתמש של המסמך הזה

---

openById(id)

מחזירה את המסמך עם המזהה שצוין. אם הסקריפט מקושר לקונטיינר למסמך, צריך להשתמש במקום זאת ב-getActiveDocument().

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

פרמטרים

שם	תיאור	התיאור
id	String	המזהה של המסמך שצריך לפתוח

החזרות

Document – מופע המסמך

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

• https://www.googleapis.com/auth/documents

---

openByUrl(url)

פתיחה והחזרת המסמך עם כתובת ה-URL שצוינה. אם הסקריפט מקושר לקונטיינר למסמך, משתמשים במקום זאת ב-getActiveDocument().

// Open a document by URL.
var doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit');

פרמטרים

שם	תיאור	התיאור
url	String	כתובת ה-URL של המסמך שצריך לפתוח

החזרות

Document – מופע המסמך

הרשאות

לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:

• https://www.googleapis.com/auth/documents