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

Class Body

התוכן של כרטיסייה במסמך ב-Google Docs. ה-Body יכול להכיל את הרכיבים ListItem,‏ Paragraph,‏ Table ו-TableOfContents. מידע נוסף על מבנה המסמך זמין במדריך להרחבת Google Docs.

בדרך כלל, הרכיב Body מכיל את כל התוכן של הכרטיסייה, מלבד הרכיבים HeaderSection,‏ FooterSection ורכיבי FootnoteSection.

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

שיטה	סוג הערך המוחזר	תיאור קצר
`appendHorizontalRule()`	`HorizontalRule`	יצירת `HorizontalRule` חדש והוספתו.
`appendImage(image)`	`InlineImage`	יצירת `InlineImage` חדש והוספתו לקובץ ה-blob של התמונה שצוין.
`appendImage(image)`	`InlineImage`	הוספה של `InlineImage` הנתון.
`appendListItem(listItem)`	`ListItem`	הוספה של `ListItem` הנתון.
`appendListItem(text)`	`ListItem`	יצירת `ListItem` חדש שמצורף אליו תוכן הטקסט שצוין.
`appendPageBreak()`	`PageBreak`	יצירת `PageBreak` חדש והוספתו.
`appendPageBreak(pageBreak)`	`PageBreak`	הוספה של `PageBreak` הנתון.
`appendParagraph(paragraph)`	`Paragraph`	הוספה של `Paragraph` הנתון.
`appendParagraph(text)`	`Paragraph`	יצירת `Paragraph` חדש שמצורף אליו תוכן הטקסט שצוין.
`appendTable()`	`Table`	יצירת `Table` חדש והוספתו.
`appendTable(cells)`	`Table`	הפונקציה מוסיפה `Table` חדש שמכיל `TableCell` לכל ערך מחרוזת שצוין.
`appendTable(table)`	`Table`	הוספה של `Table` הנתון.
`clear()`	`Body`	ניקוי התוכן של הרכיב.
`copy()`	`Body`	הפונקציה מחזירה עותק מנותק ומעמיק של הרכיב הנוכחי.
`editAsText()`	`Text`	הצגת גרסת `Text` של הרכיב הנוכחי לצורך עריכה.
`findElement(elementType)`	`RangeElement`	חיפוש בתוכן של הרכיב אחר צאצא מהסוג שצוין.
`findElement(elementType, from)`	`RangeElement`	הפונקציה מחפשת בתוכן של הרכיב צאצא מהסוג שצוין, החל מ-`RangeElement` שצוין.
`findText(searchPattern)`	`RangeElement`	חיפוש דפוס הטקסט שצוין בתוכן של האלמנט באמצעות ביטויים רגולריים.
`findText(searchPattern, from)`	`RangeElement`	חיפוש של דפוס הטקסט שצוין בתוכן הרכיב, החל מתוצאת חיפוש נתונה.
`getAttributes()`	`Object`	אחזור המאפיינים של האלמנט.
`getChild(childIndex)`	`Element`	אחזור רכיב הצאצא לפי אינדקס הצאצא שצוין.
`getChildIndex(child)`	`Integer`	אחזור של מדד הצאצא של רכיב הצאצא שצוין.
`getHeadingAttributes(paragraphHeading)`	`Object`	אחזור קבוצת המאפיינים של `ParagraphHeading` שצוין.
`getImages()`	`InlineImage[]`	אחזור של כל ה-`InlineImages` שמכיל הקטע.
`getListItems()`	`ListItem[]`	אחזור של כל ה-`ListItems` שמכיל הקטע.
`getMarginBottom()`	`Number`	אחזור השוליים התחתונים, בנקודות.
`getMarginLeft()`	`Number`	הפונקציה מאחזרת את השוליים השמאליים, בנקודות.
`getMarginRight()`	`Number`	אחזור השוליים הימני.
`getMarginTop()`	`Number`	אחזור השוליים העליונים.
`getNumChildren()`	`Integer`	אחזור מספר הילדים.
`getPageHeight()`	`Number`	אחזור גובה הדף, בנקודות.
`getPageWidth()`	`Number`	אחזור רוחב הדף, בנקודות.
`getParagraphs()`	`Paragraph[]`	אחזור כל ה-`Paragraphs` שמכיל הקטע (כולל `ListItems`).
`getParent()`	`ContainerElement`	אחזור של רכיב ההורה של האלמנט.
`getTables()`	`Table[]`	אחזור של כל ה-`Tables` שמכיל הקטע.
`getText()`	`String`	אחזור התוכן של הרכיב כמחרוזת טקסט.
`getTextAlignment()`	`TextAlignment`	הפונקציה מקבלת את יישור הטקסט.
`getType()`	`ElementType`	אחזור הערך של `ElementType` ברכיב.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	יצירת `HorizontalRule` חדשה והוספתה למיקום המסומן.
`insertImage(childIndex, image)`	`InlineImage`	יצירת `InlineImage` והוספתו מ-blob התמונה שצוין, במדד שצוין.
`insertImage(childIndex, image)`	`InlineImage`	הוספת `InlineImage` הנתון באינדקס שצוין.
`insertListItem(childIndex, listItem)`	`ListItem`	הוספת `ListItem` הנתון באינדקס שצוין.
`insertListItem(childIndex, text)`	`ListItem`	יצירת `ListItem` חדש והוספה שלו לאינדקס שצוין, עם תוכן הטקסט שצוין.
`insertPageBreak(childIndex)`	`PageBreak`	יצירת `PageBreak` חדשה והוספתה למיקום המסומן.
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	הוספת `PageBreak` הנתון באינדקס שצוין.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	הוספת `Paragraph` הנתון באינדקס שצוין.
`insertParagraph(childIndex, text)`	`Paragraph`	יצירת `Paragraph` חדש והוספה שלו לאינדקס שצוין, עם תוכן הטקסט שצוין.
`insertTable(childIndex)`	`Table`	יצירת `Table` חדשה והוספתה למיקום המסומן.
`insertTable(childIndex, cells)`	`Table`	יצירת `Table` חדש שמכיל את התאים שצוינו, והוספה שלו למיקום שצוין.
`insertTable(childIndex, table)`	`Table`	הוספת `Table` הנתון באינדקס שצוין.
`removeChild(child)`	`Body`	הסרה של רכיב הבן שצוין.
`replaceText(searchPattern, replacement)`	`Element`	מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים.
`setAttributes(attributes)`	`Body`	הגדרת המאפיינים של האלמנט.
`setHeadingAttributes(paragraphHeading, attributes)`	`Body`	הגדרת המאפיינים של `ParagraphHeading` שצוין.
`setMarginBottom(marginBottom)`	`Body`	הגדרת השוליים התחתונים, בנקודות.
`setMarginLeft(marginLeft)`	`Body`	הגדרת השוליים השמאליים בנקודות.
`setMarginRight(marginRight)`	`Body`	הגדרת השוליים הימני, בנקודות.
`setMarginTop(marginTop)`	`Body`	הגדרת השוליים העליונים.
`setPageHeight(pageHeight)`	`Body`	הגדרת גובה הדף בנקודות.
`setPageWidth(pageWidth)`	`Body`	הגדרת רוחב הדף בנקודות.
`setText(text)`	`Body`	הגדרת התוכן כטקסט פשוט.
`setTextAlignment(textAlignment)`	`Body`	הגדרת יישור הטקסט.

