Class TableCell

TableCell

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

Methods

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

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

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

אישור

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

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

אישור

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

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

findText(searchPattern)

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

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

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

פרמטרים

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

חזרה

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

אישור

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

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

findText(searchPattern, from)

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

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

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

פרמטרים

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

חזרה

RangeElement – תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או 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 — צבע הרקע, בפורמט של סימון 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()

הפונקציה מאחזרת את היקף העמודות, שהוא מספר העמודות של תאי הטבלה שהתא הזה משתרע עליהן. לתאים שלא אוחדו יש רוחב עמודה של 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()

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

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 – הריווח הפנימי התחתון, בנקודות

אישור

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

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

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 — יישור אנכי

אישור

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

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

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

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

אישור

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

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

אישור

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

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

replaceText(searchPattern, replacement)

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

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

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

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

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

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

פרמטרים

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