דף זה תורגם על ידי Cloud Translation API.

Class DocumentApp

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

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
let doc = DocumentApp.openById('DOCUMENT_ID');

// 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`.

Methods

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

מסמכים מפורטים

`create(name)`

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

// Create and open a new document.
const 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.
const 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.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('DOCUMENT_ID');

פרמטרים

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

חזרה

Document – מופע המסמך.

אישור

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

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

`openByUrl(url)`

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

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

פרמטרים

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

חזרה

Document – מופע המסמך

אישור

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

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