Class ListItem

ListItem

רכיב שמייצג פריט ברשימה. ListItem הוא Paragraph שמשויך למזהה רשימה. רכיב ListItem יכול להכיל את הרכיבים Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak ו-Text. מידע נוסף על מבנה המסמך זמין במדריך להרחבת Google Docs.

ListItems לא יכול להכיל תווים של מעבר לשורה חדשה. תווים של שורה חדשה ("\n") מומרים לתווים של מעבר שורה ("\r").

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

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

// Append a new list item to the body.
const item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([['Cell 1', 'Cell 2']]);

// Append a second list item with the same list ID. The two items are treated as
// the same list, despite not being consecutive.
const item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Methods

שיטה	סוג הערך המוחזר	תיאור קצר
addPositionedImage(image)	PositionedImage	יצירת PositionedImage חדשה והוספה שלה מה-blob של התמונה שצוין.
appendHorizontalRule()	HorizontalRule	יצירת HorizontalRule חדש והוספתו.
appendInlineImage(image)	InlineImage	יצירת InlineImage חדש והוספתו לקובץ ה-blob של התמונה שצוין.
appendInlineImage(image)	InlineImage	הוספה של InlineImage הנתון.
appendPageBreak()	PageBreak	יצירת PageBreak חדש והוספתו.
appendPageBreak(pageBreak)	PageBreak	הוספה של PageBreak הנתון.
appendText(text)	Text	יצירת רכיב Text חדש והוספת התוכן שצוין אליו.
appendText(text)	Text	הוספת האלמנט Text הנתון.
clear()	ListItem	ניקוי התוכן של הרכיב.
copy()	ListItem	הפונקציה מחזירה עותק מנותק ומעמיק של הרכיב הנוכחי.
editAsText()	Text	הצגת גרסת Text של הרכיב הנוכחי לצורך עריכה.
findElement(elementType)	RangeElement	חיפוש בתוכן של הרכיב אחר צאצא מהסוג שצוין.
findElement(elementType, from)	RangeElement	הפונקציה מחפשת בתוכן של הרכיב צאצא מהסוג שצוין, החל מ-RangeElement שצוין.
findText(searchPattern)	RangeElement	חיפוש דפוס הטקסט שצוין בתוכן של האלמנט באמצעות ביטויים רגולריים.
findText(searchPattern, from)	RangeElement	חיפוש של דפוס הטקסט שצוין בתוכן הרכיב, החל מתוצאת חיפוש נתונה.
getAlignment()	HorizontalAlignment	אחזור של HorizontalAlignment.
getAttributes()	Object	אחזור המאפיינים של האלמנט.
getChild(childIndex)	Element	אחזור רכיב הצאצא לפי אינדקס הצאצא שצוין.
getChildIndex(child)	Integer	אחזור של מדד הצאצא של רכיב הצאצא שצוין.
getGlyphType()	GlyphType	אחזור של GlyphType של הפריט ברשימה.
getHeading()	ParagraphHeading	אחזור של ParagraphHeading.
getIndentEnd()	Number	אחזור ההכנסה בסוף, בנקודות.
getIndentFirstLine()	Number	אחזור הגדלת הכניסה של השורה הראשונה, בנקודות.
getIndentStart()	Number	אחזור של הפסקה ההתחלתית.
getLineSpacing()	Number	אחזור הריווח בין השורות, בנקודות.
getLinkUrl()	String	אחזור כתובת ה-URL של הקישור.
getListId()	String	אחזור מזהה הרשימה.
getNestingLevel()	Integer	אחזור של רמת ההטמעה של פריט ברשימה.
getNextSibling()	Element	אחזור הרכיב הבא של הרכיב.
getNumChildren()	Integer	אחזור מספר הילדים.
getParent()	ContainerElement	אחזור של רכיב ההורה של האלמנט.
getPositionedImage(id)	PositionedImage	אחזור PositionedImage לפי מזהה התמונה.
getPositionedImages()	PositionedImage[]	הפונקציה מקבלת את כל אובייקטי ה-PositionedImage שמאוגדים לפסקה.
getPreviousSibling()	Element	אחזור של רכיב האח הקודם של הרכיב.
getSpacingAfter()	Number	אחזור הריווח אחרי הרכיב, בנקודות.
getSpacingBefore()	Number	אחזור הריווח לפני הרכיב, בנקודות.
getText()	String	אחזור התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()	TextAlignment	הפונקציה מקבלת את יישור הטקסט.
getType()	ElementType	אחזור הערך של ElementType ברכיב.
insertHorizontalRule(childIndex)	HorizontalRule	יצירת HorizontalRule והוספה שלו למיקום שצוין.
insertInlineImage(childIndex, image)	InlineImage	יצירת InlineImage חדשה מה-blob של התמונה שצוין והוספתה לאינדקס שצוין.
insertInlineImage(childIndex, image)	InlineImage	הוספת InlineImage הנתון באינדקס שצוין.
insertPageBreak(childIndex)	PageBreak	יצירת PageBreak חדשה והוספתה למיקום המסומן.
insertPageBreak(childIndex, pageBreak)	PageBreak	הוספת PageBreak הנתון באינדקס שצוין.
insertText(childIndex, text)	Text	יצירת רכיב טקסט חדש והוספתו למיקום שצוין.
insertText(childIndex, text)	Text	הוספת רכיב Text נתון במדד שצוין, עם תוכן הטקסט שצוין.
isAtDocumentEnd()	Boolean	הפונקציה קובעת אם הרכיב נמצא בסוף ה-Document.
isLeftToRight()	Boolean	אחזור ההגדרה מימין לשמאל.
merge()	ListItem	מיזוג הרכיב עם האח/ה הקודם/ה מאותו סוג.
removeChild(child)	ListItem	הסרה של רכיב הבן שצוין.
removeFromParent()	ListItem	הסרת הרכיב מהרכיב ההורה שלו.
removePositionedImage(id)	Boolean	הסרת PositionedImage לפי מזהה התמונה.
replaceText(searchPattern, replacement)	Element	מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים.
setAlignment(alignment)	ListItem	הגדרת HorizontalAlignment.
setAttributes(attributes)	ListItem	הגדרת המאפיינים של האלמנט.
setGlyphType(glyphType)	ListItem	הגדרת GlyphType של הפריט ברשימה.
setHeading(heading)	ListItem	הגדרת ParagraphHeading.
setIndentEnd(indentEnd)	ListItem	הגדרת הכניסה בסוף, בנקודות.
setIndentFirstLine(indentFirstLine)	ListItem	הגדרת הפסקה של השורה הראשונה, בנקודות.
setIndentStart(indentStart)	ListItem	הגדרת הכניסה בתחילת השורה, בנקודות.
setLeftToRight(leftToRight)	ListItem	הגדרת כיוון מימין לשמאל.
setLineSpacing(multiplier)	ListItem	הגדרת הריווח בין השורות, ככמות שמציינת את מספר השורות שיש להשתמש בהן לריווח.
setLinkUrl(url)	ListItem	הגדרת כתובת ה-URL של הקישור.
setListId(listItem)	ListItem	הגדרת מזהה הרשימה.
setNestingLevel(nestingLevel)	ListItem	הגדרת רמת ההטמעה של הפריט ברשימה.
setSpacingAfter(spacingAfter)	ListItem	הגדרת הריווח אחרי האלמנט, בנקודות.
setSpacingBefore(spacingBefore)	ListItem	הגדרת הריווח לפני הרכיב, בנקודות.
setText(text)	void	הגדרת התוכן של פריט הרשימה כטקסט.
setTextAlignment(textAlignment)	ListItem	הגדרת יישור הטקסט.

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

addPositionedImage(image)

יצירת PositionedImage חדשה והוספה שלה מה-blob של התמונה שצוין.

פרמטרים

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

חזרה

PositionedImage – התמונה החדשה במיקום החדש

אישור

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

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

---

appendHorizontalRule()

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

חזרה

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

אישור

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

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

---

appendInlineImage(image)

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

פרמטרים

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

חזרה

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

אישור

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

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

---

appendInlineImage(image)

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

פרמטרים

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

חזרה

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

אישור

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

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

---

appendPageBreak()

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

הערה: ייתכן ש-PageBreaks לא יהיה כלול ב-TableCells. אם האלמנט הנוכחי נמצא בתא בטבלה, תופיע חריגה.

חזרה

PageBreak – המרכיב החדש של מעבר דף

אישור

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

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

---

appendPageBreak(pageBreak)

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

הערה: ייתכן ש-PageBreaks לא יהיה כלול ב-TableCells. אם האלמנט הנוכחי נמצא בתא בטבלה, תופיע חריגה.

פרמטרים

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

חזרה

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

אישור

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

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

---

appendText(text)

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

פרמטרים

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

חזרה

Text – רכיב הטקסט החדש

אישור

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

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

---

appendText(text)

הוספת האלמנט Text הנתון.

פרמטרים