שיטות שהוצאו משימוש

שיטה	סוג הערך המוחזר	תיאור קצר
`getFootnotes()`	`Footnote[]`	אחזור של כל ה-`Footnotes` שמכיל הקטע.
`getLinkUrl()`	`String`	אחזור כתובת ה-URL של הקישור.
`getNextSibling()`	`Element`	אחזור הרכיב הבא של הרכיב.
`getPreviousSibling()`	`Element`	אחזור של רכיב האח הקודם של הרכיב.
`isAtDocumentEnd()`	`Boolean`	הפונקציה קובעת אם הרכיב נמצא בסוף ה-`Document`.
`setLinkUrl(url)`	`Body`	הגדרת כתובת ה-URL של הקישור.

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

`appendHorizontalRule()`

יצירת HorizontalRule חדש והוספתו.

ה-HorizontalRule ייכלל ב-Paragraph חדש.

חזרה

HorizontalRule – הקו האופקי החדש.

אישור

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

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

`appendImage(image)`

יצירת InlineImage חדש והוספתו לקובץ ה-blob של התמונה שצוין.

התמונה תהיה ב-Paragraph חדש.

פרמטרים

שם	סוג	תיאור
`image`	`BlobSource`	נתוני התמונה.

חזרה

InlineImage – התמונה שצורפה.

אישור

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

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

`appendImage(image)`

הוספה של InlineImage הנתון.

ה-InlineImage ייכלל ב-Paragraph חדש.

משתמשים בגרסה הזו של appendImage כשמחברים עותק של InlineImage קיים.

פרמטרים

שם	סוג	תיאור
`image`	`InlineImage`	נתוני התמונה.

חזרה

InlineImage – התמונה שצורפה.

אישור

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

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

`appendListItem(listItem)`

הוספה של ListItem הנתון.

משתמשים בגרסה הזו של appendListItem כשמחברים עותק של ListItem קיים.

פרמטרים

שם	סוג	תיאור
`listItem`	`ListItem`	פריט הרשימה שרוצים לצרף.

חזרה

ListItem – פריט הרשימה שנוסף.

אישור

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

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

`appendListItem(text)`

יצירת ListItem חדש שמצורף אליו תוכן הטקסט שצוין.

פריטים רצופים ברשימה מתווספים כחלק מאותה רשימה.

פרמטרים

שם	סוג	תיאור
`text`	`String`	תוכן הטקסט של פריט הרשימה.

חזרה

ListItem – פריט הרשימה החדש.

אישור

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

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

`appendPageBreak()`

יצירת PageBreak חדש והוספתו.

ה-PageBreak ייכלל ב-Paragraph חדש.

חזרה

PageBreak – מעבר הדף החדש.

אישור

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

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

`appendPageBreak(pageBreak)`

הוספה של PageBreak הנתון.

ה-PageBreak ייכלל ב-Paragraph חדש.

משתמשים בגרסה הזו של appendPageBreak כשמחברים עותק של PageBreak קיים.

פרמטרים

שם	סוג	תיאור
`pageBreak`	`PageBreak`	מעבר הדף שרוצים לצרף.

חזרה

PageBreak – מעבר הדף שנוסף.

אישור

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

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

`appendParagraph(paragraph)`

הוספה של Paragraph הנתון.

משתמשים בגרסה הזו של appendParagraph כשמחברים עותק של Paragraph קיים.

פרמטרים

שם	סוג	תיאור
`paragraph`	`Paragraph`	הפסקה שרוצים לצרף.

חזרה

Paragraph – הפיסקה שנוספה.

אישור

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

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

`appendParagraph(text)`

יצירת Paragraph חדש שמצורף אליו תוכן הטקסט שצוין.

פרמטרים

שם	סוג	תיאור
`text`	`String`	תוכן הטקסט של הפסקה.

חזרה

Paragraph — הפיסקה החדשה.

אישור

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

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

`appendTable()`

יצירת Table חדש והוספתו.

השיטה הזו תוסיף גם פסקה ריקה אחרי הטבלה, כי אי אפשר לסיים מסמכים ב-Google Docs בטבלה.

חזרה

Table — הטבלה החדשה.

אישור

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

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

`appendTable(cells)`

הפונקציה מוסיפה Table חדש שמכיל TableCell לכל ערך מחרוזת שצוין.

השיטה הזו תוסיף גם פסקה ריקה אחרי הטבלה, כי אי אפשר לסיים מסמכים ב-Google Docs בטבלה.

פרמטרים

שם	סוג	תיאור
`cells`	`String[][]`	תוכן הטקסט של תאי הטבלה שרוצים להוסיף לטבלה החדשה.

חזרה

Table – הטבלה שנוספה.

אישור

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

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

`appendTable(table)`

הוספה של Table הנתון.

משתמשים בגרסה הזו של appendTable כשמחברים עותק של Table קיים. השיטה הזו תוסיף גם פסקה ריקה אחרי הטבלה, כי אי אפשר לסיים מסמכים ב-Google Docs בטבלה.

פרמטרים

שם	סוג	תיאור
`table`	`Table`	הטבלה שרוצים לצרף.

חזרה

Table – הטבלה שנוספה.

אישור

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

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

`clear()`

ניקוי התוכן של הרכיב.

חזרה

Body – הרכיב הנוכחי.

`copy()`

הפונקציה מחזירה עותק מנותק ומעמיק של הרכיב הנוכחי.

כל אלמנטי הצאצא שנמצאים באלמנט יועתקו גם כן. לאלמנט החדש אין הורה.

חזרה

Body – העותק החדש.

אישור

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

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

`editAsText()`

הצגת גרסת Text של הרכיב הנוכחי לצורך עריכה.

משתמשים ב-editAsText כדי לבצע פעולות על תוכן הרכיבים כטקסט עשיר. במצב editAsText המערכת מתעלמת מאלמנטים שאינם טקסט (כמו InlineImage ו-HorizontalRule).

רכיבי צאצא שנכללים במלואם בטווח הטקסט שנמחק יוסרו מהרכיב.

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 — גרסה טקסטואלית של הרכיב הנוכחי

`findElement(elementType)`

חיפוש בתוכן של הרכיב אחר צאצא מהסוג שצוין.

פרמטרים

שם	סוג	תיאור
`elementType`	`ElementType`	סוג הרכיב שרוצים לחפש.

חזרה

RangeElement — תוצאת חיפוש שמציינת את המיקום של רכיב החיפוש.

אישור

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

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

`findElement(elementType, from)`

הפונקציה מחפשת בתוכן של הרכיב צאצא מהסוג שצוין, החל מ-RangeElement שצוין.

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;
  }
}

פרמטרים

שם	סוג	תיאור
`elementType`	`ElementType`	סוג הרכיב שרוצים לחפש.
`from`	`RangeElement`	תוצאת החיפוש שממנה רוצים לבצע חיפוש.

חזרה

RangeElement — תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש.

אישור

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

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

`findText(searchPattern)`

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

אין תמיכה מלאה בקבוצת משנה של תכונות הביטויים הרגולריים של JavaScript, כמו קבוצות תיעוד (capture groups) ומשתני שינוי מצב (mode modifiers).

תבנית הביטוי הרגולרי שצוינה מותאמת בנפרד לכל בלוק טקסט שמכיל את הרכיב הנוכחי.

פרמטרים

שם	סוג	תיאור
`searchPattern`	`String`	הדפוס שרוצים לחפש

חזרה

RangeElement – תוצאת חיפוש שמציינת את המיקום של טקסט החיפוש, או null אם אין התאמה

אישור

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

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

`findText(searchPattern, from)`

חיפוש של דפוס הטקסט שצוין בתוכן הרכיב, החל מתוצאת חיפוש נתונה.

תבנית הביטוי הרגולרי שצוינה מותאמת בנפרד לכל בלוק טקסט שמכיל את הרכיב הנוכחי.

פרמטרים

שם	סוג	תיאור
`searchPattern`	`String`	הדפוס שרוצים לחפש
`from`	`RangeElement`	תוצאת החיפוש שבה רוצים לבצע חיפוש

חזרה

RangeElement – תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או null אם אין התאמה

אישור

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

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

`getAttributes()`

אחזור המאפיינים של האלמנט.

התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין רכיב תקין, כאשר כל שם מאפיין תואם לפריט בספירה DocumentApp.Attribute.

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

`getChild(childIndex)`

אחזור רכיב הצאצא לפי אינדקס הצאצא שצוין.

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.');
}

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס של רכיב הצאצא שרוצים לאחזר.

חזרה

Element – רכיב הצאצא במדד שצוין.

אישור

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

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

`getChildIndex(child)`

אחזור של מדד הצאצא של רכיב הצאצא שצוין.

פרמטרים

שם	סוג	תיאור
`child`	`Element`	רכיב הצאצא שעבורו רוצים לאחזר את האינדקס.

חזרה

Integer — האינדקס של הצאצא.

אישור

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

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

`getHeadingAttributes(paragraphHeading)`

אחזור קבוצת המאפיינים של ParagraphHeading שצוין.

פרמטרים

שם	סוג	תיאור
`paragraphHeading`	`ParagraphHeading`	הכותרת שאת המאפיינים שלה צריך לאחזר.

חזרה

Object – מפה של המאפיינים והערכים הנוכחיים שלהם.

אישור

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

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

`getImages()`

אחזור של כל ה-InlineImages שמכיל הקטע.

חזרה

InlineImage[] – תמונות הקטעים.

אישור

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

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

`getListItems()`

אחזור של כל ה-ListItems שמכיל הקטע.

חזרה

ListItem[] — הפריטים ברשימת הקטעים.

אישור

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

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

`getMarginBottom()`

אחזור השוליים התחתונים, בנקודות.

חזרה

Number — השוליים התחתונים, בנקודות.

אישור

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

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

`getMarginLeft()`

הפונקציה מאחזרת את השוליים השמאליים, בנקודות.

חזרה

Number – השוליים השמאליים, בנקודות.

אישור

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

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

`getMarginRight()`

אחזור השוליים הימני.

חזרה

Number — השוליים הימניים, בפונטים.

אישור

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

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

`getMarginTop()`

אחזור השוליים העליונים.

חזרה

Number — השוליים העליונים, בנקודות.

אישור

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

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

`getNumChildren()`

אחזור מספר הילדים.

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

`getPageHeight()`

אחזור גובה הדף, בנקודות.

חזרה

Number — גובה הדף, בנקודות.

אישור

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

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

`getPageWidth()`

אחזור רוחב הדף, בנקודות.

חזרה

Number — רוחב הדף, בנקודות.

אישור

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

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

`getParagraphs()`

אחזור כל ה-Paragraphs שמכיל הקטע (כולל ListItems).

חזרה

Paragraph[] – הפסקות בקטע.

אישור

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

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

`getParent()`

אחזור של רכיב ההורה של האלמנט.

רכיב ההורה מכיל את הרכיב הנוכחי.

חזרה

ContainerElement – רכיב ההורה.

אישור

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

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

`getTables()`

אחזור של כל ה-Tables שמכיל הקטע.

חזרה

Table[] – טבלאות הקטעים.

אישור

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

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

`getText()`

אחזור התוכן של הרכיב כמחרוזת טקסט.

חזרה

String – התוכן של הרכיב כמחרוזת טקסט

אישור

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

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

`getTextAlignment()`

הפונקציה מקבלת את יישור הטקסט. סוגי ההתאמה הזמינים הם DocumentApp.TextAlignment.NORMAL,‏ DocumentApp.TextAlignment.SUBSCRIPT ו-DocumentApp.TextAlignment.SUPERSCRIPT.

חזרה

TextAlignment – סוג היישור של הטקסט, או null אם הטקסט מכיל כמה סוגים של יישור טקסט או אם יישור הטקסט מעולם לא הוגדר

אישור

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

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

`getType()`

אחזור הערך של ElementType ברכיב.

אפשר להשתמש ב-getType() כדי לקבוע את הסוג המדויק של רכיב נתון.

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.');
}

חזרה

ElementType – סוג הרכיב.

אישור

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

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

`insertHorizontalRule(childIndex)`

יצירת HorizontalRule חדשה והוספתה למיקום המסומן.

ה-HorizontalRule ייכלל ב-Paragraph חדש.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו רוצים להוסיף את הרכיב.

חזרה

HorizontalRule – הקו האופקי החדש.

אישור

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

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

`insertImage(childIndex, image)`

יצירת InlineImage והוספתו מ-blob התמונה שצוין, במדד שצוין.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו רוצים להוסיף את הרכיב.
`image`	`BlobSource`	נתוני התמונה.

חזרה

InlineImage — התמונה שנוספה בתוך השורה.

אישור

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

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

`insertImage(childIndex, image)`

הוספת InlineImage הנתון באינדקס שצוין.

התמונה תהיה ב-Paragraph חדש.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו רוצים להוסיף את הרכיב.
`image`	`InlineImage`	התמונה שרוצים להוסיף.

חזרה

InlineImage — התמונה שנוספה בתוך השורה.

אישור

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

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

`insertListItem(childIndex, listItem)`

הוספת ListItem הנתון באינדקס שצוין.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו רוצים להוסיף את הרכיב.
`listItem`	`ListItem`	פריט הרשימה שרוצים להוסיף.

חזרה

ListItem – פריט הרשימה שנוסף.

אישור

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

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

`insertListItem(childIndex, text)`

