רכיב שמייצג תא בטבלה. רכיב TableCell תמיד נמצא בתוך רכיב TableRow, והוא יכול להכיל רכיבים מסוג ListItem, Paragraph או Table. מידע נוסף על מבנה המסמך זמין במדריך להרחבת Google Docs.
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
append | Horizontal | יוצרת Horizontal חדש ומצרפת אותו. |
append | Inline | יוצר ומצרף Inline חדש מבלוב התמונה שצוין. |
append | Inline | הוספה של Inline. |
append | List | הוספה של List. |
append | List | יוצרת List חדש ומצרפת אותו. |
append | Paragraph | הוספה של Paragraph. |
append | Paragraph | יוצרת Paragraph חדש ומצרפת אותו. |
append | Table | יוצרת Table חדש ומצרפת אותו. |
append | Table | מוסיף בסוף את התאים שצוינו בתוך תג Table חדש. |
append | Table | הוספה של Table. |
clear() | Table | מחיקת התוכן של הרכיב. |
copy() | Table | הפונקציה מחזירה עותק מנותק ועמוק של הרכיב הנוכחי. |
edit | Text | מקבלים גרסה Text של הרכיב הנוכחי לצורך עריכה. |
find | Range | מחפש בתוכן של הרכיב צאצא מסוג מסוים. |
find | Range | הפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRange שצוין. |
find | Range | מחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים. |
find | Range | מחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה. |
get | Object | מאחזר את המאפיינים של האלמנט. |
get | String|null | מחזירה את צבע הרקע. |
get | Element | מאחזר את רכיב הצאצא באינדקס הצאצא שצוין. |
get | Integer | מאחזר את אינדקס הצאצא של רכיב הצאצא שצוין. |
get | Integer | מאחזרת את טווח העמודות, שהוא מספר העמודות של תאי הטבלה שהתא הזה משתרע עליהן. |
get | String|null | הפונקציה מחזירה את כתובת ה-URL של הקישור. |
get | Element|null | מאחזר את רכיב האח הבא של הרכיב. |
get | Integer | מאחזר את מספר הילדים. |
get | Number|null | מאחזר את המרווח הפנימי התחתון, בנקודות. |
get | Number|null | מאחזר את המרווח הפנימי השמאלי, בנקודות. |
get | Number|null | הפונקציה מחזירה את המרווח הפנימי הימני, בנקודות. |
get | Number|null | מאחזר את המרווח הפנימי העליון, בנקודות. |
get | Container | מאחזר את רכיב ההורה של הרכיב. |
get | Table | אחזור Table שמכיל את Table הנוכחי. |
get | Table|null | אחזור Table שמכיל את Table הנוכחי. |
get | Element|null | אחזור של רכיב האחות הקודם של הרכיב. |
get | Integer | מאחזר את מספר השורות שהתא הזה משתרע עליהן בטבלה. |
get | String | מאחזרת את התוכן של הרכיב כמחרוזת טקסט. |
get | Text | מחזירה את יישור הטקסט. |
get | Element | אחזור Element של הרכיב. |
get | Vertical | מאחזר את Vertical. |
get | Number|null | הפונקציה מאחזרת את רוחב העמודה שמכילה את התא, בנקודות. |
insert | Horizontal | יוצרת ומכניסה אובייקט Horizontal חדש באינדקס שצוין. |
insert | Inline | יוצרת ומכניסה Inline מבלוב התמונה שצוין, באינדקס שצוין. |
insert | Inline | הפונקציה מוסיפה את Inline שצוין באינדקס שצוין. |
insert | List | הפונקציה מוסיפה את List שצוין באינדקס שצוין. |
insert | List | יוצרת ומכניסה אובייקט List חדש באינדקס שצוין. |
insert | Paragraph | הפונקציה מוסיפה את Paragraph שצוין באינדקס שצוין. |
insert | Paragraph | יוצרת ומכניסה אובייקט Paragraph חדש באינדקס שצוין. |
insert | Table | יוצרת ומכניסה אובייקט Table חדש באינדקס שצוין. |
insert | Table | הפונקציה יוצרת תא חדש Table שמכיל את התאים שצוינו, ומכניסה אותו לאינדקס שצוין. |
insert | Table | הפונקציה מוסיפה את Table שצוין באינדקס שצוין. |
is | Boolean | קובע אם הרכיב נמצא בסוף Document. |
merge() | Table | מיזוג הרכיב עם הרכיב הקודם מאותו סוג. |
remove | Table | הסרת רכיב הבן שצוין. |
remove | Table | הפונקציה מסירה את הרכיב מהרכיב ההורה שלו. |
replace | Element | הפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים. |
set | Table | הגדרת המאפיינים של האלמנט. |
set | Table | הגדרת צבע הרקע. |
set | Table | מגדיר את כתובת ה-URL של הקישור. |
set | Table | הגדרת המרווח הפנימי התחתון, בנקודות. |
set | Table | הגדרה של המרווח הפנימי השמאלי, בנקודות. |
set | Table | הגדרה של המרווח הפנימי הימני, בנקודות. |
set | Table | הגדרת המרווח הפנימי העליון, בנקודות. |
set | Table | הגדרת התוכן כטקסט פשוט. |
set | Table | הגדרת יישור הטקסט. |
set | Table | הגדרת היישור האנכי. |
set | Table | מגדירה את רוחב העמודה שמכילה את התא הנוכחי, בנקודות. |
תיעוד מפורט
appendHorizontalRule()
יוצרת HorizontalRule חדש ומצרפת אותו.
התג HorizontalRule ייכלל בתג Paragraph חדש.
חזרה
HorizontalRule – הקו האופקי החדש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendImage(image)
יוצר ומצרף InlineImage חדש מבלוב התמונה שצוין.
התג InlineImage ייכלל בתג Paragraph חדש.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
image | Blob | נתוני התמונה |
חזרה
InlineImage — התמונה החדשה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendImage(image)
הוספה של InlineImage.
התג InlineImage ייכלל בתג Paragraph חדש.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
image | Inline | נתוני התמונה |
חזרה
InlineImage – התמונה שנוספה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendListItem(listItem)
appendListItem(text)
appendParagraph(paragraph)
appendParagraph(text)
appendTable()
appendTable(cells)
מוסיף בסוף את התאים שצוינו בתוך תג Table חדש.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
cells | String[][] | תוכן הטקסט של תאי הטבלה שרוצים להוסיף לטבלה החדשה |
חזרה
Table – הטבלה שצורפה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendTable(table)
clear()
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)
מחפש בתוכן של הרכיב צאצא מסוג מסוים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
element | Element | סוג הרכיב לחיפוש. |
חזרה
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; } }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
element | Element | סוג הרכיב לחיפוש. |
from | Range | תוצאת החיפוש שממנה מתחילים את החיפוש. |
חזרה
RangeElement|null — תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findText(searchPattern)
מחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
קבוצת משנה של תכונות הביטוי הרגולרי של JavaScript לא נתמכות באופן מלא, כמו קבוצות לכידה ומשני מצב.
תבנית הביטוי הרגולרי שצוינה מושווית באופן עצמאי לכל בלוק טקסט שנכלל ברכיב הנוכחי.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
search | String | התבנית לחיפוש |
חזרה
RangeElement|null – תוצאת חיפוש שמציינת את המיקום של טקסט החיפוש, או null אם אין התאמה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
מחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
קבוצת משנה של תכונות הביטוי הרגולרי של JavaScript לא נתמכות באופן מלא, כמו קבוצות לכידה ומשני מצב.
תבנית הביטוי הרגולרי שצוינה מושווית באופן עצמאי לכל בלוק טקסט שנכלל ברכיב הנוכחי.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
search | String | התבנית לחיפוש |
from | Range | תוצאת החיפוש שממנה רוצים לחפש |
חזרה
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.'); }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס של רכיב הצאצא לאחזור. |
חזרה
Element – רכיב הצאצא באינדקס שצוין.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getChildIndex(child)
מאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Element | רכיב הצאצא שעבורו רוצים לאחזר את האינדקס. |
חזרה
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()
getParentTable()
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 חדש.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
חזרה
HorizontalRule – הקו האופקי החדש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
יוצרת ומכניסה InlineImage מבלוב התמונה שצוין, באינדקס שצוין.
התמונה תהיה בתוך תג Paragraph חדש.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
image | Blob | נתוני התמונה |
חזרה
InlineImage — התמונה המוטמעת שהוכנסה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
הפונקציה מוסיפה את InlineImage שצוין באינדקס שצוין.
התמונה תהיה בתוך תג Paragraph חדש.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
image | Inline | התמונה שרוצים להוסיף |
חזרה
InlineImage — התמונה המוטמעת שהוכנסה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
הפונקציה מוסיפה את ListItem שצוין באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
list | List | הפריט ברשימה שרוצים להוסיף |
חזרה
ListItem — נוסף פריט חדש לרשימה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertListItem(childIndex, text)
יוצרת ומכניסה אובייקט ListItem חדש באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
text | String | תוכן הטקסט |
חזרה
ListItem – הפריט החדש ברשימה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, paragraph)
הפונקציה מוסיפה את Paragraph שצוין באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
paragraph | Paragraph | הפסקה שרוצים להוסיף |
חזרה
Paragraph — הפסקה שנוספה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
יוצרת ומכניסה אובייקט Paragraph חדש באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
text | String | תוכן הטקסט |
חזרה
Paragraph – הפיסקה החדשה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertTable(childIndex)
יוצרת ומכניסה אובייקט Table חדש באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
חזרה
Table — הטבלה החדשה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertTable(childIndex, cells)
הפונקציה יוצרת תא חדש Table שמכיל את התאים שצוינו, ומכניסה אותו לאינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הערך |
cells | String[][] | תוכן הטקסט של תאי הטבלה שרוצים להוסיף לטבלה החדשה |
חזרה
Table — הטבלה החדשה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertTable(childIndex, table)
הפונקציה מוסיפה את Table שצוין באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
table | Table | הטבלה שרוצים להוסיף |
חזרה
Table – הטבלה שנוספה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
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)
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');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
search | String | תבנית הביטוי הרגולרי לחיפוש |
replacement | String | הטקסט שבו רוצים להשתמש להחלפה |
חזרה
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);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
attributes | Object | המאפיינים של האלמנט. |
חזרה
TableCell – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setBackgroundColor(color)
הגדרת צבע הרקע.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
color | String | צבע הרקע, בפורמט של סימון CSS (לדוגמה, '#ffffff') |
חזרה
TableCell – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setLinkUrl(url)
setPaddingBottom(paddingBottom)
הגדרת המרווח הפנימי התחתון, בנקודות.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
padding | Number | המרווח הפנימי התחתון, בנקודות |
חזרה
TableCell – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setPaddingLeft(paddingLeft)
הגדרה של המרווח הפנימי השמאלי, בנקודות.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
padding | Number | המרווח הפנימי השמאלי, בנקודות |
חזרה
TableCell – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setPaddingRight(paddingRight)
הגדרה של המרווח הפנימי הימני, בנקודות.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
padding | Number | המרווח הפנימי הימני, בנקודות. |
חזרה
TableCell – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setPaddingTop(paddingTop)
הגדרת המרווח הפנימי העליון, בנקודות.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
padding | Number | המרווח הפנימי העליון, בנקודות |
חזרה
TableCell – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setText(text)
הגדרת התוכן כטקסט פשוט.
הערה: התוכן הקיים יימחק.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
text | String | התוכן של הטקסט החדש |
חזרה
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);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
text | Text | סוג יישור הטקסט שרוצים להחיל |
חזרה
TableCell – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setVerticalAlignment(alignment)
הגדרת היישור האנכי.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
alignment | Vertical | היישור האנכי |
חזרה
TableCell – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setWidth(width)
מגדירה את רוחב העמודה שמכילה את התא הנוכחי, בנקודות.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
width | Number | רוחב העמודה, בנקודות |
חזרה
TableCell – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents