Class ListItem

ListItem

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

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

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

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

// Append a new list item to the body.
var 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.
var item2 = body.appendListItem('Item 2');
item2.setListId(item1);

שיטות

שיטהסוג הערך המוחזרתיאור קצר
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מגדיר את כתובת האתר של הקישור.
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 חדש מ-blob של התמונה שצוין.

פרמטרים

שםסוגתיאור
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 - הרכיב החדש של מעבר דף

אישור

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

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

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

var 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 - תוצאת חיפוש שמציינת את המיקום של רכיב החיפוש.

אישור

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

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

findElement(elementType, from)

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

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

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

פרמטרים

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

חזרה

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

אישור

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

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

findText(searchPattern)

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

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

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

פרמטרים

שםסוגתיאור
searchPatternStringהדפוס שצריך לחפש

חזרה

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

אישור

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

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

findText(searchPattern, from)

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

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

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

פרמטרים

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

חזרה

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.

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

// Append a styled paragraph.
var par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
var atts = par.getAttributes();

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

חזרה

Object – המאפיינים של הרכיב.

אישור

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

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

getChild(childIndex)

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

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

// Obtain the first element in the tab.
var 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 – סוג הגליף

אישור

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

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

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

var 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 לפי מזהה התמונה.

פרמטרים

שםסוגתיאור
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 — רכיב האח הקודם.

אישור

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

  • 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() כדי לקבוע את הסוג המדויק של רכיב נתון.

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

// Obtain the first element in the active tab's body.

var 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 - הרכיב החדש של מעבר דף

אישור

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

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

אישור

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

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

merge()

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

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

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

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
var par1 = body.appendParagraph('Paragraph 1.');
var 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.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

חזרה

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

אישור

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

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

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

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

// Remove all images in the active tab's body.
var imgs = body.getImages();
for (var 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 לפי מזהה התמונה.

פרמטרים

שםסוגתיאור
idString

חזרה

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

אישור

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

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

replaceText(searchPattern, replacement)

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

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

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

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

var 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 וכל ערך מאפיין הוא הערך החדש שצריך הוחלו.

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

// Define a custom paragraph style.
var 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.
var 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)

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

פרמטרים

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

חזרה

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.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var 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