יצירת ListItem חדש והוספה שלו לאינדקס שצוין, עם תוכן הטקסט שצוין.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו רוצים להוסיף את הרכיב.
`text`	`String`	תוכן הטקסט של פריט הרשימה.

חזרה

ListItem – פריט הרשימה החדש.

אישור

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

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

`insertPageBreak(childIndex)`

יצירת PageBreak חדשה והוספתה למיקום המסומן.

ה-PageBreak ייכלל ב-Paragraph חדש.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו רוצים להוסיף את הרכיב.

חזרה

PageBreak – מעבר הדף החדש.

אישור

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

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

`insertPageBreak(childIndex, pageBreak)`

הוספת PageBreak הנתון באינדקס שצוין.

ה-PageBreak ייכלל ב-Paragraph חדש.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו רוצים להוסיף את הרכיב.
`pageBreak`	`PageBreak`	מעבר הדף שרוצים להוסיף.

חזרה

PageBreak — מעבר הדף שנוסף.

אישור

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

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

`insertParagraph(childIndex, paragraph)`

הוספת Paragraph הנתון באינדקס שצוין.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו רוצים להוסיף את הרכיב.
`paragraph`	`Paragraph`	הפסקה שרוצים להוסיף.

חזרה

Paragraph – הפיסקה שנוספה.

אישור

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

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

`insertParagraph(childIndex, text)`

יצירת Paragraph חדש והוספה שלו לאינדקס שצוין, עם תוכן הטקסט שצוין.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו רוצים להוסיף את הרכיב.
`text`	`String`	תוכן הטקסט של הפסקה.

חזרה

Paragraph — הפיסקה החדשה.

אישור

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

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

`insertTable(childIndex)`

יצירת Table חדשה והוספתה למיקום המסומן.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו רוצים להוסיף את הרכיב.

חזרה

Table — הטבלה החדשה.

אישור

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

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

`insertTable(childIndex, cells)`

יצירת Table חדש שמכיל את התאים שצוינו, והוספה שלו למיקום שצוין.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו רוצים להוסיף את הרכיב.
`cells`	`String[][]`	תוכן הטקסט של תאי הטבלה שרוצים להוסיף לטבלה החדשה.

חזרה

Table — הטבלה החדשה.

אישור

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

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

`insertTable(childIndex, table)`

הוספת Table הנתון באינדקס שצוין.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו רוצים להוסיף את הרכיב.
`table`	`Table`	הטבלה שרוצים להוסיף.

חזרה

Table – הטבלה שנוספה.

אישור

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

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

`removeChild(child)`

הסרה של רכיב הבן שצוין.

פרמטרים

שם	סוג	תיאור
`child`	`Element`	רכיב הצאצא שרוצים להסיר.

חזרה

Body – הרכיב הנוכחי.

אישור

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

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

`replaceText(searchPattern, replacement)`

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

דפוס החיפוש מועבר כמחרוזת, ולא כאובייקט של ביטוי רגולרי ב-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');

פרמטרים

שם	סוג	תיאור
`searchPattern`	`String`	דפוס הביטוי הרגולרי לחיפוש
`replacement`	`String`	הטקסט שישמש להחלפה

חזרה

Element – הרכיב הנוכחי

אישור

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

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

`setAttributes(attributes)`

הגדרת המאפיינים של האלמנט.

פרמטר המאפיינים שצוין חייב להיות אובייקט שבו כל שם מאפיין הוא פריט בספירה של DocumentApp.Attribute וכל ערך מאפיין הוא הערך החדש שרוצים להחיל.

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

`setHeadingAttributes(paragraphHeading, attributes)`

הגדרת המאפיינים של ParagraphHeading שצוין.

פרמטרים

שם	סוג	תיאור
`paragraphHeading`	`ParagraphHeading`	הכותרת שצריך להגדיר את המאפיינים שלה.
`attributes`	`Object`	מפה של מאפיינים והערכים להגדרתם.

חזרה

Body – הרכיב הנוכחי.

אישור

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

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

`setMarginBottom(marginBottom)`

הגדרת השוליים התחתונים, בנקודות.

פרמטרים

שם	סוג	תיאור
`marginBottom`	`Number`	השוליים התחתונים, בנקודות.

חזרה

Body – הרכיב הנוכחי.

אישור

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

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

`setMarginLeft(marginLeft)`

הגדרת השוליים השמאליים בנקודות.

פרמטרים

שם	סוג	תיאור
`marginLeft`	`Number`	השוליים השמאליים, בנקודות.

חזרה

Body – הרכיב הנוכחי.

אישור

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

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

`setMarginRight(marginRight)`

הגדרת השוליים הימני, בנקודות.

פרמטרים

שם	סוג	תיאור
`marginRight`	`Number`	השוליים הימניים.

חזרה

Body – הרכיב הנוכחי.

אישור

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

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

`setMarginTop(marginTop)`

הגדרת השוליים העליונים.

פרמטרים

שם	סוג	תיאור
`marginTop`	`Number`	השוליים העליונים, בנקודות.

חזרה

Body – הרכיב הנוכחי.

אישור

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

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

`setPageHeight(pageHeight)`

הגדרת גובה הדף בנקודות.

פרמטרים

שם	סוג	תיאור
`pageHeight`	`Number`	גובה הדף, בנקודות.

חזרה

Body – הרכיב הנוכחי.

אישור

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

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

`setPageWidth(pageWidth)`

הגדרת רוחב הדף בנקודות.

פרמטרים

שם	סוג	תיאור
`pageWidth`	`Number`	רוחב הדף, בנקודות.

חזרה

Body – הרכיב הנוכחי.

אישור

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

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

`setText(text)`

הגדרת התוכן כטקסט פשוט.

הערה: התוכן הקיים יימחק.

פרמטרים

שם	סוג	תיאור
`text`	`String`	תוכן הטקסט החדש.

חזרה

Body – הרכיב הנוכחי.

אישור

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

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

`setTextAlignment(textAlignment)`

הגדרת יישור הטקסט. סוגי ההתאמה הזמינים הם DocumentApp.TextAlignment.NORMAL,‏ DocumentApp.TextAlignment.SUBSCRIPT ו-DocumentApp.TextAlignment.SUPERSCRIPT.

// 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);

פרמטרים

שם	סוג	תיאור
`textAlignment`	`TextAlignment`	סוג יישור הטקסט שרוצים להחיל

חזרה

Body – הרכיב הנוכחי

אישור

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

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

שיטות שהוצאו משימוש

`getFootnotes()`

הוצא משימוש. הרכיב הזה לא יכול להכיל Footnote.

אחזור של כל ה-Footnotes שמכיל הקטע.

חזרה

Footnote[] — הערות השוליים של הקטע.

אישור

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

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

`getLinkUrl()`

הוצא משימוש. במקום להחיל קישור על קטע שלם, כדאי להחיל את הקישור על רכיב בתוך הקטע.

אחזור כתובת ה-URL של הקישור.

חזרה

String – כתובת ה-URL של הקישור, או null אם הרכיב מכיל כמה ערכים למאפיין הזה

אישור

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

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

`getNextSibling()`

הוצא משימוש. לרכיב הזה אין אחים.

אחזור הרכיב הבא של הרכיב.

לרכיב האח הבא יש אותו הורה והוא מופיע אחרי הרכיב הנוכחי.

חזרה

Element – רכיב האח הבא.

אישור

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

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

`getPreviousSibling()`

הוצא משימוש. לרכיב הזה אין אחים.

אחזור של רכיב האח הקודם של הרכיב.

לרכיב האח הקודם יש אותו הורה והוא מופיע לפני הרכיב הנוכחי.

חזרה

Element — רכיב האח/ה הקודם.

אישור

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

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

`isAtDocumentEnd()`

הוצא משימוש. השיטה הזו לא מהימנה עבור HeaderSection.

הפונקציה קובעת אם הרכיב נמצא בסוף ה-Document.

חזרה

Boolean — אם הרכיב נמצא בסוף הכרטיסייה.

אישור

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

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

`setLinkUrl(url)`

הוצא משימוש. במקום להחיל קישור על קטע שלם, כדאי להחיל את הקישור על רכיב בתוך הקטע.

הגדרת כתובת ה-URL של הקישור.

פרמטרים

שם	סוג	תיאור
`url`	`String`	כתובת ה-URL של הקישור

חזרה

Body – הרכיב הנוכחי

אישור

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

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