שם	סוג	תיאור
text	Text	רכיב הטקסט שרוצים לצרף

חזרה

Text – רכיב הטקסט שנוסף

אישור

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

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

---

clear()

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

חזרה

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

---

copy()

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

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

חזרה

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

אישור

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

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

---

getAlignment()

אחזור של HorizontalAlignment.

חזרה

HorizontalAlignment – היישור

אישור

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

• 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

---

getGlyphType()

אחזור של GlyphType של הפריט ברשימה.

חזרה

GlyphType – סוג הגליף

אישור

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

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

---

getHeading()

אחזור של ParagraphHeading.

חזרה

ParagraphHeading – הכותרת

אישור

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

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

---

getIndentEnd()

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

חזרה

Number – סוף הכניסה, בנקודות

אישור

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

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

---

getIndentFirstLine()

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

חזרה

Number – הגדלת הכניסה של השורה הראשונה, בנקודות

אישור

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

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

---

getIndentStart()

אחזור של הפסקה ההתחלתית.

חזרה

Number – התחלת הכניסה

אישור

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

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

---

getLineSpacing()

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

חזרה

Number – הריווח בין השורות, בנקודות

אישור

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

• 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

---

getListId()

אחזור מזהה הרשימה.

חזרה

String – מזהה הרשימה

אישור

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

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

---

getNestingLevel()

אחזור של רמת ההטמעה של פריט ברשימה.

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

חזרה

Integer – רמת הקינון

אישור

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

• 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

---

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

---

getParent()

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

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

חזרה

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

אישור

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

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

---

getPositionedImage(id)

אחזור PositionedImage לפי מזהה התמונה.

פרמטרים

שם	סוג	תיאור
id	String	מזהה התמונה

חזרה

PositionedImage — התמונה במיקום הרצוי

אישור

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

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

---

getPositionedImages()

הפונקציה מקבלת את כל אובייקטי ה-PositionedImage שמאוגדים לפסקה.

חזרה

PositionedImage[] – רשימה של תמונות במיקום מדויק

אישור

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

• 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

---

getSpacingAfter()

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

חזרה

Number – הריווח אחרי הרכיב, בנקודות

אישור

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

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

---

getSpacingBefore()

אחזור הריווח לפני הרכיב, בנקודות.

חזרה

Number – הריווח לפני הרכיב, בנקודות

אישור

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

• 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 והוספה שלו למיקום שצוין.

פרמטרים

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

חזרה

HorizontalRule – האלמנט החדש של הקו האופקי

אישור

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

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

---

insertInlineImage(childIndex, image)

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

פרמטרים

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

חזרה

InlineImage – רכיב התמונה בתוך השורה שהוכנס

אישור

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

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

---

insertInlineImage(childIndex, image)

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

פרמטרים

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

חזרה

InlineImage – רכיב התמונה בתוך השורה שהוכנס

אישור

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

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

---

insertPageBreak(childIndex)

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

הערה: ייתכן ש-PageBreaks לא יהיה כלול ב-TableCells. אם האלמנט הנוכחי נמצא בתא בטבלה, תופיע חריגה.

פרמטרים

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

חזרה

PageBreak – המרכיב החדש של מעבר דף

אישור

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

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

---

insertPageBreak(childIndex, pageBreak)

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

הערה: ייתכן ש-PageBreaks לא יהיה כלול ב-TableCells. אם האלמנט הנוכחי נמצא בתא בטבלה, תופיע חריגה.

פרמטרים

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

חזרה

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

אישור

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

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

---

insertText(childIndex, text)

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

פרמטרים

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

חזרה

Text – רכיב הטקסט החדש

אישור

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

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

---

insertText(childIndex, text)

הוספת רכיב Text נתון במדד שצוין, עם תוכן הטקסט שצוין.

פרמטרים

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

חזרה

Text – רכיב הטקסט שנוסף

אישור

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

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

---

isAtDocumentEnd()

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

חזרה

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

אישור

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

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

---

isLeftToRight()

אחזור ההגדרה מימין לשמאל.

חזרה

Boolean – ההגדרה מימין לשמאל

אישור

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

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

---

merge()

מיזוג הרכיב עם האח/ה הקודם/ה מאותו סוג.

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

הרכיב הנוכחי יוסר מהמסמך.

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

חזרה

ListItem – הרכיב הממוזג.

אישור

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

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

---

removeChild(child)

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

פרמטרים

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

חזרה

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

אישור

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

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

---

removeFromParent()

הסרת הרכיב מהרכיב ההורה שלו.

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

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

חזרה

ListItem – הרכיב שהוסרה.

אישור

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

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

---

removePositionedImage(id)

הסרת PositionedImage לפי מזהה התמונה.

פרמטרים

שם	סוג	תיאור
id	String

חזרה

Boolean — אם התמונה שצוינה הוסרה או לא

אישור

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

• 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

---

setAlignment(alignment)

הגדרת HorizontalAlignment.

פרמטרים

שם	סוג	תיאור
alignment	HorizontalAlignment	היישור האנכי

חזרה

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

אישור

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

• 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	המאפיינים של האלמנט.

חזרה

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

אישור

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

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

---

setGlyphType(glyphType)

הגדרת GlyphType של הפריט ברשימה.

פרמטרים

שם	סוג	תיאור
glyphType	GlyphType	סוג הגליף

חזרה

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

אישור

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

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

---

setHeading(heading)

הגדרת ParagraphHeading.

פרמטרים

שם	סוג	תיאור
heading	ParagraphHeading	הכותרת

חזרה

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

אישור

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

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

---

setIndentEnd(indentEnd)

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

פרמטרים

שם	סוג	תיאור
indentEnd	Number	סוף הכניסה, בנקודות

חזרה

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

אישור

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

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

---

setIndentFirstLine(indentFirstLine)

הגדרת הפסקה של השורה הראשונה, בנקודות.

פרמטרים

שם	סוג	תיאור
indentFirstLine	Number	כניסת השורה הראשונה, בנקודות

חזרה

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

אישור

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

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

---

setIndentStart(indentStart)

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

פרמטרים

שם	סוג	תיאור
indentStart	Number	התחלת הכניסה, בנקודות

חזרה

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

אישור

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

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

---

setLeftToRight(leftToRight)

הגדרת כיוון מימין לשמאל.

פרמטרים

שם	סוג	תיאור
leftToRight	Boolean	ההגדרה 'מימין לשמאל'

חזרה

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

אישור

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

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

---

setLineSpacing(multiplier)

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

פרמטרים

שם	סוג	תיאור
multiplier	Number	מספר השורות

חזרה

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

אישור

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

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

---

setLinkUrl(url)

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

פרמטרים

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

חזרה

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

אישור

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

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

---

setListId(listItem)

הגדרת מזהה הרשימה.

מזהה הרשימה מוגדר לאותו ערך עבור ListItem שצוין. שני ה-ListItems יטופלו כחברים באותה רשימה.

פרמטרים

שם	סוג	תיאור
listItem	ListItem	פריט הרשימה שלגביו רוצים להשתמש במזהה הרשימה

חזרה

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

אישור

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

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

---

setNestingLevel(nestingLevel)

הגדרת רמת ההטמעה של הפריט ברשימה.

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

פרמטרים

שם	סוג	תיאור
nestingLevel	Integer	רמת ההטמעה

חזרה

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

אישור

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

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

---

setSpacingAfter(spacingAfter)

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

פרמטרים

שם	סוג	תיאור
spacingAfter	Number	הריווח אחרי הרכיב, בנקודות

חזרה

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

אישור

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

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

---

setSpacingBefore(spacingBefore)

הגדרת הריווח לפני הרכיב, בנקודות.

פרמטרים

שם	סוג	תיאור
spacingBefore	Number	הריווח לפני הרכיב, בנקודות

חזרה

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

אישור

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

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

---

setText(text)

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

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

פרמטרים

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

אישור

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

• 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	סוג יישור הטקסט שרוצים להחיל

חזרה

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

אישור

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

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