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 חדש מבלוב התמונה שצוין.
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|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAlignment()HorizontalAlignment|nullמאחזר את HorizontalAlignment.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getGlyphType()GlyphType|nullאחזור GlyphType של הפריט ברשימה.
getHeading()ParagraphHeading|nullמאחזר את ParagraphHeading.
getIndentEnd()Number|nullמאחזר את ההזחה בסוף, בנקודות.
getIndentFirstLine()Number|nullהפונקציה מאחזרת את גודל הכניסה של השורה הראשונה, בנקודות.
getIndentStart()Number|nullמחזירה את ההזחה של תחילת הפסקה.
getLineSpacing()Number|nullמאחזרת את הריווח בין השורות, בנקודות.
getLinkUrl()String|nullהפונקציה מחזירה את כתובת ה-URL של הקישור.
getListId()String|nullמאחזר את מזהה הרשימה.
getNestingLevel()Integerמאחזר את רמת הקינון של הפריט ברשימה.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getNumChildren()Integerמאחזר את מספר הילדים.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getPositionedImage(id)PositionedImageמקבלים PositionedImage לפי מזהה התמונה.
getPositionedImages()PositionedImage[]מקבל את כל אובייקטי PositionedImage שמעוגנים לפסקה.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getSpacingAfter()Number|nullמאחזר את הריווח אחרי הרכיב, בנקודות.
getSpacingBefore()Number|nullמחזירה את הריווח לפני הרכיב, בנקודות.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
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|nullמאחזר את ההגדרה משמאל לימין.
merge()ListItem|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeChild(child)ListItemהסרת רכיב הבן שצוין.
removeFromParent()ListItem|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
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 התמונה שצוין.

פרמטרים

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

חזרה

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 חדש מבלוב התמונה שצוין.

פרמטרים

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

חזרה

InlineImage – התמונה שנוספה

אישור

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

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

appendInlineImage(image)

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

פרמטרים

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

חזרה

InlineImage – התמונה שנוספה

אישור

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

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

appendPageBreak()

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

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

חזרה

PageBreak — the new page break element

אישור

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

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

appendPageBreak(pageBreak)

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

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

פרמטרים

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

חזרה

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

אישור

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

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

appendText(text)

יוצרת ומצרפת רכיב Text חדש עם התוכן שצוין.

פרמטרים

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

חזרה

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

אישור

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

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

appendText(text)

הפונקציה מוסיפה את רכיב Text הנתון.

פרמטרים

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

חזרה

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)

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

פרמטרים

שםסוגתיאור
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

getAlignment()

מאחזר את HorizontalAlignment.

חזרה

HorizontalAlignment|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

getGlyphType()

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

חזרה

GlyphType|null – סוג הגליף

אישור

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

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

getHeading()

מאחזר את ParagraphHeading.

חזרה

ParagraphHeading|null – הכותרת

אישור

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

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

getIndentEnd()

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

חזרה

Number|null – הכניסה של סוף הפסקה, בנקודות

אישור

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

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

getIndentFirstLine()

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

חזרה

Number|null — כניסת השורה הראשונה, בנקודות

אישור

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

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

getIndentStart()

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

חזרה

Number|null — התחלת הכניסה

אישור

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

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

getLineSpacing()

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

חזרה

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

אישור

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

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

getLinkUrl()

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

חזרה

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

אישור

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

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

getListId()

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

חזרה

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

אישור

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

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

getParent()

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

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

חזרה

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

אישור

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

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

getPositionedImage(id)

מקבלים PositionedImage לפי מזהה התמונה.

פרמטרים

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

חזרה

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|null – רכיב האח הקודם.

אישור

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

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

getSpacingAfter()

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

חזרה

Number|null — הריווח אחרי הרכיב, בנקודות

אישור

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

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

getSpacingBefore()

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

חזרה

Number|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 ומוסיפה אותו לאינדקס שצוין.

פרמטרים

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

חזרה

HorizontalRule – רכיב הסרגל האופקי החדש

אישור

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

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

insertInlineImage(childIndex, image)

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

פרמטרים

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

חזרה

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

אישור

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

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

insertInlineImage(childIndex, image)

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

פרמטרים

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

חזרה

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

אישור

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

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

insertPageBreak(childIndex)

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

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

פרמטרים

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

חזרה

PageBreak — the new page break element

אישור

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

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

insertPageBreak(childIndex, pageBreak)

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

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

פרמטרים

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

חזרה

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

אישור

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

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

insertText(childIndex, text)

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

פרמטרים

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

חזרה

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

אישור

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

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

insertText(childIndex, text)

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

פרמטרים

שםסוגתיאור
childIndexIntegerהאינדקס שבו יתווסף הרכיב
textTextרכיב הטקסט להוספה

חזרה

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|null – ההגדרה משמאל לימין

אישור

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

  • 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|null – הרכיב הממוזג.

אישור

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

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

removeChild(child)

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

פרמטרים

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

חזרה

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|null — הרכיב שהוסר.

אישור

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

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

removePositionedImage(id)

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

פרמטרים

שםסוגתיאור
idString

חזרה

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

אישור

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

  • 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

setAlignment(alignment)

מגדיר את HorizontalAlignment.

פרמטרים

שםסוגתיאור
alignmentHorizontalAlignmentהיישור האופקי

חזרה

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

פרמטרים

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

חזרה

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

אישור

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

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

setGlyphType(glyphType)

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

פרמטרים

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

חזרה

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

אישור

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

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

setHeading(heading)

מגדיר את ParagraphHeading.

פרמטרים

שםסוגתיאור
headingParagraphHeadingהכותרת

חזרה

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

אישור

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

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

setIndentEnd(indentEnd)

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

פרמטרים

שםסוגתיאור
indentEndNumberהכניסה של סוף הפסקה, בנקודות

חזרה

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

אישור

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

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

setIndentFirstLine(indentFirstLine)

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

פרמטרים

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

חזרה

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

אישור

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

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

setIndentStart(indentStart)

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

פרמטרים

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

חזרה

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

אישור

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

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

setLeftToRight(leftToRight)

הגדרה משמאל לימין.

פרמטרים

שםסוגתיאור
leftToRightBooleanההגדרה משמאל לימין

חזרה

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

אישור

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

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

setLineSpacing(multiplier)

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

פרמטרים

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

חזרה

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

אישור

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

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

setLinkUrl(url)

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

פרמטרים

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

חזרה

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

אישור

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

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

setListId(listItem)

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

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

פרמטרים

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

חזרה

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

אישור

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

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

setNestingLevel(nestingLevel)

קובעת את רמת הקינון של הפריט ברשימה.

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

פרמטרים

שםסוגתיאור
nestingLevelIntegerרמת הסידור הפנימי

חזרה

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

אישור

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

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

setSpacingAfter(spacingAfter)

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

פרמטרים

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

חזרה

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

אישור

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

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

setSpacingBefore(spacingBefore)

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

פרמטרים

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

חזרה

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

אישור

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

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

setText(text)

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

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

פרמטרים

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

אישור

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

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

חזרה

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

אישור

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

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