התוכן של כרטיסייה במסמך ב-Google Docs. ה-Body יכול להכיל את הרכיבים List, Paragraph, Table ו-Table. מידע נוסף על מבנה המסמך זמין במדריך להרחבת Google Docs.
בדרך כלל, הרכיב Body מכיל את כל התוכן של הכרטיסייה, מלבד הרכיבים Header, Footer ורכיבי Footnote.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a paragraph and a page break to the tab's body section directly. body.appendParagraph('A paragraph.'); body.appendPageBreak();
Methods
| שיטה | סוג הערך המוחזר | תיאור קצר | 
|---|---|---|
| append | Horizontal | יצירת Horizontalחדש והוספתו. | 
| append | Inline | יצירת Inlineחדש והוספתו לקובץ ה-blob של התמונה שצוין. | 
| append | Inline | הוספה של Inlineהנתון. | 
| append | List | הוספה של Listהנתון. | 
| append | List | יצירת Listחדש שמצורף אליו תוכן הטקסט שצוין. | 
| append | Page | יצירת Pageחדש והוספתו. | 
| append | Page | הוספה של Pageהנתון. | 
| append | Paragraph | הוספה של Paragraphהנתון. | 
| append | Paragraph | יצירת Paragraphחדש שמצורף אליו תוכן הטקסט שצוין. | 
| append | Table | יצירת Tableחדש והוספתו. | 
| append | Table | הפונקציה מוסיפה Tableחדש שמכילTableלכל ערך מחרוזת שצוין. | 
| append | Table | הוספה של Tableהנתון. | 
| clear() | Body | ניקוי התוכן של הרכיב. | 
| copy() | Body | הפונקציה מחזירה עותק מנותק ומעמיק של הרכיב הנוכחי. | 
| edit | Text | הצגת גרסת Textשל הרכיב הנוכחי לצורך עריכה. | 
| find | Range | חיפוש בתוכן של הרכיב אחר צאצא מהסוג שצוין. | 
| find | Range | הפונקציה מחפשת בתוכן של הרכיב צאצא מהסוג שצוין, החל מ- Rangeשצוין. | 
| find | Range | חיפוש דפוס הטקסט שצוין בתוכן של האלמנט באמצעות ביטויים רגולריים. | 
| find | Range | חיפוש של דפוס הטקסט שצוין בתוכן הרכיב, החל מתוצאת חיפוש נתונה. | 
| get | Object | אחזור המאפיינים של האלמנט. | 
| get | Element | אחזור רכיב הצאצא לפי אינדקס הצאצא שצוין. | 
| get | Integer | אחזור של מדד הצאצא של רכיב הצאצא שצוין. | 
| get | Object | אחזור קבוצת המאפיינים של Paragraphשצוין. | 
| get | Inline | אחזור של כל ה- Inlineשמכיל הקטע. | 
| get | List | אחזור של כל ה- Listשמכיל הקטע. | 
| get | Number | אחזור השוליים התחתונים, בנקודות. | 
| get | Number | הפונקציה מאחזרת את השוליים השמאליים, בנקודות. | 
| get | Number | אחזור השוליים הימני. | 
| get | Number | אחזור השוליים העליונים. | 
| get | Integer | אחזור מספר הילדים. | 
| get | Number | אחזור גובה הדף, בנקודות. | 
| get | Number | אחזור רוחב הדף, בנקודות. | 
| get | Paragraph[] | אחזור כל ה- Paragraphsשמכיל הקטע (כוללList). | 
| get | Container | אחזור של רכיב ההורה של האלמנט. | 
| get | Table[] | אחזור של כל ה- Tablesשמכיל הקטע. | 
| get | String | אחזור התוכן של הרכיב כמחרוזת טקסט. | 
| get | Text | הפונקציה מקבלת את יישור הטקסט. | 
| get | Element | אחזור הערך של Elementברכיב. | 
| insert | Horizontal | יצירת Horizontalחדשה והוספתה למיקום המסומן. | 
| insert | Inline | יצירת Inlineוהוספתו מ-blob התמונה שצוין, במדד שצוין. | 
| insert | Inline | הוספת Inlineהנתון באינדקס שצוין. | 
| insert | List | הוספת Listהנתון באינדקס שצוין. | 
| insert | List | יצירת Listחדש והוספה שלו לאינדקס שצוין, עם תוכן הטקסט שצוין. | 
| insert | Page | יצירת Pageחדשה והוספתה למיקום המסומן. | 
| insert | Page | הוספת Pageהנתון באינדקס שצוין. | 
| insert | Paragraph | הוספת Paragraphהנתון באינדקס שצוין. | 
| insert | Paragraph | יצירת Paragraphחדש והוספה שלו לאינדקס שצוין, עם תוכן הטקסט שצוין. | 
| insert | Table | יצירת Tableחדשה והוספתה למיקום המסומן. | 
| insert | Table | יצירת Tableחדש שמכיל את התאים שצוינו, והוספה שלו למיקום שצוין. | 
| insert | Table | הוספת Tableהנתון באינדקס שצוין. | 
| remove | Body | הסרה של רכיב הבן שצוין. | 
| replace | Element | מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים. | 
| set | Body | הגדרת המאפיינים של האלמנט. | 
| set | Body | הגדרת המאפיינים של Paragraphשצוין. | 
| set | Body | הגדרת השוליים התחתונים, בנקודות. | 
| set | Body | הגדרת השוליים השמאליים בנקודות. | 
| set | Body | הגדרת השוליים הימני, בנקודות. | 
| set | Body | הגדרת השוליים העליונים. | 
| set | Body | הגדרת גובה הדף בנקודות. | 
| set | Body | הגדרת רוחב הדף בנקודות. | 
| set | Body | הגדרת התוכן כטקסט פשוט. | 
| set | Body | הגדרת יישור הטקסט. | 
מסמכים מפורטים
append
יצירת Horizontal חדש והוספתו.
ה-Horizontal ייכלל ב-Paragraph חדש.
חזרה
Horizontal – הקו האופקי החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
append
יצירת Inline חדש והוספתו לקובץ ה-blob של התמונה שצוין.
התמונה תהיה ב-Paragraph חדש.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| image | Blob | נתוני התמונה. | 
חזרה
Inline – התמונה שצורפה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
append
הוספה של Inline הנתון.
ה-Inline ייכלל ב-Paragraph חדש.
משתמשים בגרסה הזו של append כשמחברים עותק של Inline קיים.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| image | Inline | נתוני התמונה. | 
חזרה
Inline – התמונה שצורפה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
append
הוספה של List הנתון.
משתמשים בגרסה הזו של append כשמחברים עותק של List קיים.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| list | List | פריט הרשימה שרוצים לצרף. | 
חזרה
List – פריט הרשימה שנוסף.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
append
יצירת List חדש שמצורף אליו תוכן הטקסט שצוין.
פריטים רצופים ברשימה מתווספים כחלק מאותה רשימה.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| text | String | תוכן הטקסט של פריט הרשימה. | 
חזרה
List – פריט הרשימה החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
append
יצירת Page חדש והוספתו.
ה-Page ייכלל ב-Paragraph חדש.
חזרה
Page – מעבר הדף החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
append
הוספה של Page הנתון.
ה-Page ייכלל ב-Paragraph חדש.
משתמשים בגרסה הזו של append כשמחברים עותק של Page קיים.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| page | Page | מעבר הדף שרוצים לצרף. | 
חזרה
Page – מעבר הדף שנוסף.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
append
הוספה של Paragraph הנתון.
משתמשים בגרסה הזו של append כשמחברים עותק של Paragraph קיים.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| paragraph | Paragraph | הפסקה שרוצים לצרף. | 
חזרה
Paragraph – הפיסקה שנוספה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
append
יצירת Paragraph חדש שמצורף אליו תוכן הטקסט שצוין.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| text | String | תוכן הטקסט של הפסקה. | 
חזרה
Paragraph — הפיסקה החדשה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
append
יצירת Table חדש והוספתו.
השיטה הזו תוסיף גם פסקה ריקה אחרי הטבלה, כי אי אפשר לסיים מסמכים ב-Google Docs בטבלה.
חזרה
Table — הטבלה החדשה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
append
הפונקציה מוסיפה Table חדש שמכיל Table לכל ערך מחרוזת שצוין.
השיטה הזו תוסיף גם פסקה ריקה אחרי הטבלה, כי אי אפשר לסיים מסמכים ב-Google Docs בטבלה.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| cells | String[][] | תוכן הטקסט של תאי הטבלה שרוצים להוסיף לטבלה החדשה. | 
חזרה
Table – הטבלה שנוספה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
append
הוספה של Table הנתון.
משתמשים בגרסה הזו של append כשמחברים עותק של Table קיים.
השיטה הזו תוסיף גם פסקה ריקה אחרי הטבלה, כי אי אפשר לסיים מסמכים ב-Google Docs בטבלה.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| table | Table | הטבלה שרוצים לצרף. | 
חזרה
Table – הטבלה שנוספה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
clear()
copy()
הפונקציה מחזירה עותק מנותק ומעמיק של הרכיב הנוכחי.
כל אלמנטי הצאצא שנמצאים באלמנט יועתקו גם כן. לאלמנט החדש אין הורה.
חזרה
Body – העותק החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
edit
הצגת גרסת Text של הרכיב הנוכחי לצורך עריכה.
משתמשים ב-edit כדי לבצע פעולות על תוכן הרכיבים כטקסט עשיר. במצב edit המערכת מתעלמת מאלמנטים שאינם טקסט (כמו Inline ו-Horizontal).
רכיבי צאצא שנכללים במלואם בטווח הטקסט שנמחק יוסרו מהרכיב.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, 'An editAsText sample.'); body.insertHorizontalRule(0); body.insertParagraph(0, 'An example.'); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
חזרה
Text — גרסה טקסטואלית של הרכיב הנוכחי
find
חיפוש בתוכן של הרכיב אחר צאצא מהסוג שצוין.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| element | Element | סוג הרכיב שרוצים לחפש. | 
חזרה
Range — תוצאת חיפוש שמציינת את המיקום של רכיב החיפוש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
find
הפונקציה מחפשת בתוכן של הרכיב צאצא מהסוג שצוין, החל מ-Range שצוין.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| element | Element | סוג הרכיב שרוצים לחפש. | 
| from | Range | תוצאת החיפוש שממנה רוצים לבצע חיפוש. | 
חזרה
Range — תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
find
חיפוש דפוס הטקסט שצוין בתוכן של האלמנט באמצעות ביטויים רגולריים.
אין תמיכה מלאה בקבוצת משנה של תכונות הביטויים הרגולריים של JavaScript, כמו קבוצות תיעוד (capture groups) ומשתני שינוי מצב (mode modifiers).
תבנית הביטוי הרגולרי שצוינה מותאמת בנפרד לכל בלוק טקסט שמכיל את הרכיב הנוכחי.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| search | String | הדפוס שרוצים לחפש | 
חזרה
Range – תוצאת חיפוש שמציינת את המיקום של טקסט החיפוש, או null אם אין התאמה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
find
חיפוש של דפוס הטקסט שצוין בתוכן הרכיב, החל מתוצאת חיפוש נתונה.
אין תמיכה מלאה בקבוצת משנה של תכונות הביטויים הרגולריים של JavaScript, כמו קבוצות תיעוד (capture groups) ומשתני שינוי מצב (mode modifiers).
תבנית הביטוי הרגולרי שצוינה מותאמת בנפרד לכל בלוק טקסט שמכיל את הרכיב הנוכחי.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| search | String | הדפוס שרוצים לחפש | 
| from | Range | תוצאת החיפוש שבה רוצים לבצע חיפוש | 
חזרה
Range – תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או null אם אין התאמה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור המאפיינים של האלמנט.
התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין רכיב תקין, כאשר כל שם מאפיין תואם לפריט בספירה Document.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
חזרה
Object – המאפיינים של האלמנט.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור רכיב הצאצא לפי אינדקס הצאצא שצוין.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText('This is the first paragraph.'); }
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Integer | האינדקס של רכיב הצאצא שרוצים לאחזר. | 
חזרה
Element – רכיב הצאצא במדד שצוין.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור של מדד הצאצא של רכיב הצאצא שצוין.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Element | רכיב הצאצא שעבורו רוצים לאחזר את האינדקס. | 
חזרה
Integer — האינדקס של הצאצא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור קבוצת המאפיינים של Paragraph שצוין.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| paragraph | Paragraph | הכותרת שאת המאפיינים שלה צריך לאחזר. | 
חזרה
Object – מפה של המאפיינים והערכים הנוכחיים שלהם.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור של כל ה-Inline שמכיל הקטע.
חזרה
Inline – תמונות הקטעים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור של כל ה-List שמכיל הקטע.
חזרה
List — הפריטים ברשימת הקטעים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור השוליים התחתונים, בנקודות.
חזרה
Number — השוליים התחתונים, בנקודות.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
הפונקציה מאחזרת את השוליים השמאליים, בנקודות.
חזרה
Number – השוליים השמאליים, בנקודות.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור השוליים הימני.
חזרה
Number — השוליים הימניים, בפונטים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור השוליים העליונים.
חזרה
Number — השוליים העליונים, בנקודות.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור מספר הילדים.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);
חזרה
Integer – מספר הילדים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור גובה הדף, בנקודות.
חזרה
Number — גובה הדף, בנקודות.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור רוחב הדף, בנקודות.
חזרה
Number — רוחב הדף, בנקודות.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור כל ה-Paragraphs שמכיל הקטע (כולל List).
חזרה
Paragraph[] – הפסקות בקטע.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור של רכיב ההורה של האלמנט.
רכיב ההורה מכיל את הרכיב הנוכחי.
חזרה
Container – רכיב ההורה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור של כל ה-Tables שמכיל הקטע.
חזרה
Table[] – טבלאות הקטעים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור התוכן של הרכיב כמחרוזת טקסט.
חזרה
String – התוכן של הרכיב כמחרוזת טקסט
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
הפונקציה מקבלת את יישור הטקסט. סוגי ההתאמה הזמינים הם Document, Document ו-Document.
חזרה
Text – סוג היישור של הטקסט, או null אם הטקסט מכיל כמה סוגים של יישור טקסט או אם יישור הטקסט מעולם לא הוגדר
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
get
אחזור הערך של Element ברכיב.
אפשר להשתמש ב-get כדי לקבוע את הסוג המדויק של רכיב נתון.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
חזרה
Element – סוג הרכיב.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
insert
יצירת Horizontal חדשה והוספתה למיקום המסומן.
ה-Horizontal ייכלל ב-Paragraph חדש.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. | 
חזרה
Horizontal – הקו האופקי החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
insert
יצירת Inline והוספתו מ-blob התמונה שצוין, במדד שצוין.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. | 
| image | Blob | נתוני התמונה. | 
חזרה
Inline — התמונה שנוספה בתוך השורה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
insert
הוספת Inline הנתון באינדקס שצוין.
התמונה תהיה ב-Paragraph חדש.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. | 
| image | Inline | התמונה שרוצים להוסיף. | 
חזרה
Inline — התמונה שנוספה בתוך השורה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
insert
הוספת List הנתון באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. | 
| list | List | פריט הרשימה שרוצים להוסיף. | 
חזרה
List – פריט הרשימה שנוסף.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
insert
יצירת List חדש והוספה שלו לאינדקס שצוין, עם תוכן הטקסט שצוין.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. | 
| text | String | תוכן הטקסט של פריט הרשימה. | 
חזרה
List – פריט הרשימה החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
insert
יצירת Page חדשה והוספתה למיקום המסומן.
ה-Page ייכלל ב-Paragraph חדש.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. | 
חזרה
Page – מעבר הדף החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
insert
הוספת Page הנתון באינדקס שצוין.
ה-Page ייכלל ב-Paragraph חדש.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. | 
| page | Page | מעבר הדף שרוצים להוסיף. | 
חזרה
Page — מעבר הדף שנוסף.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
insert
הוספת Paragraph הנתון באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. | 
| paragraph | Paragraph | הפסקה שרוצים להוסיף. | 
חזרה
Paragraph – הפיסקה שנוספה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
insert
יצירת Paragraph חדש והוספה שלו לאינדקס שצוין, עם תוכן הטקסט שצוין.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. | 
| text | String | תוכן הטקסט של הפסקה. | 
חזרה
Paragraph — הפיסקה החדשה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
insert
יצירת Table חדשה והוספתה למיקום המסומן.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. | 
חזרה
Table — הטבלה החדשה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
insert
יצירת Table חדש שמכיל את התאים שצוינו, והוספה שלו למיקום שצוין.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. | 
| cells | String[][] | תוכן הטקסט של תאי הטבלה שרוצים להוסיף לטבלה החדשה. | 
חזרה
Table — הטבלה החדשה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
insert
הוספת Table הנתון באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. | 
| table | Table | הטבלה שרוצים להוסיף. | 
חזרה
Table – הטבלה שנוספה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
remove
הסרה של רכיב הבן שצוין.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| child | Element | רכיב הצאצא שרוצים להסיר. | 
חזרה
Body – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
replace
מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים.
דפוס החיפוש מועבר כמחרוזת, ולא כאובייקט של ביטוי רגולרי ב-JavaScript. לכן צריך להשתמש בתו בריחה (escape) לפני כל קו נטוי לאחור בתבנית.
השיטות האלה משתמשות בספריית הביטויים הרגולריים של Google, RE2, שמגבילה את התחביר הנתמך.
תבנית הביטוי הרגולרי שצוינה מותאמת בנפרד לכל בלוק טקסט שמכיל את הרכיב הנוכחי.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| search | String | דפוס הביטוי הרגולרי לחיפוש | 
| replacement | String | הטקסט שישמש להחלפה | 
חזרה
Element – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
set
הגדרת המאפיינים של האלמנט.
פרמטר המאפיינים שצוין חייב להיות אובייקט שבו כל שם מאפיין הוא פריט בספירה של Document וכל ערך מאפיין הוא הערך החדש שרוצים להחיל.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| attributes | Object | המאפיינים של האלמנט. | 
חזרה
Body – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
set
הגדרת המאפיינים של Paragraph שצוין.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| paragraph | Paragraph | הכותרת שצריך להגדיר את המאפיינים שלה. | 
| attributes | Object | מפה של מאפיינים והערכים להגדרתם. | 
חזרה
Body – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
set
הגדרת השוליים התחתונים, בנקודות.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| margin | Number | השוליים התחתונים, בנקודות. | 
חזרה
Body – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
set
הגדרת השוליים השמאליים בנקודות.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| margin | Number | השוליים השמאליים, בנקודות. | 
חזרה
Body – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
set
הגדרת השוליים הימני, בנקודות.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| margin | Number | השוליים הימניים. | 
חזרה
Body – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
set
הגדרת השוליים העליונים.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| margin | Number | השוליים העליונים, בנקודות. | 
חזרה
Body – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
set
הגדרת גובה הדף בנקודות.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| page | Number | גובה הדף, בנקודות. | 
חזרה
Body – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
set
הגדרת רוחב הדף בנקודות.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| page | Number | רוחב הדף, בנקודות. | 
חזרה
Body – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
set
הגדרת התוכן כטקסט פשוט.
הערה: התוכן הקיים יימחק.
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| text | String | תוכן הטקסט החדש. | 
חזרה
Body – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents
set
הגדרת יישור הטקסט. סוגי ההתאמה הזמינים הם Document, Document ו-Document.
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
פרמטרים
| שם | סוג | תיאור | 
|---|---|---|
| text | Text | סוג יישור הטקסט שרוצים להחיל | 
חזרה
Body – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
- 
https://www.googleapis.com/auth/documents.currentonly
- 
https://www.googleapis.com/auth/documents