רכיב שמייצג תא בטבלה. רכיב Table
תמיד נמצא בתוך רכיב Table
, ויכול להכיל רכיבים מסוג List
, Paragraph
או Table
. למידע נוסף על מבנה המסמך, קראו את המדריך להרחבת Google Docs.
Methods
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
append | Horizontal | יצירת Horizontal חדש והוספתו. |
append | Inline | יצירת Inline חדש והוספתו לקובץ ה-blob של התמונה שצוין. |
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 | אחזור של צבע הרקע. |
get | Element | אחזור רכיב הצאצא לפי אינדקס הצאצא שצוין. |
get | Integer | אחזור של מדד הצאצא של רכיב הצאצא שצוין. |
get | Integer | הפונקציה מאחזרת את היקף העמודות, שהוא מספר העמודות של תאי הטבלה שהתא הזה משתרע עליהן. |
get | String | אחזור כתובת ה-URL של הקישור. |
get | Element | אחזור הרכיב הבא של הרכיב. |
get | Integer | אחזור מספר הילדים. |
get | Number | אחזור המרווח הפנימי התחתון, בנקודות. |
get | Number | אחזור המרווח הפנימי השמאלי, בנקודות. |
get | Number | אחזור של המרווח הפנימי הימני, בנקודות. |
get | Number | אחזור של המרווח הפנימי העליון, בנקודות. |
get | Container | אחזור של רכיב ההורה של האלמנט. |
get | Table | אחזור ה-Table שמכיל את ה-Table הנוכחי. |
get | Table | אחזור ה-Table שמכיל את ה-Table הנוכחי. |
get | Element | אחזור של רכיב האח הקודם של הרכיב. |
get | Integer | הפונקציה מאחזרת את היקף השורות, שהוא מספר השורות של תאי הטבלה שהתא הזה משתרע עליהן. |
get | String | אחזור התוכן של הרכיב כמחרוזת טקסט. |
get | Text | הפונקציה מקבלת את יישור הטקסט. |
get | Element | אחזור הערך של Element ברכיב. |
get | Vertical | אחזור של Vertical . |
get | Number | הפונקציה מאחזרת את רוחב העמודה שמכילה את התא, בנקודות. |
insert | Horizontal | יצירת Horizontal חדשה והוספתה למיקום המסומן. |
insert | Inline | יצירת Inline והוספתו מ-blob התמונה שצוין, במדד שצוין. |
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 | הגדרת רוחב העמודה שמכילה את התא הנוכחי, בנקודות. |
מסמכים מפורטים
append Horizontal Rule()
יצירת Horizontal
חדש והוספתו.
ה-Horizontal
ייכלל ב-Paragraph
חדש.
חזרה
Horizontal
— הקו האופקי החדש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Image(image)
יצירת Inline
חדש והוספתו לקובץ ה-blob של התמונה שצוין.
ה-Inline
ייכלל ב-Paragraph
חדש.
פרמטרים
שם | סוג | תיאור |
---|---|---|
image | Blob | נתוני התמונה |
חזרה
Inline
– התמונה החדשה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Image(image)
הוספה של Inline
הנתון.
ה-Inline
ייכלל ב-Paragraph
חדש.
פרמטרים
שם | סוג | תיאור |
---|---|---|
image | Inline | נתוני התמונה |
חזרה
Inline
– התמונה שצורפה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append List Item(listItem)
הוספה של List
הנתון.
פרמטרים
שם | סוג | תיאור |
---|---|---|
list | List | הפריט ברשימה שרוצים לצרף |
חזרה
List
– הפריט ברשימה שנוסף
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append List Item(text)
יצירת List
חדש והוספתו.
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | String | תוכן הטקסט |
חזרה
List
– הפריט החדש ברשימה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Paragraph(paragraph)
הוספה של Paragraph
הנתון.
פרמטרים
שם | סוג | תיאור |
---|---|---|
paragraph | Paragraph | הפסקה שרוצים לצרף |
חזרה
Paragraph
– הפסקה שנוספה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Paragraph(text)
יצירת Paragraph
חדש והוספתו.
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | String | תוכן הטקסט |
חזרה
Paragraph
– הפיסקה החדשה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Table()
יצירת Table
חדש והוספתו.
חזרה
Table
– הטבלה החדשה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Table(cells)
הוספת Table
חדש שמכיל את התאים שצוינו.
פרמטרים
שם | סוג | תיאור |
---|---|---|
cells | String[][] | תוכן הטקסט של תאי הטבלה שרוצים להוסיף לטבלה החדשה |
חזרה
Table
– הטבלה שנוספה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Table(table)
הוספה של Table
הנתון.
פרמטרים
שם | סוג | תיאור |
---|---|---|
table | Table | הטבלה שרוצים לצרף |
חזרה
Table
– הטבלה שנוספה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
הפונקציה מחזירה עותק מנותק ומעמיק של הרכיב הנוכחי.
כל אלמנטי הצאצא שנמצאים באלמנט יועתקו גם כן. לאלמנט החדש אין הורה.
חזרה
Table
– העותק החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
edit As Text()
הצגת גרסת Text
של הרכיב הנוכחי לצורך עריכה.
משתמשים ב-edit
כדי לבצע פעולות על תוכן הרכיבים כטקסט עשיר. במצב edit
המערכת מתעלמת מאלמנטים שאינם טקסט (כמו Inline
ו-Horizontal
).
רכיבי צאצא שנכללים במלואם בטווח הטקסט שנמחק יוסרו מהרכיב.
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
— גרסה טקסטואלית של הרכיב הנוכחי
find Element(elementType)
חיפוש בתוכן של הרכיב אחר צאצא מהסוג שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
element | Element | סוג הרכיב שרוצים לחפש. |
חזרה
Range
— תוצאת חיפוש שמציינת את המיקום של רכיב החיפוש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Element(elementType, from)
הפונקציה מחפשת בתוכן של הרכיב צאצא מהסוג שצוין, החל מ-Range
שצוין.
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 | תוצאת החיפוש שממנה רוצים לבצע חיפוש. |
חזרה
Range
— תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern)
חיפוש דפוס הטקסט שצוין בתוכן של האלמנט באמצעות ביטויים רגולריים.
אין תמיכה מלאה בקבוצת משנה של תכונות הביטויים הרגולריים של JavaScript, כמו קבוצות תיעוד (capture groups) ומשתני שינוי מצב (mode modifiers).
תבנית הביטוי הרגולרי שצוינה מותאמת בנפרד לכל בלוק טקסט שמכיל את הרכיב הנוכחי.
פרמטרים
שם | סוג | תיאור |
---|---|---|
search | String | הדפוס שרוצים לחפש |
חזרה
Range
– תוצאת חיפוש שמציינת את המיקום של טקסט החיפוש, או null אם אין התאמה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern, from)
חיפוש של דפוס הטקסט שצוין בתוכן הרכיב, החל מתוצאת חיפוש נתונה.
אין תמיכה מלאה בקבוצת משנה של תכונות הביטויים הרגולריים של JavaScript, כמו קבוצות תיעוד (capture groups) ומשתני שינוי מצב (mode modifiers).
תבנית הביטוי הרגולרי שצוינה מותאמת בנפרד לכל בלוק טקסט שמכיל את הרכיב הנוכחי.
פרמטרים
שם | סוג | תיאור |
---|---|---|
search | String | הדפוס שרוצים לחפש |
from | Range | תוצאת החיפוש שבה רוצים לבצע חיפוש |
חזרה
Range
– תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או null אם אין התאמה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Attributes()
אחזור המאפיינים של האלמנט.
התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין רכיב תקין, כאשר כל שם מאפיין תואם לפריט בספירה Document
.
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
get Background Color()
אחזור של צבע הרקע.
חזרה
String
— צבע הרקע, בפורמט של סימון CSS (כמו '#ffffff'
)
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Child(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
get Child Index(child)
אחזור של מדד הצאצא של רכיב הצאצא שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Element | רכיב הצאצא שעבורו רוצים לאחזר את האינדקס. |
חזרה
Integer
— האינדקס של הצאצא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Col Span()
הפונקציה מאחזרת את היקף העמודות, שהוא מספר העמודות של תאי הטבלה שהתא הזה משתרע עליהן. לתאים שלא אוחדו יש רוחב עמודה של 1.
חזרה
Integer
– היקף העמודה או 0 לתא שמוזג עם תא אחר
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Link Url()
אחזור כתובת ה-URL של הקישור.
חזרה
String
– כתובת ה-URL של הקישור, או null אם הרכיב מכיל כמה ערכים למאפיין הזה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Next Sibling()
אחזור הרכיב הבא של הרכיב.
לרכיב האח הבא יש אותו הורה והוא מופיע אחרי הרכיב הנוכחי.
חזרה
Element
– רכיב האח הבא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Num Children()
אחזור מספר הילדים.
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
get Padding Bottom()
אחזור המרווח הפנימי התחתון, בנקודות.
חזרה
Number
– הריווח הפנימי התחתון, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Padding Left()
אחזור המרווח הפנימי השמאלי, בנקודות.
חזרה
Number
– המרווח הפנימי השמאלי, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Padding Right()
אחזור של המרווח הפנימי הימני, בנקודות.
חזרה
Number
– המרווח הפנימי הימני, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Padding Top()
אחזור של המרווח הפנימי העליון, בנקודות.
חזרה
Number
– המרווח הפנימי העליון, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Parent()
אחזור של רכיב ההורה של האלמנט.
רכיב ההורה מכיל את הרכיב הנוכחי.
חזרה
Container
– רכיב ההורה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Parent Row()
אחזור ה-Table
שמכיל את ה-Table
הנוכחי.
חזרה
Table
— שורת הטבלה שמכילה את התא הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Parent Table()
אחזור ה-Table
שמכיל את ה-Table
הנוכחי.
חזרה
Table
– הטבלה שמכילה את התא הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Previous Sibling()
אחזור של רכיב האח הקודם של הרכיב.
לרכיב האח הקודם יש אותו הורה והוא מופיע לפני הרכיב הנוכחי.
חזרה
Element
— רכיב האח/ה הקודם.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Row Span()
הפונקציה מאחזרת את היקף השורות, שהוא מספר השורות של תאי הטבלה שהתא הזה משתרע עליהן. לתאים לא ממוזגים יש רוחב שורה של 1.
חזרה
Integer
– היקף השורה או 0 לתא שמוזג עם תא אחר
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text()
אחזור התוכן של הרכיב כמחרוזת טקסט.
חזרה
String
– התוכן של הרכיב כמחרוזת טקסט
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text Alignment()
הפונקציה מקבלת את יישור הטקסט. סוגי ההתאמה הזמינים הם Document
, Document
ו-Document
.
חזרה
Text
– סוג היישור של הטקסט, או null
אם הטקסט מכיל כמה סוגים של יישור טקסט או אם יישור הטקסט מעולם לא הוגדר
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Type()
אחזור הערך של Element
ברכיב.
אפשר להשתמש ב-get
כדי לקבוע את הסוג המדויק של רכיב נתון.
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.'); }
חזרה
Element
– סוג הרכיב.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Vertical Alignment()
אחזור של Vertical
.
חזרה
Vertical
— יישור אנכי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Width()
הפונקציה מאחזרת את רוחב העמודה שמכילה את התא, בנקודות.
חזרה
Number
– רוחב העמודה, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Horizontal Rule(childIndex)
יצירת Horizontal
חדשה והוספתה למיקום המסומן.
הקו האנכי ייכלל ב-Paragraph
חדש.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
חזרה
Horizontal
— הקו האופקי החדש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Image(childIndex, image)
יצירת Inline
והוספתו מ-blob התמונה שצוין, במדד שצוין.
התמונה תהיה ב-Paragraph
חדש.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
image | Blob | נתוני התמונה |
חזרה
Inline
– התמונה בתוך השורה שהוכנסה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Image(childIndex, image)
הוספת Inline
הנתון באינדקס שצוין.
התמונה תהיה ב-Paragraph
חדש.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
image | Inline | התמונה שרוצים להוסיף |
חזרה
Inline
– התמונה בתוך השורה שהוכנסה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert List Item(childIndex, listItem)
הוספת List
הנתון באינדקס שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
list | List | פריט הרשימה שרוצים להוסיף |
חזרה
List
— הוספה של פריט חדש לרשימה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert List Item(childIndex, text)
יצירת List
חדשה והוספתה למיקום המסומן.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
text | String | תוכן הטקסט |
חזרה
List
– הפריט החדש ברשימה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Paragraph(childIndex, paragraph)
הוספת Paragraph
הנתון באינדקס שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
paragraph | Paragraph | הפסקה שרוצים להוסיף |
חזרה
Paragraph
– הפסקה שנוספה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Paragraph(childIndex, text)
יצירת Paragraph
חדשה והוספתה למיקום המסומן.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
text | String | תוכן הטקסט |
חזרה
Paragraph
– הפיסקה החדשה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Table(childIndex)
יצירת Table
חדשה והוספתה למיקום המסומן.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
חזרה
Table
– הטבלה החדשה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Table(childIndex, cells)
יצירת Table
חדש שמכיל את התאים שצוינו, והוספה שלו למיקום שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הפריט |
cells | String[][] | תוכן הטקסט של תאי הטבלה שרוצים להוסיף לטבלה החדשה |
חזרה
Table
– הטבלה החדשה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Table(childIndex, table)
הוספת Table
הנתון באינדקס שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
table | Table | הטבלה להוספה |
חזרה
Table
– הטבלה שנוספה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
is At Document End()
הפונקציה קובעת אם הרכיב נמצא בסוף ה-Document
.
חזרה
Boolean
— אם הרכיב נמצא בסוף הכרטיסייה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
מיזוג הרכיב עם האח/ה הקודם/ה מאותו סוג.
אפשר למזג רק רכיבים מאותו Element
. כל רכיבי הצאצאים שמכיל הרכיב הנוכחי מועברים לרכיב האח הקודם.
הרכיב הנוכחי יוסר מהמסמך.
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();
חזרה
Table
– הרכיב הממוזג.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Child(child)
הסרה של רכיב הבן שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Element | רכיב הצאצא שרוצים להסיר |
חזרה
Table
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove From Parent()
הסרת הרכיב מהרכיב ההורה שלו.
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(); }
חזרה
Table
– הרכיב שהוסרה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replace Text(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');
פרמטרים
שם | סוג | תיאור |
---|---|---|
search | String | דפוס הביטוי הרגולרי לחיפוש |
replacement | String | הטקסט שישמש להחלפה |
חזרה
Element
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Attributes(attributes)
הגדרת המאפיינים של האלמנט.
פרמטר המאפיינים שצוין חייב להיות אובייקט שבו כל שם מאפיין הוא פריט בספירה של Document
וכל ערך מאפיין הוא הערך החדש שרוצים להחיל.
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 | המאפיינים של האלמנט. |
חזרה
Table
– הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Background Color(color)
הגדרת צבע הרקע.
פרמטרים
שם | סוג | תיאור |
---|---|---|
color | String | צבע הרקע, בפורמט של סימון CSS (כמו '#ffffff' ) |
חזרה
Table
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Link Url(url)
הגדרת כתובת ה-URL של הקישור.
פרמטרים
שם | סוג | תיאור |
---|---|---|
url | String | כתובת ה-URL של הקישור |
חזרה
Table
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Padding Bottom(paddingBottom)
הגדרת המרווח הפנימי התחתון, בנקודות.
פרמטרים
שם | סוג | תיאור |
---|---|---|
padding | Number | המרווח הפנימי התחתון, בנקודות |
חזרה
Table
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Padding Left(paddingLeft)
הגדרת המרווח הפנימי השמאלי, בפונטים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
padding | Number | המרווח הפנימי השמאלי, בנקודות |
חזרה
Table
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Padding Right(paddingRight)
הגדרת המרווח הפנימי הימני, בנקודות.
פרמטרים
שם | סוג | תיאור |
---|---|---|
padding | Number | המרווח הפנימי הימני, בנקודות. |
חזרה
Table
– הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Padding Top(paddingTop)
הגדרת המרווח הפנימי העליון, בנקודות.
פרמטרים
שם | סוג | תיאור |
---|---|---|
padding | Number | המרווח הפנימי העליון, בנקודות |
חזרה
Table
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text(text)
הגדרת התוכן כטקסט פשוט.
הערה: התוכן הקיים יימחק.
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | String | תוכן הטקסט החדש |
חזרה
Table
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text Alignment(textAlignment)
הגדרת יישור הטקסט. סוגי ההתאמה הזמינים הם Document
, Document
ו-Document
.
// 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 | סוג יישור הטקסט שרוצים להחיל |
חזרה
Table
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Vertical Alignment(alignment)
הגדרת היישור האנכי.
פרמטרים
שם | סוג | תיאור |
---|---|---|
alignment | Vertical | יישור אנכי |
חזרה
Table
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Width(width)
הגדרת רוחב העמודה שמכילה את התא הנוכחי, בנקודות.
פרמטרים
שם | סוג | תיאור |
---|---|---|
width | Number | רוחב העמודה, בנקודות |
חזרה
Table
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents