Class TableCell

TableCell

רכיב שמייצג תא בטבלה. TableCell תמיד נמצא בתוך TableRow ועשוי להכיל רכיבי ListItem, Paragraph או Table. עבור למידע נוסף על מבנה המסמך, ראו מדריך להרחבת Google Docs.

שיטות

שיטהסוג הערך המוחזרתיאור קצר
appendHorizontalRule()HorizontalRuleיצירה והוספה של HorizontalRule חדש.
appendImage(image)InlineImageיצירה והוספה של InlineImage חדש מ-blob של התמונה שצוין.
appendImage(image)InlineImageהפונקציה מצרפת את הערך של InlineImage הנתון.
appendListItem(listItem)ListItemהפונקציה מצרפת את הערך של ListItem הנתון.
appendListItem(text)ListItemיצירה והוספה של ListItem חדש.
appendParagraph(paragraph)Paragraphהפונקציה מצרפת את הערך של Paragraph הנתון.
appendParagraph(text)Paragraphיצירה והוספה של Paragraph חדש.
appendTable()Tableיצירה והוספה של Table חדש.
appendTable(cells)Tableהפונקציה מצרפת את Table חדש שמכיל את התאים שצוינו.
appendTable(table)Tableהפונקציה מצרפת את הערך של Table הנתון.
clear()TableCellניקוי התוכן של הרכיב.
copy()TableCellהפונקציה מחזירה עותק עמוק בנפרד עבור הרכיב הנוכחי.
editAsText()Textמתקבלת גרסת Text של הרכיב הנוכחי, לעריכה.
findElement(elementType)RangeElementחיפוש תוכן הרכיב כדי למצוא צאצא מהסוג שצוין.
findElement(elementType, from)RangeElementמחפש את תוכן הרכיב כדי למצוא צאצא מהסוג שצוין, החל מ- ציינת RangeElement.
findText(searchPattern)RangeElementחיפוש תוכן הרכיב לפי דפוס הטקסט שצוין באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElementחיפוש תוכן הרכיב לפי תבנית הטקסט שצוינה, החל ממאפיין נתון בתוצאות החיפוש.
getAttributes()Objectאחזור המאפיינים של הרכיב.
getBackgroundColor()Stringאחזור של צבע הרקע.
getChild(childIndex)Elementאחזור הרכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerאחזור של אינדקס הצאצא לרכיב הצאצא שצוין.
getColSpan()Integerאחזור טווח העמודה, שהוא מספר העמודות של תאי הטבלה בתא הזה.
getLinkUrl()Stringאחזור כתובת ה-URL של הקישור.
getNextSibling()Elementאחזור של רכיב האח הבא של הרכיב.
getNumChildren()Integerאחזור של מספר הילדים.
getPaddingBottom()Numberאחזור של המרווח הפנימי התחתון בנקודות.
getPaddingLeft()Numberאחזור של המרווח הפנימי השמאלי בנקודות.
getPaddingRight()Numberאחזור של המרווח הפנימי הנכון בנקודות.
getPaddingTop()Numberאחזור של המרווח הפנימי העליון בנקודות.
getParent()ContainerElementאחזור הרכיב ההורה של הרכיב.
getParentRow()TableRowאחזור של TableRow שמכיל את הערך הנוכחי של TableCell.
getParentTable()Tableאחזור של Table שמכיל את הערך הנוכחי של TableCell.
getPreviousSibling()Elementאחזור של רכיב האח הקודם של הרכיב.
getRowSpan()Integerאחזור טווח השורות, שהוא מספר השורות של תאי הטבלה בתא הזה.
getText()Stringאחזור תוכן הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignmentמקבל את היישור של הטקסט.
getType()ElementTypeמאחזר את ElementType של הרכיב.
getVerticalAlignment()VerticalAlignmentאחזור של VerticalAlignment.
getWidth()Numberאחזור רוחב העמודה שמכילה את התא, בנקודות.
insertHorizontalRule(childIndex)HorizontalRuleיצירה והוספה של HorizontalRule חדש באינדקס שצוין.
insertImage(childIndex, image)InlineImageיצירה והוספה של InlineImage מה-blob של התמונה שצוין, בתרחיש שצוין להוסיף לאינדקס.
insertImage(childIndex, image)InlineImageמוסיפה את InlineImage הנתון באינדקס שצוין.
insertListItem(childIndex, listItem)ListItemמוסיפה את ListItem הנתון באינדקס שצוין.
insertListItem(childIndex, text)ListItemיצירה והוספה של ListItem חדש באינדקס שצוין.
insertParagraph(childIndex, paragraph)Paragraphמוסיפה את Paragraph הנתון באינדקס שצוין.
insertParagraph(childIndex, text)Paragraphיצירה והוספה של Paragraph חדש באינדקס שצוין.
insertTable(childIndex)Tableיצירה והוספה של Table חדש באינדקס שצוין.
insertTable(childIndex, cells)Tableיצירה והוספה של Table חדש שמכיל את התאים שצוינו, באינדקס שצוין.
insertTable(childIndex, table)Tableמוסיפה את Table הנתון באינדקס שצוין.
isAtDocumentEnd()Booleanהפונקציה קובעת אם הרכיב נמצא בסוף Document.
merge()TableCellהתכונה ממזגת את הרכיב עם האח הקודם מאותו סוג.
removeChild(child)TableCellהסרת רכיב הצאצא שצוין.
removeFromParent()TableCellהסרת הרכיב מרכיב ההורה שלו.
replaceText(searchPattern, replacement)Elementמחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת החלפה נתונה, באמצעות הפונקציה הרגילה הבעות פנים.
setAttributes(attributes)TableCellמגדיר את המאפיינים של הרכיב.
setBackgroundColor(color)TableCellהגדרת צבע הרקע.
setLinkUrl(url)TableCellמגדיר את כתובת האתר של הקישור.
setPaddingBottom(paddingBottom)TableCellהגדרת המרווח הפנימי התחתון בנקודות.
setPaddingLeft(paddingLeft)TableCellהגדרת המרווח הפנימי השמאלי בנקודות.
setPaddingRight(paddingRight)TableCellהגדרת המרווח הפנימי הנכון בנקודות.
setPaddingTop(paddingTop)TableCellהגדרת המרווח הפנימי העליון בנקודות.
setText(text)TableCellמגדיר את התוכן כטקסט פשוט.
setTextAlignment(textAlignment)TableCellמגדיר את יישור הטקסט.
setVerticalAlignment(alignment)TableCellמגדיר את היישור האנכי.
setWidth(width)TableCellמגדיר את רוחב העמודה שמכילה את התא הנוכחי, בנקודות.

מסמכי תיעוד מפורטים

appendHorizontalRule()

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

השדה HorizontalRule ייכלל בקובץ Paragraph חדש.

חזרה

HorizontalRule – הכלל האופקי החדש

אישור

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

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

appendImage(image)

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

השדה InlineImage ייכלל בקובץ Paragraph חדש.

פרמטרים

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

חזרה

InlineImage – התמונה החדשה

אישור

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

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

appendImage(image)

הפונקציה מצרפת את הערך של InlineImage הנתון.

השדה InlineImage ייכלל בקובץ Paragraph חדש.

פרמטרים

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

חזרה

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

אישור

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

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

appendListItem(listItem)

הפונקציה מצרפת את הערך של ListItem הנתון.

פרמטרים

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

חזרה

ListItem – הפריט שצורף לרשימה

אישור

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

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

appendListItem(text)

יצירה והוספה של ListItem חדש.

פרמטרים

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

חזרה

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

אישור

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

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

appendParagraph(paragraph)

הפונקציה מצרפת את הערך של Paragraph הנתון.

פרמטרים

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

חזרה

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

אישור

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

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

appendParagraph(text)

יצירה והוספה של Paragraph חדש.

פרמטרים

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

חזרה

Paragraph – הפסקה החדשה

אישור

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

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

appendTable()

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

חזרה

Table – הטבלה החדשה

אישור

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

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

appendTable(cells)

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

פרמטרים

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

חזרה

Table – הטבלה המצורפת

אישור

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

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

appendTable(table)

הפונקציה מצרפת את הערך של Table הנתון.

פרמטרים

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

חזרה

Table – הטבלה המצורפת

אישור

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

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

clear()

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

חזרה

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


copy()

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

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

חזרה

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

אישור

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

  • 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

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

getBackgroundColor()

אחזור של צבע הרקע.

חזרה

String – צבע הרקע, בפורמט של סימון CSS (כמו '#ffffff')

אישור

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

  • 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

getColSpan()

אחזור טווח העמודה, שהוא מספר העמודות של תאי הטבלה בתא הזה. טווח התאים שלא ממוזגים הוא 1.

חזרה

Integer – טווח העמודה או 0 בתא שמוזג על ידי תא אחר

אישור

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

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

getLinkUrl()

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

חזרה

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

אישור

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

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

getNextSibling()

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

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

חזרה

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

אישור

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

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

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

getPaddingBottom()

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

חזרה

Number – המרווח הפנימי התחתון בנקודות

אישור

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

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

getPaddingLeft()

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

חזרה

Number – המרווח הפנימי השמאלי בנקודות

אישור

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

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

getPaddingRight()

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

חזרה

Number – המרווח הפנימי הנכון בנקודות

אישור

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

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

getPaddingTop()

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

חזרה

Number – המרווח הפנימי העליון בנקודות

אישור

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

  • 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

getParentRow()

אחזור של TableRow שמכיל את הערך הנוכחי של TableCell.

חזרה

TableRow – השורה בטבלה שמכילה את התא הנוכחי

אישור

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

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

getParentTable()

אחזור של Table שמכיל את הערך הנוכחי של TableCell.

חזרה

Table – הטבלה שמכילה את התא הנוכחי

אישור

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

  • 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

getRowSpan()

אחזור טווח השורות, שהוא מספר השורות של תאי הטבלה בתא הזה. לא מוזג טווח השורה של התאים הוא 1.

חזרה

Integer – טווח השורה או 0 של תא שמוזג על ידי תא אחר

אישור

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

  • 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

getVerticalAlignment()

אחזור של VerticalAlignment.

חזרה

VerticalAlignment – היישור האנכי

אישור

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

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

getWidth()

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

חזרה

Number – רוחב העמודה, בנקודות

אישור

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

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

insertHorizontalRule(childIndex)

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

הכלל האופקי ייכלל בקובץ Paragraph חדש.

פרמטרים

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

חזרה

HorizontalRule – הכלל האופקי החדש

אישור

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

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

insertImage(childIndex, image)

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

התמונה תיכלל בקובץ Paragraph חדש.

פרמטרים

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

חזרה

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

אישור

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

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

insertImage(childIndex, image)

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

התמונה תיכלל בקובץ Paragraph חדש.

פרמטרים

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

חזרה

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

אישור

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

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

insertListItem(childIndex, listItem)

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

פרמטרים

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

חזרה

ListItem — נוסף פריט חדש ברשימה

אישור

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

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

insertListItem(childIndex, text)

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

פרמטרים

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

חזרה

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

אישור

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

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

insertParagraph(childIndex, paragraph)

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

פרמטרים

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

חזרה

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

אישור

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

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

insertParagraph(childIndex, text)

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

פרמטרים

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

חזרה

Paragraph – הפסקה החדשה

אישור

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

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

insertTable(childIndex)

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

פרמטרים

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

חזרה

Table – הטבלה החדשה

אישור

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

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

insertTable(childIndex, cells)

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

פרמטרים

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

חזרה

Table – הטבלה החדשה

אישור

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

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

insertTable(childIndex, table)

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

פרמטרים

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

חזרה

Table – הטבלה שהוכנסה

אישור

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

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

isAtDocumentEnd()

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

חזרה

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

חזרה

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

אישור

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

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

removeChild(child)

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

פרמטרים

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

חזרה

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

אישור

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

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

חזרה

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

אישור

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

  • 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

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המאפיינים של הרכיב.

חזרה

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

אישור

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

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

setBackgroundColor(color)

הגדרת צבע הרקע.

פרמטרים

שםסוגתיאור
colorStringצבע הרקע, בפורמט של סימון CSS (כמו '#ffffff')

חזרה

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

אישור

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

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

setLinkUrl(url)

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

פרמטרים

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

חזרה

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

אישור

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

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

setPaddingBottom(paddingBottom)

הגדרת המרווח הפנימי התחתון בנקודות.

פרמטרים

שםסוגתיאור
paddingBottomNumberהמרווח הפנימי התחתון בנקודות

חזרה

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

אישור

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

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

setPaddingLeft(paddingLeft)

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

פרמטרים

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

חזרה

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

אישור

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

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

setPaddingRight(paddingRight)

הגדרת המרווח הפנימי הנכון בנקודות.

פרמטרים

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

חזרה

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

אישור

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

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

setPaddingTop(paddingTop)

הגדרת המרווח הפנימי העליון בנקודות.

פרמטרים

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

חזרה

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

אישור

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

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

setText(text)

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

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

פרמטרים

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

חזרה

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

אישור

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

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

חזרה

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

אישור

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

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

setVerticalAlignment(alignment)

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

פרמטרים

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

חזרה

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

אישור

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

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

setWidth(width)

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

פרמטרים

שםסוגתיאור
widthNumberרוחב העמודה, בנקודות

חזרה

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

אישור

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

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