Class Body

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 חדש מבלוב התמונה שצוין.
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|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getHeadingAttributes(paragraphHeading)Objectהפונקציה מאחזרת את קבוצת המאפיינים של ParagraphHeading שצוין.
getImages()InlineImage[]|nullמאחזר את כל ה-InlineImages שמופיעים בקטע.
getListItems()ListItem[]|nullמאחזר את כל ה-ListItems שמופיעים בקטע.
getMarginBottom()Number|nullהפונקציה מאחזרת את השוליים התחתונים, בנקודות.
getMarginLeft()Number|nullמאחזרת את השוליים השמאליים, בנקודות.
getMarginRight()Number|nullמאחזר את השוליים הימניים.
getMarginTop()Number|nullהפונקציה מחזירה את השוליים העליונים.
getNumChildren()Integerמאחזר את מספר הילדים.
getPageHeight()Number|nullמאחזר את גובה הדף, בנקודות.
getPageWidth()Number|nullמאחזר את רוחב הדף, בנקודות.
getParagraphs()Paragraph[]|nullמאחזר את כל ה-Paragraphs שמופיעים בקטע (כולל ListItems).
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getTables()Table[]|nullמאחזר את כל ה-Tables שמופיעים בקטע.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
getType()ElementTypeאחזור ElementType של הרכיב.
insertHorizontalRule(childIndex)HorizontalRuleיוצרת ומכניסה אובייקט HorizontalRule חדש באינדקס שצוין.
insertImage(childIndex, image)InlineImageיוצרת ומכניסה InlineImage מבלוב התמונה שצוין, באינדקס שצוין.
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הגדרת יישור הטקסט.

תיעוד מפורט

appendHorizontalRule()

יוצרת HorizontalRule חדש ומצרפת אותו.

התג HorizontalRule ייכלל בתג Paragraph חדש.

חזרה

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

אישור

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

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

appendImage(image)

יוצר ומצרף InlineImage חדש מבלוב התמונה שצוין.

התמונה תופיע בתוך תג Paragraph חדש.

פרמטרים

שםסוגתיאור
imageBlobSourceנתוני התמונה.

חזרה

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

אישור

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

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

appendImage(image)

הוספה של InlineImage שצוין.

התג InlineImage ייכלל בתג Paragraph חדש.

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

פרמטרים

שםסוגתיאור
imageInlineImageנתוני התמונה.

חזרה

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

אישור

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

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

appendListItem(listItem)

הוספה של ListItem שצוין.

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

פרמטרים

שםסוגתיאור
listItemListItemהפריט ברשימה שרוצים לצרף.

חזרה

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

אישור

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

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

appendListItem(text)

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

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

פרמטרים

שםסוגתיאור
textStringתוכן הטקסט של הפריט ברשימה.

חזרה

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 קיים.

פרמטרים

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

חזרה

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

אישור

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

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

appendParagraph(paragraph)

הוספה של Paragraph שצוין.

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

פרמטרים

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

חזרה

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

אישור

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

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

appendParagraph(text)

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

פרמטרים

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

חזרה

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 לא יכולים להסתיים בטבלה.

פרמטרים

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

חזרה

Table — הטבלה שצורפה.

אישור

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

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

appendTable(table)

הוספה של Table שצוין.

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

פרמטרים

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

חזרה

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)

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

פרמטרים

שםסוגתיאור
elementTypeElementTypeסוג הרכיב לחיפוש.

חזרה

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

אישור

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

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

פרמטרים

שםסוגתיאור
elementTypeElementTypeסוג הרכיב לחיפוש.
fromRangeElementתוצאת החיפוש שממנה מתחילים את החיפוש.

חזרה

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

אישור

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

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

findText(searchPattern)

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

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

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

פרמטרים

שםסוגתיאור
searchPatternStringהתבנית לחיפוש

חזרה

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

אישור

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

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

findText(searchPattern, from)

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

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

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

פרמטרים

שםסוגתיאור
searchPatternStringהתבנית לחיפוש
fromRangeElementתוצאת החיפוש שממנה רוצים לחפש

חזרה

RangeElement|null — תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או 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.');
}

פרמטרים

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

חזרה

Element – רכיב הצאצא באינדקס שצוין.

אישור

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

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

getChildIndex(child)

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

פרמטרים

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

חזרה

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

אישור

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

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

getHeadingAttributes(paragraphHeading)

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

פרמטרים

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

חזרה

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

אישור

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

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

getImages()

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

חזרה

InlineImage[]|null — תמונות של החלק.

אישור

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

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

getListItems()

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

חזרה

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

אישור

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

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

getMarginBottom()

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

חזרה

Number|null – השוליים התחתונים, בנקודות.

אישור

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

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

getMarginLeft()

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

חזרה

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

אישור

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

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

getMarginRight()

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

חזרה

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

אישור

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

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

getMarginTop()

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

חזרה

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

אישור

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

  • 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|null – גובה הדף, בנקודות.

אישור

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

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

getPageWidth()

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

חזרה

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

אישור

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

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

getParagraphs()

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

חזרה

Paragraph[]|null – פסקאות הקטע.

אישור

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

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

getParent()

מאחזר את אלמנט ההורה של האלמנט.

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

חזרה

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

אישור

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

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

getTables()

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

חזרה

