רכיב שמייצג פריט ברשימה. List
הוא Paragraph
שמשויך למזהה רשימה. רכיב List
יכול להכיל את הרכיבים Equation
, Footnote
, Horizontal
, Inline
, Inline
, Page
ו-Text
. מידע נוסף על מבנה המסמך זמין במדריך להרחבת Google Docs.
List
לא יכול להכיל תווים של מעבר לשורה חדשה. תווים של שורה חדשה ("\n") מומרים לתווים של מעבר שורה ("\r").
List
עם אותו מזהה רשימה שייכים לאותה רשימה וממוספרים בהתאם.
לא חובה שהמאפיינים List
של רשימה מסוימת יהיו צמודים בכרטיסייה, או שיהיה להם אותו רכיב הורה. שני פריטים ששייכים לאותה רשימה יכולים להופיע בכל מקום בכרטיסייה, תוך שמירה על מספרות רצופת, כפי שמוצג בדוגמה הבאה:
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a new list item to the body. const item1 = body.appendListItem('Item 1'); // Log the new list item's list ID. Logger.log(item1.getListId()); // Append a table after the list item. body.appendTable([['Cell 1', 'Cell 2']]); // Append a second list item with the same list ID. The two items are treated as // the same list, despite not being consecutive. const item2 = body.appendListItem('Item 2'); item2.setListId(item1);
Methods
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
add | Positioned | יצירת Positioned חדשה והוספה שלה מה-blob של התמונה שצוין. |
append | Horizontal | יצירת Horizontal חדש והוספתו. |
append | Inline | יצירת Inline חדש והוספתו לקובץ ה-blob של התמונה שצוין. |
append | Inline | הוספה של Inline הנתון. |
append | Page | יצירת Page חדש והוספתו. |
append | Page | הוספה של Page הנתון. |
append | Text | יצירת רכיב Text חדש והוספת התוכן שצוין אליו. |
append | Text | הוספת האלמנט Text הנתון. |
clear() | List | ניקוי התוכן של הרכיב. |
copy() | List | הפונקציה מחזירה עותק מנותק ומעמיק של הרכיב הנוכחי. |
edit | Text | הצגת גרסת Text של הרכיב הנוכחי לצורך עריכה. |
find | Range | חיפוש בתוכן של הרכיב אחר צאצא מהסוג שצוין. |
find | Range | הפונקציה מחפשת בתוכן של הרכיב צאצא מהסוג שצוין, החל מ-Range שצוין. |
find | Range | חיפוש דפוס הטקסט שצוין בתוכן של האלמנט באמצעות ביטויים רגולריים. |
find | Range | חיפוש של דפוס הטקסט שצוין בתוכן הרכיב, החל מתוצאת חיפוש נתונה. |
get | Horizontal | אחזור של Horizontal . |
get | Object | אחזור המאפיינים של האלמנט. |
get | Element | אחזור רכיב הצאצא לפי אינדקס הצאצא שצוין. |
get | Integer | אחזור של מדד הצאצא של רכיב הצאצא שצוין. |
get | Glyph | אחזור של Glyph של הפריט ברשימה. |
get | Paragraph | אחזור של Paragraph . |
get | Number | אחזור ההכנסה בסוף, בנקודות. |
get | Number | אחזור הגדלת הכניסה של השורה הראשונה, בנקודות. |
get | Number | אחזור של הפסקה ההתחלתית. |
get | Number | אחזור הריווח בין השורות, בנקודות. |
get | String | אחזור כתובת ה-URL של הקישור. |
get | String | אחזור מזהה הרשימה. |
get | Integer | אחזור של רמת ההטמעה של פריט ברשימה. |
get | Element | אחזור הרכיב הבא של הרכיב. |
get | Integer | אחזור מספר הילדים. |
get | Container | אחזור של רכיב ההורה של האלמנט. |
get | Positioned | אחזור Positioned לפי מזהה התמונה. |
get | Positioned | הפונקציה מקבלת את כל אובייקטי ה-Positioned שמאוגדים לפסקה. |
get | Element | אחזור של רכיב האח הקודם של הרכיב. |
get | Number | אחזור הריווח אחרי הרכיב, בנקודות. |
get | Number | אחזור הריווח לפני הרכיב, בנקודות. |
get | String | אחזור התוכן של הרכיב כמחרוזת טקסט. |
get | Text | הפונקציה מקבלת את יישור הטקסט. |
get | Element | אחזור הערך של Element ברכיב. |
insert | Horizontal | יצירת Horizontal והוספה שלו למיקום שצוין. |
insert | Inline | יצירת Inline חדשה מה-blob של התמונה שצוין והוספתה לאינדקס שצוין. |
insert | Inline | הוספת Inline הנתון באינדקס שצוין. |
insert | Page | יצירת Page חדשה והוספתה למיקום המסומן. |
insert | Page | הוספת Page הנתון באינדקס שצוין. |
insert | Text | יצירת רכיב טקסט חדש והוספתו למיקום שצוין. |
insert | Text | הוספת רכיב Text נתון במדד שצוין, עם תוכן הטקסט שצוין. |
is | Boolean | הפונקציה קובעת אם הרכיב נמצא בסוף ה-Document . |
is | Boolean | אחזור ההגדרה מימין לשמאל. |
merge() | List | מיזוג הרכיב עם האח/ה הקודם/ה מאותו סוג. |
remove | List | הסרה של רכיב הבן שצוין. |
remove | List | הסרת הרכיב מהרכיב ההורה שלו. |
remove | Boolean | הסרת Positioned לפי מזהה התמונה. |
replace | Element | מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים. |
set | List | הגדרת Horizontal . |
set | List | הגדרת המאפיינים של האלמנט. |
set | List | הגדרת Glyph של הפריט ברשימה. |
set | List | הגדרת Paragraph . |
set | List | הגדרת הכניסה בסוף, בנקודות. |
set | List | הגדרת הפסקה של השורה הראשונה, בנקודות. |
set | List | הגדרת הכניסה בתחילת השורה, בנקודות. |
set | List | הגדרת כיוון מימין לשמאל. |
set | List | הגדרת הריווח בין השורות, ככמות שמציינת את מספר השורות שיש להשתמש בהן לריווח. |
set | List | הגדרת כתובת ה-URL של הקישור. |
set | List | הגדרת מזהה הרשימה. |
set | List | הגדרת רמת ההטמעה של הפריט ברשימה. |
set | List | הגדרת הריווח אחרי האלמנט, בנקודות. |
set | List | הגדרת הריווח לפני הרכיב, בנקודות. |
set | void | הגדרת התוכן של פריט הרשימה כטקסט. |
set | List | הגדרת יישור הטקסט. |
מסמכים מפורטים
add Positioned Image(image)
יצירת Positioned
חדשה והוספה שלה מה-blob של התמונה שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
image | Blob | נתוני התמונה |
חזרה
Positioned
– התמונה החדשה במיקום החדש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Horizontal Rule()
יצירת Horizontal
חדש והוספתו.
חזרה
Horizontal
— הקו האופקי החדש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Inline Image(image)
יצירת Inline
חדש והוספתו לקובץ ה-blob של התמונה שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
image | Blob | נתוני התמונה |
חזרה
Inline
– התמונה שצורפה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Inline Image(image)
הוספה של Inline
הנתון.
פרמטרים
שם | סוג | תיאור |
---|---|---|
image | Inline | נתוני התמונה |
חזרה
Inline
– התמונה שצורפה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Page Break()
יצירת Page
חדש והוספתו.
הערה: ייתכן ש-Page
לא יהיה כלול ב-Table
.
אם האלמנט הנוכחי נמצא בתא בטבלה, תופיע חריגה.
חזרה
Page
– המרכיב החדש של מעבר דף
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Page Break(pageBreak)
הוספה של Page
הנתון.
הערה: ייתכן ש-Page
לא יהיה כלול ב-Table
.
אם האלמנט הנוכחי נמצא בתא בטבלה, תופיע חריגה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
page | Page | מעבר הדף שרוצים לצרף |
חזרה
Page
– רכיב מעבר הדף שנוסף
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Text(text)
יצירת רכיב Text
חדש והוספת התוכן שצוין אליו.
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | String | תוכן הטקסט |
חזרה
Text
– רכיב הטקסט החדש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Text(text)
הוספת האלמנט Text
הנתון.
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | Text | רכיב הטקסט שרוצים לצרף |
חזרה
Text
– רכיב הטקסט שנוסף
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
הפונקציה מחזירה עותק מנותק ומעמיק של הרכיב הנוכחי.
כל אלמנטי הצאצא שנמצאים באלמנט יועתקו גם כן. לאלמנט החדש אין הורה.
חזרה
List
– העותק החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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 Alignment()
אחזור של Horizontal
.
חזרה
Horizontal
– היישור
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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 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 Glyph Type()
אחזור של Glyph
של הפריט ברשימה.
חזרה
Glyph
– סוג הגליף
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Heading()
אחזור של Paragraph
.
חזרה
Paragraph
– הכותרת
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Indent End()
אחזור ההכנסה בסוף, בנקודות.
חזרה
Number
– סוף הכניסה, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Indent First Line()
אחזור הגדלת הכניסה של השורה הראשונה, בנקודות.
חזרה
Number
– הגדלת הכניסה של השורה הראשונה, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Indent Start()
אחזור של הפסקה ההתחלתית.
חזרה
Number
– התחלת הכניסה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Line Spacing()
אחזור הריווח בין השורות, בנקודות.
חזרה
Number
– הריווח בין השורות, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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 List Id()
אחזור מזהה הרשימה.
חזרה
String
– מזהה הרשימה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Nesting Level()
אחזור של רמת ההטמעה של פריט ברשימה.
כברירת מחדל, לרמת הדירוג של פריטים ברשימה יש ערך אפס. רמת ההטמעה קובעת את הגליף שבו נעשה שימוש בפריט הרשימה.
חזרה
Integer
– רמת הקינון
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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 Parent()
אחזור של רכיב ההורה של האלמנט.
רכיב ההורה מכיל את הרכיב הנוכחי.
חזרה
Container
– רכיב ההורה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Positioned Image(id)
אחזור Positioned
לפי מזהה התמונה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
id | String | מזהה התמונה |
חזרה
Positioned
— התמונה במיקום הרצוי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Positioned Images()
הפונקציה מקבלת את כל אובייקטי ה-Positioned
שמאוגדים לפסקה.
חזרה
Positioned
– רשימה של תמונות במיקום מדויק
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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 Spacing After()
אחזור הריווח אחרי הרכיב, בנקודות.
חזרה
Number
– הריווח אחרי הרכיב, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Spacing Before()
אחזור הריווח לפני הרכיב, בנקודות.
חזרה
Number
– הריווח לפני הרכיב, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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
insert Horizontal Rule(childIndex)
יצירת Horizontal
והוספה שלו למיקום שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
חזרה
Horizontal
– האלמנט החדש של הקו האופקי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Inline Image(childIndex, image)
יצירת Inline
חדשה מה-blob של התמונה שצוין והוספתה לאינדקס שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
image | Blob | נתוני התמונה |
חזרה
Inline
– רכיב התמונה בתוך השורה שהוכנס
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Inline Image(childIndex, image)
הוספת Inline
הנתון באינדקס שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
image | Inline | נתוני התמונה |
חזרה
Inline
– רכיב התמונה בתוך השורה שהוכנס
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Page Break(childIndex)
יצירת Page
חדשה והוספתה למיקום המסומן.
הערה: ייתכן ש-Page
לא יהיה כלול ב-Table
.
אם האלמנט הנוכחי נמצא בתא בטבלה, תופיע חריגה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
חזרה
Page
– המרכיב החדש של מעבר דף
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Page Break(childIndex, pageBreak)
הוספת Page
הנתון באינדקס שצוין.
הערה: ייתכן ש-Page
לא יהיה כלול ב-Table
.
אם האלמנט הנוכחי נמצא בתא בטבלה, תופיע חריגה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
page | Page | את מעבר הדף שרוצים להוסיף |
חזרה
Page
– רכיב מעבר הדף שהוכנס
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Text(childIndex, text)
יצירת רכיב טקסט חדש והוספתו למיקום שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
text | String | תוכן הטקסט |
חזרה
Text
– רכיב הטקסט החדש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Text(childIndex, text)
הוספת רכיב Text
נתון במדד שצוין, עם תוכן הטקסט שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב |
text | Text | רכיב הטקסט שרוצים להוסיף |
חזרה
Text
– רכיב הטקסט שנוסף
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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
is Left To Right()
אחזור ההגדרה מימין לשמאל.
חזרה
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();
חזרה
List
– הרכיב הממוזג.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Child(child)
הסרה של רכיב הבן שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Element | רכיב הצאצא שרוצים להסיר |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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(); }
חזרה
List
– הרכיב שהוסרה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Positioned Image(id)
הסרת Positioned
לפי מזהה התמונה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
id | String |
חזרה
Boolean
— אם התמונה שצוינה הוסרה או לא
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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 Alignment(alignment)
הגדרת Horizontal
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
alignment | Horizontal | היישור האנכי |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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 | המאפיינים של האלמנט. |
חזרה
List
– הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Glyph Type(glyphType)
הגדרת Glyph
של הפריט ברשימה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
glyph | Glyph | סוג הגליף |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Heading(heading)
הגדרת Paragraph
.
פרמטרים
שם | סוג | תיאור |
---|---|---|
heading | Paragraph | הכותרת |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Indent End(indentEnd)
הגדרת הכניסה בסוף, בנקודות.
פרמטרים
שם | סוג | תיאור |
---|---|---|
indent | Number | סוף הכניסה, בנקודות |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Indent First Line(indentFirstLine)
הגדרת הפסקה של השורה הראשונה, בנקודות.
פרמטרים
שם | סוג | תיאור |
---|---|---|
indent | Number | כניסת השורה הראשונה, בנקודות |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Indent Start(indentStart)
הגדרת הכניסה בתחילת השורה, בנקודות.
פרמטרים
שם | סוג | תיאור |
---|---|---|
indent | Number | התחלת הכניסה, בנקודות |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Left To Right(leftToRight)
הגדרת כיוון מימין לשמאל.
פרמטרים
שם | סוג | תיאור |
---|---|---|
left | Boolean | ההגדרה 'מימין לשמאל' |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Line Spacing(multiplier)
הגדרת הריווח בין השורות, ככמות שמציינת את מספר השורות שיש להשתמש בהן לריווח.
פרמטרים
שם | סוג | תיאור |
---|---|---|
multiplier | Number | מספר השורות |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Link Url(url)
הגדרת כתובת ה-URL של הקישור.
פרמטרים
שם | סוג | תיאור |
---|---|---|
url | String | כתובת ה-URL של הקישור |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set List Id(listItem)
הגדרת מזהה הרשימה.
מזהה הרשימה מוגדר לאותו ערך עבור List
שצוין. שני ה-List
יטופלו כחברים באותה רשימה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
list | List | פריט הרשימה שלגביו רוצים להשתמש במזהה הרשימה |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Nesting Level(nestingLevel)
הגדרת רמת ההטמעה של הפריט ברשימה.
כברירת מחדל, לרמת הדירוג של פריטים ברשימה יש ערך אפס. רמת ההטמעה קובעת את הגליף שבו נעשה שימוש בפריט הרשימה.
פרמטרים
שם | סוג | תיאור |
---|---|---|
nesting | Integer | רמת ההטמעה |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Spacing After(spacingAfter)
הגדרת הריווח אחרי האלמנט, בנקודות.
פרמטרים
שם | סוג | תיאור |
---|---|---|
spacing | Number | הריווח אחרי הרכיב, בנקודות |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Spacing Before(spacingBefore)
הגדרת הריווח לפני הרכיב, בנקודות.
פרמטרים
שם | סוג | תיאור |
---|---|---|
spacing | Number | הריווח לפני הרכיב, בנקודות |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text(text)
הגדרת התוכן של פריט הרשימה כטקסט.
הערה: התוכן הקיים יימחק.
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | String | תוכן הטקסט החדש |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
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 | סוג יישור הטקסט שרוצים להחיל |
חזרה
List
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents