רכיב שמייצג תא בטבלה. TableCell
נמצא תמיד בתוך TableRow
ועשוי להכיל רכיבים מסוג ListItem
, Paragraph
או Table
. למידע נוסף על מבנה מסמכים, קראו את המדריך להרחבת Google Docs.
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
appendHorizontalRule() | HorizontalRule | יצירה וצירוף של HorizontalRule חדש. |
appendImage(image) | InlineImage | יצירה וצירוף של InlineImage חדש מה-blob של התמונה שצוין. |
appendImage(image) | InlineImage | הפונקציה הזאת מצרפת את הערך InlineImage . |
appendListItem(listItem) | ListItem | הפונקציה הזאת מצרפת את הערך ListItem . |
appendListItem(text) | ListItem | יצירה וצירוף של ListItem חדש. |
appendParagraph(paragraph) | Paragraph | הפונקציה הזאת מצרפת את הערך Paragraph . |
appendParagraph(text) | Paragraph | יצירה וצירוף של Paragraph חדש. |
appendTable() | Table | יצירה וצירוף של Table חדש. |
appendTable(cells) | Table | הפונקציה הזאת מצרפת Table חדשה שמכילה את התאים שצוינו. |
appendTable(table) | Table | הפונקציה הזאת מצרפת את הערך Table . |
clear() | TableCell | ניקוי התוכן של הרכיב. |
copy() | TableCell | מחזירה עותק מנותק ועמוק של הרכיב הנוכחי. |
editAsText() | Text | משיג את גרסת Text של הרכיב הנוכחי, לצורך עריכה. |
findElement(elementType) | RangeElement | מחפשת צאצא מהסוג שצוין. |
findElement(elementType, from) | RangeElement | מחפשת בתוכן הרכיב צאצא מהסוג שצוין, החל מה-RangeElement שצוין. |
findText(searchPattern) | RangeElement | מחפש את תוכן הרכיב כדי לאתר את דפוס הטקסט שצוין באמצעות ביטויים רגולריים. |
findText(searchPattern, from) | RangeElement | מחפש את תוכן הרכיב לפי דפוס הטקסט שצוין, החל מתוצאת חיפוש נתונה. |
getAttributes() | Object | מאחזר את מאפייני הרכיב. |
getBackgroundColor() | String | מאחזר את צבע הרקע. |
getChild(childIndex) | Element | מאחזר את רכיב הצאצא באינדקס הצאצא שצוין. |
getChildIndex(child) | Integer | מאחזר את אינדקס הצאצא של רכיב הצאצא שצוין. |
getColSpan() | Integer | מאחזרת את טווח העמודות, שהוא מספר העמודות של תאי הטבלה שהתא הזה כולל. |
getLinkUrl() | String | אחזור של כתובת ה-URL של הקישור. |
getNextSibling() | Element | שולפת את הרכיב האח הבא של הרכיב. |
getNumChildren() | Integer | אחזור מספר הילדים. |
getPaddingBottom() | Number | מאחזר את המרווח התחתון התחתון, בנקודות. |
getPaddingLeft() | Number | מאחזר את המרווח הפנימי השמאלי, בנקודות. |
getPaddingRight() | Number | מאחזר את המרווח הפנימי הנכון, בנקודות. |
getPaddingTop() | Number | מאחזר את המרווח העליון, בנקודות. |
getParent() | ContainerElement | אחזור של רכיב ההורה של הרכיב. |
getParentRow() | TableRow | מאחזר את TableRow שמכיל את TableCell הנוכחי. |
getParentTable() | Table | מאחזר את Table שמכיל את TableCell הנוכחי. |
getPreviousSibling() | Element | אחזור הרכיב האח הקודם של הרכיב. |
getRowSpan() | Integer | מאחזרת את טווח השורות, שהוא מספר השורות של תאי הטבלה שהתא הזה כולל. |
getText() | String | מאחזר את התוכן של הרכיב כמחרוזת טקסט. |
getTextAlignment() | TextAlignment | הפונקציה הזו משיגה את היישור של הטקסט. |
getType() | ElementType | אחזור ה-ElementType של הרכיב. |
getVerticalAlignment() | VerticalAlignment | מאחזר את VerticalAlignment . |
getWidth() | Number | מחזירה את רוחב העמודה שמכילה את התא, בנקודות. |
insertHorizontalRule(childIndex) | HorizontalRule | יוצרת ומוסיפה HorizontalRule חדש באינדקס שצוין. |
insertImage(childIndex, image) | InlineImage | הפונקציה יוצרת ומוסיפה InlineImage מה-blob של התמונה שצוין, באינדקס
שצוין. |
insertImage(childIndex, image) | InlineImage | הפונקציה מוסיפה את הערך הנתון InlineImage באינדקס שצוין. |
insertListItem(childIndex, listItem) | ListItem | הפונקציה מוסיפה את הערך הנתון ListItem באינדקס שצוין. |
insertListItem(childIndex, text) | ListItem | יוצרת ומוסיפה ListItem חדש באינדקס שצוין. |
insertParagraph(childIndex, paragraph) | Paragraph | הפונקציה מוסיפה את הערך הנתון Paragraph באינדקס שצוין. |
insertParagraph(childIndex, text) | Paragraph | יוצרת ומוסיפה Paragraph חדש באינדקס שצוין. |
insertTable(childIndex) | Table | יוצרת ומוסיפה Table חדש באינדקס שצוין. |
insertTable(childIndex, cells) | Table | יוצרת ומוסיפה Table חדש שמכיל את התאים שצוינו, באינדקס שצוין. |
insertTable(childIndex, table) | Table | הפונקציה מוסיפה את הערך הנתון Table באינדקס שצוין. |
isAtDocumentEnd() | Boolean | קובע אם הרכיב נמצא בסוף Document . |
merge() | TableCell | ממזג את הרכיב עם האח הקודם מאותו הסוג. |
removeChild(child) | TableCell | מסיר את רכיב הצאצא שצוין. |
removeFromParent() | TableCell | מסיר את הרכיב מההורה שלו. |
replaceText(searchPattern, replacement) | Element | מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים. |
setAttributes(attributes) | TableCell | מגדיר את מאפייני הרכיב. |
setBackgroundColor(color) | TableCell | הגדרת צבע הרקע. |
setLinkUrl(url) | TableCell | מגדיר את כתובת האתר של הקישור. |
setPaddingBottom(paddingBottom) | TableCell | הגדרת המרווח הפנימי התחתון, בנקודות. |
setPaddingLeft(paddingLeft) | TableCell | מגדיר את המרווח השמאלי, בנקודות. |
setPaddingRight(paddingRight) | TableCell | הגדרת המרווח הפנימי הנכון, בנקודות. |
setPaddingTop(paddingTop) | TableCell | הגדרת המרווח העליון, בנקודות. |
setText(text) | TableCell | מגדיר את התוכן כטקסט פשוט. |
setTextAlignment(textAlignment) | TableCell | הגדרת יישור הטקסט. |
setVerticalAlignment(alignment) | TableCell | הגדרת היישור האנכי. |
setWidth(width) | TableCell | מגדירה את רוחב העמודה שמכילה את התא הנוכחי, בנקודות. |
תיעוד מפורט
appendHorizontalRule()
יצירה וצירוף של HorizontalRule
חדש.
ה-HorizontalRule
ייכלל ב-Paragraph
חדש.
החזרות
HorizontalRule
- הכלל האופקי החדש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
יצירה וצירוף של InlineImage
חדש מה-blob של התמונה שצוין.
ה-InlineImage
ייכלל ב-Paragraph
חדש.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
image | BlobSource | נתוני התמונה |
החזרות
InlineImage
– התמונה החדשה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
הפונקציה הזאת מצרפת את הערך InlineImage
.
ה-InlineImage
ייכלל ב-Paragraph
חדש.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
image | InlineImage | נתוני התמונה |
החזרות
InlineImage
– התמונה המצורפת
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(listItem)
הפונקציה הזאת מצרפת את הערך ListItem
.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
listItem | ListItem | את הפריט שצריך לצרף לרשימה |
החזרות
ListItem
- הפריט המצורף ברשימה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(text)
appendParagraph(paragraph)
הפונקציה הזאת מצרפת את הערך Paragraph
.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
paragraph | Paragraph | הפסקה שצריך לצרף |
החזרות
Paragraph
- הפסקה המצורפת
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
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
).
רכיבי צאצא שנכללים במלואם בטווח טקסט שנמחק, מוסרים מהרכיב.
var body = DocumentApp.getActiveDocument().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)
מחפשת צאצא מהסוג שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
elementType | ElementType | סוג הרכיב שיש לחפש |
החזרות
RangeElement
- תוצאת חיפוש שמציינת את המיקום של רכיב החיפוש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
מחפשת בתוכן הרכיב צאצא מהסוג שצוין, החל מה-RangeElement
שצוין.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
פרמטרים
שם | תיאור | התיאור |
---|---|---|
elementType | ElementType | סוג הרכיב שיש לחפש |
from | RangeElement | תוצאת החיפוש שממנה יש לחפש |
החזרות
RangeElement
- תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
מחפש את תוכן הרכיב כדי לאתר את דפוס הטקסט שצוין באמצעות ביטויים רגולריים.
אין תמיכה מלאה בקבוצת משנה של תכונות של ביטויים רגולריים ב-JavaScript, כמו קבוצות צילום ומגבילי מצב.
הדפוס של הביטוי הרגולרי שסופק מותאם בנפרד לכל גוש טקסט שכלול ברכיב הנוכחי.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
searchPattern | String | הדפוס שצריך לחפש |
החזרות
RangeElement
- תוצאת חיפוש שמציינת את מיקום הטקסט לחיפוש, או הערך null אם אין
התאמה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
מחפש את תוכן הרכיב לפי דפוס הטקסט שצוין, החל מתוצאת חיפוש נתונה.
אין תמיכה מלאה בקבוצת משנה של תכונות של ביטויים רגולריים ב-JavaScript, כמו קבוצות צילום ומגבילי מצב.
הדפוס של הביטוי הרגולרי שסופק מותאם בנפרד לכל גוש טקסט שכלול ברכיב הנוכחי.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
searchPattern | String | הדפוס שצריך לחפש |
from | RangeElement | תוצאת החיפוש שממנה יש לחפש |
החזרות
RangeElement
- תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או הערך null אם אין התאמה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
מאחזר את מאפייני הרכיב.
התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין חוקי של רכיב, כאשר כל
שם המאפיין תואם לפריט במונה DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
החזרות
Object
- מאפייני הרכיב.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getBackgroundColor()
מאחזר את צבע הרקע.
החזרות
String
- צבע הרקע, בפורמט של סימון CSS (כגון '#ffffff'
)
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
מאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. var firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText("This is the first paragraph."); }
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | 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()
מאחזרת את טווח העמודות, שהוא מספר העמודות של תאי הטבלה שהתא הזה כולל. בתאים שלא ממוזגים יש טווח עמודות של 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()
getNumChildren()
אחזור מספר הילדים.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document 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()
getParentTable()
getPreviousSibling()
getRowSpan()
מאחזרת את טווח השורות, שהוא מספר השורות של תאי הטבלה שהתא הזה כולל. בתאים שלא ממוזגים יש טווח שורות של 1.
החזרות
Integer
- הטווח של תא בשורה או 0 של תא אחר
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getText()
מאחזר את התוכן של הרכיב כמחרוזת טקסט.
החזרות
String
- תוכן הרכיב כמחרוזת טקסט
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
הפונקציה הזו משיגה את היישור של הטקסט. סוגי ההתאמה הזמינים הם DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
ו-DocumentApp.TextAlignment.SUPERSCRIPT
.
החזרות
TextAlignment
— סוג היישור של הטקסט. לחלופין, null
אם הטקסט מכיל סוגים שונים של יישור טקסט או אם יישור הטקסט מעולם לא הוגדר
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
אחזור ה-ElementType
של הרכיב.
השתמשו בפונקציה getType()
כדי לקבוע את הסוג המדויק של רכיב נתון.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
החזרות
ElementType
- סוג הרכיב.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getVerticalAlignment()
מאחזר את VerticalAlignment
.
החזרות
VerticalAlignment
– היישור האנכי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getWidth()
מחזירה את רוחב העמודה שמכילה את התא, בנקודות.
החזרות
Number
– רוחב העמודה, בנקודות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
יוצרת ומוסיפה HorizontalRule
חדש באינדקס שצוין.
הכלל האופקי ייכלל ב-Paragraph
חדש.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
החזרות
HorizontalRule
- הכלל האופקי החדש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
הפונקציה יוצרת ומוסיפה InlineImage
מה-blob של התמונה שצוין, באינדקס
שצוין.
התמונה תצורף ל-Paragraph
חדש.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
image | BlobSource | נתוני התמונה |
החזרות
InlineImage
– התמונה המוטבעת שהוכנסה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
הפונקציה מוסיפה את הערך הנתון InlineImage
באינדקס שצוין.
התמונה תצורף ל-Paragraph
חדש.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
image | InlineImage | התמונה להוספה |
החזרות
InlineImage
– התמונה המוטבעת שהוכנסה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
הפונקציה מוסיפה את הערך הנתון ListItem
באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
listItem | ListItem | פריט הרשימה להוספה |
החזרות
ListItem
– נוסף פריט חדש לרשימה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, text)
יוצרת ומוסיפה ListItem
חדש באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
text | String | תוכן הטקסט |
החזרות
ListItem
– הפריט החדש ברשימה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, paragraph)
הפונקציה מוסיפה את הערך הנתון Paragraph
באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
paragraph | Paragraph | הפסקה שיש להוסיף |
החזרות
Paragraph
– הפסקה שהוכנסה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
יוצרת ומוסיפה Paragraph
חדש באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
text | String | תוכן הטקסט |
החזרות
Paragraph
- הפסקה החדשה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex)
יוצרת ומוסיפה Table
חדש באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
החזרות
Table
– הטבלה החדשה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, cells)
יוצרת ומוסיפה Table
חדש שמכיל את התאים שצוינו, באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שיש להכניס |
cells | String[][] | תוכן הטקסט של תאי הטבלה להוספה לטבלה החדשה |
החזרות
Table
– הטבלה החדשה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, table)
הפונקציה מוסיפה את הערך הנתון Table
באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
table | Table | הטבלה להוספה |
החזרות
Table
– הטבלה שהוכנסה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
merge()
ממזג את הרכיב עם האח הקודם מאותו הסוג.
אפשר למזג רק רכיבים של אותו ElementType
. כל רכיבי הצאצא שנכללים ברכיב הנוכחי מועברים אל הרכיב האח הקודם.
הרכיב הנוכחי יוסר מהמסמך.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
החזרות
TableCell
- הרכיב שמוזג.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
removeFromParent()
מסיר את הרכיב מההורה שלו.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
החזרות
TableCell
- הרכיב שהוסר.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים.
דפוס החיפוש מועבר כמחרוזת, ולא כאובייקט של ביטוי רגולרי ב-JavaScript. לכן, תצטרכו להשתמש בתו בריחה (escape) של כל לוכסן הפוך בתבנית.
בשיטה הזו נעשה שימוש בספריית הביטויים הרגולריים RE2 של Google, שמגבילה את התחביר הנתמך.
הדפוס של הביטוי הרגולרי שסופק מותאם בנפרד לכל גוש טקסט שכלול ברכיב הנוכחי.
var body = DocumentApp.getActiveDocument().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
פרמטרים
שם | תיאור | התיאור |
---|---|---|
searchPattern | String | את הדפוס הרגולרי שצריך לחפש |
replacement | String | בטקסט שישמש כתחליף |
החזרות
Element
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
מגדיר את מאפייני הרכיב.
פרמטר המאפיינים שצוין חייב להיות אובייקט שבו כל שם מאפיין הוא פריט
בספירה של DocumentApp.Attribute
וכל ערך של מאפיין הוא הערך החדש שיש להחיל.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
פרמטרים
שם | תיאור | התיאור |
---|---|---|
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)
הגדרת המרווח הפנימי התחתון, בנקודות.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
paddingBottom | Number | המרווח התחתון, בנקודות |
החזרות
TableCell
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPaddingLeft(paddingLeft)
setPaddingRight(paddingRight)
הגדרת המרווח הפנימי הנכון, בנקודות.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
paddingRight | Number | המרווח הנכון, בנקודות. |
החזרות
TableCell
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setPaddingTop(paddingTop)
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 be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
פרמטרים
שם | תיאור | התיאור |
---|---|---|
textAlignment | TextAlignment | סוג היישור של הטקסט שצריך להחיל |
החזרות
TableCell
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setVerticalAlignment(alignment)
הגדרת היישור האנכי.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
alignment | VerticalAlignment | היישור האנכי |
החזרות
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