Table[]|null — הטבלאות של הקטע.

אישור

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

  • 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 – סוג יישור הטקסט, או 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 חדש.

פרמטרים

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

חזרה

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

אישור

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

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

insertImage(childIndex, image)

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

פרמטרים

שםסוגתיאור
childIndexIntegerהאינדקס שבו רוצים להוסיף את הרכיב.
imageBlobSourceנתוני התמונה.

חזרה

InlineImage — התמונה המוטבעת שנוספה.

אישור

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

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

insertImage(childIndex, image)

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

התמונה תופיע בתוך תג Paragraph חדש.

פרמטרים

שםסוגתיאור
childIndexIntegerהאינדקס שבו רוצים להוסיף את הרכיב.
imageInlineImageהתמונה להוספה.

חזרה

InlineImage — התמונה המוטבעת שנוספה.

אישור

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

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

insertListItem(childIndex, listItem)

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

פרמטרים

שםסוגתיאור
childIndexIntegerהאינדקס שבו יתווסף הערך.
listItemListItemהפריט ברשימה שרוצים להוסיף.

חזרה

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

אישור

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

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

insertListItem(childIndex, text)

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

פרמטרים

שםסוגתיאור
childIndexIntegerהאינדקס שבו יתווסף הערך.
textStringתוכן הטקסט של הפריט ברשימה.

חזרה

ListItem — הפריט החדש ברשימה.

אישור

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

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

insertPageBreak(childIndex)

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

התג PageBreak ייכלל בתג Paragraph חדש.

פרמטרים

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

חזרה

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

אישור

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

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

insertPageBreak(childIndex, pageBreak)

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

התג PageBreak ייכלל בתג Paragraph חדש.

פרמטרים

שםסוגתיאור
childIndexIntegerהאינדקס שבו רוצים להוסיף את הרכיב.
pageBreakPageBreakמעבר הדף שרוצים להוסיף.

חזרה

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

אישור

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

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

insertParagraph(childIndex, paragraph)

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

פרמטרים

שםסוגתיאור
childIndexIntegerהאינדקס שבו יתווסף הערך.
paragraphParagraphהפסקה שרוצים להוסיף.

חזרה

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

אישור

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

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

insertParagraph(childIndex, text)

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

פרמטרים

שםסוגתיאור
childIndexIntegerהאינדקס שבו יתווסף הערך.
textStringתוכן הטקסט של הפסקה.

חזרה

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

אישור

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

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

insertTable(childIndex)

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

פרמטרים

שםסוגתיאור
childIndexIntegerהאינדקס שבו יתווסף הערך.

חזרה

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

אישור

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

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

insertTable(childIndex, cells)

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

פרמטרים

שםסוגתיאור
childIndexIntegerהאינדקס שבו יתווסף הערך.
cellsString[][]תוכן הטקסט של תאי הטבלה שרוצים להוסיף לטבלה החדשה.

חזרה

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

אישור

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

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

insertTable(childIndex, table)

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

פרמטרים

שםסוגתיאור
childIndexIntegerהאינדקס שבו יתווסף הערך.
tableTableהטבלה שרוצים להוסיף.

חזרה

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

אישור

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

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

removeChild(child)

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

פרמטרים

שםסוגתיאור
childElementרכיב הילד שרוצים להסיר.

חזרה

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

אישור

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

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

replaceText(searchPattern, replacement)

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

תבנית החיפוש מועברת כמחרוזת, ולא כאובייקט ביטוי רגולרי של JavaScript. לכן, צריך להשתמש בתו בריחה (escape) לכל קו נטוי הפוך בתבנית.

השיטה הזו משתמשת בספריית הביטויים הרגולריים RE2 של Google, שמגבילה את התחביר הנתמך.

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

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

פרמטרים

שםסוגתיאור
searchPatternStringתבנית הביטוי הרגולרי לחיפוש
replacementStringהטקסט שבו רוצים להשתמש להחלפה

חזרה

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

פרמטרים

שםסוגתיאור
attributesObjectהמאפיינים של הרכיב.

חזרה

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

אישור

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

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

setHeadingAttributes(paragraphHeading, attributes)

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

פרמטרים

שםסוגתיאור
paragraphHeadingParagraphHeadingהכותרת שצריך להגדיר את המאפיינים שלה.
attributesObjectמיפוי של מאפיינים והערכים שצריך להגדיר להם.

חזרה

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

אישור

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

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

setMarginBottom(marginBottom)

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

פרמטרים

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

חזרה

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

אישור

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

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

setMarginLeft(marginLeft)

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

פרמטרים

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

חזרה

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

אישור

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

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

setMarginRight(marginRight)

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

פרמטרים

שםסוגתיאור
marginRightNumberהשוליים הימניים.

חזרה

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

אישור

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

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

setMarginTop(marginTop)

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

פרמטרים

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

חזרה

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

אישור

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

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

setPageHeight(pageHeight)

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

פרמטרים

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

חזרה

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

אישור

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

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

setPageWidth(pageWidth)

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

פרמטרים

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

חזרה

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

אישור

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

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

setText(text)

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

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

פרמטרים

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

חזרה

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

פרמטרים

שםסוגתיאור
textAlignmentTextAlignmentסוג יישור הטקסט שרוצים להחיל

חזרה

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

אישור

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

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

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