Class TableCell

TableCell

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

Methods

שיטהסוג הערך שמוחזרתיאור קצר
appendHorizontalRule()HorizontalRuleיוצרת HorizontalRule חדש ומצרפת אותו.
appendImage(image)InlineImageיוצר ומצרף InlineImage חדש מבלוב התמונה שצוין.
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|nullמחפש בתוכן של הרכיב צאצא מסוג מסוים.
findElement(elementType, from)RangeElement|nullהפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
findText(searchPattern)RangeElement|nullמחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
findText(searchPattern, from)RangeElement|nullמחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
getAttributes()Objectמאחזר את המאפיינים של האלמנט.
getBackgroundColor()String|nullמחזירה את צבע הרקע.
getChild(childIndex)Elementמאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
getChildIndex(child)Integerמאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getColSpan()Integerמאחזרת את טווח העמודות, שהוא מספר העמודות של תאי הטבלה שהתא הזה משתרע עליהן.
getLinkUrl()String|nullהפונקציה מחזירה את כתובת ה-URL של הקישור.
getNextSibling()Element|nullמחזירה את רכיב האח הבא של הרכיב.
getNumChildren()Integerמאחזר את מספר הילדים.
getPaddingBottom()Number|nullמאחזר את המרווח הפנימי התחתון, בנקודות.
getPaddingLeft()Number|nullמאחזר את המרווח הפנימי השמאלי, בנקודות.
getPaddingRight()Number|nullמאחזר את המרווח הפנימי הימני, בנקודות.
getPaddingTop()Number|nullמאחזר את המרווח הפנימי העליון, בנקודות.
getParent()ContainerElement|nullמאחזר את אלמנט ההורה של האלמנט.
getParentRow()TableRow|nullאחזור TableRow שמכיל את TableCell הנוכחי.
getParentTable()Table|nullאחזור Table שמכיל את TableCell הנוכחי.
getPreviousSibling()Element|nullמאחזר את רכיב האח הקודם של הרכיב.
getRowSpan()Integerהפונקציה מאחזרת את מספר השורות שהתא הזה משתרע עליהן בטבלה.
getText()Stringמאחזרת את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignment|nullמקבל את יישור הטקסט.
getType()ElementTypeאחזור ElementType של הרכיב.
getVerticalAlignment()VerticalAlignment|nullמאחזר את VerticalAlignment.
getWidth()Number|nullהפונקציה מאחזרת את רוחב העמודה שמכילה את התא, בנקודות.
insertHorizontalRule(childIndex)HorizontalRuleיוצרת ומכניסה אובייקט HorizontalRule חדש באינדקס שצוין.
insertImage(childIndex, image)InlineImageיוצרת ומכניסה InlineImage מבלוב התמונה שצוין, באינדקס שצוין.
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|nullמיזוג הרכיב עם הרכיב הקודם מאותו סוג.
removeChild(child)TableCellהסרת רכיב הבן שצוין.
removeFromParent()TableCell|nullהפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
replaceText(searchPattern, replacement)Elementהפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים.
setAttributes(attributes)TableCellהגדרת המאפיינים של האלמנט.
setBackgroundColor(color)TableCellהגדרת צבע הרקע.
setLinkUrl(url)TableCellמגדיר את כתובת ה-URL של הקישור.
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 חדש מבלוב התמונה שצוין.

התג 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).

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

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

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

חזרה

Text – גרסת טקסט של הרכיב הנוכחי


findElement(elementType)

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

פרמטרים

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

חזרה

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

אישור

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

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

findElement(elementType, from)

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

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

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

פרמטרים

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

חזרה

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

אישור

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

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

findText(searchPattern)

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

findText(searchPattern, from)

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

getAttributes()

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

התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין תקין של רכיב, כאשר כל שם מאפיין תואם לפריט בספירה DocumentApp.Attribute.

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

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

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

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

חזרה

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

אישור

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

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

getBackgroundColor()

מחזירה את צבע הרקע.

חזרה

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

אישור

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

  • 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

getColSpan()

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

חזרה

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

אישור

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

  • 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

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

getPaddingBottom()

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

חזרה

Number|null — המרווח הפנימי התחתון, בנקודות

אישור

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

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

getPaddingLeft()

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

חזרה

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

אישור

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

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

getPaddingRight()

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

חזרה

Number|null — המרווח הפנימי הימני, בנקודות

אישור

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

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

getPaddingTop()

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

חזרה

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

אישור

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

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

getParent()

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

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

חזרה

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

אישור

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

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

getParentRow()

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

חזרה

TableRow|null — שורת הטבלה שמכילה את התא הנוכחי

אישור

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

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

getParentTable()

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

חזרה

Table|null — הטבלה שמכילה את התא הנוכחי

אישור

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

  • 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

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

getVerticalAlignment()

מאחזר את VerticalAlignment.

חזרה

VerticalAlignment|null — היישור האנכי

אישור

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

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

getWidth()

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

חזרה

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

אישור

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

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

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

האלמנט הנוכחי יוסר מהמסמך.

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

חזרה

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

אישור

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

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

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

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

חזרה

TableCell|null — הרכיב שהוסר.

אישור

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

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

replaceText(searchPattern, replacement)

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

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

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

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

setAttributes(attributes)

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

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

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

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

פרמטרים

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

חזרה

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)

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

פרמטרים

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

חזרה

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