רכיב שמייצג פריט ברשימה. ListItem הוא Paragraph שמשויך למזהה רשימה. רכיב ListItem יכול להכיל את הרכיבים Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak ו-Text. מידע נוסף על מבנה המסמך זמין במדריך להרחבת Google Docs.
הערך ListItems לא יכול להכיל תווי מעבר לשורה חדשה. תווים של שורה חדשה ("\n") מומרים לתווים של מעבר שורה ("\r").
ListItems עם אותו מזהה רשימה שייכים לאותה רשימה וממוספרים בהתאם.
לא חובה שפריטי הרשימה ListItems יהיו סמוכים זה לזה בכרטיסייה או אפילו שיהיה להם אותו רכיב הורה. יכולים להיות שני פריטים ששייכים לאותה רשימה בכל מקום בכרטיסייה, והמספור שלהם יישאר רציף. כך למשל:
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 חדש מבלוב התמונה שצוין. |
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|null | מאחזרת את ההזחה בסוף, בנקודות. |
get | Number|null | הפונקציה מאחזרת את גודל הכניסה של השורה הראשונה, בנקודות. |
get | Number|null | הפונקציה מחזירה את ההזחה של תחילת הפסקה. |
get | Number|null | מאחזרת את הריווח בין השורות, בנקודות. |
get | String|null | הפונקציה מחזירה את כתובת ה-URL של הקישור. |
get | String|null | מאחזר את מזהה הרשימה. |
get | Integer | מאחזר את רמת הקינון של הפריט ברשימה. |
get | Element|null | מאחזר את רכיב האח הבא של הרכיב. |
get | Integer | מאחזר את מספר הילדים. |
get | Container | מאחזר את רכיב ההורה של הרכיב. |
get | Positioned | הפונקציה מחזירה Positioned לפי מזהה התמונה. |
get | Positioned | מקבל את כל אובייקטי Positioned שמעוגנים לפסקה. |
get | Element|null | אחזור של רכיב האחות הקודם של הרכיב. |
get | Number|null | מחזירה את הריווח אחרי הרכיב, בנקודות. |
get | Number|null | מחזירה את הריווח לפני הרכיב, בנקודות. |
get | String | מאחזרת את התוכן של הרכיב כמחרוזת טקסט. |
get | Text | מחזירה את יישור הטקסט. |
get | Element | אחזור Element של הרכיב. |
insert | Horizontal | יוצרת את התג Horizontal ומוסיפה אותו לאינדקס שצוין. |
insert | Inline | יוצר ומכניס Inline חדש מבלוב התמונה שצוין, באינדקס שצוין. |
insert | Inline | הפונקציה מוסיפה את Inline שצוין באינדקס שצוין. |
insert | Page | יוצרת ומכניסה אובייקט Page חדש באינדקס שצוין. |
insert | Page | הפונקציה מוסיפה את Page שצוין באינדקס שצוין. |
insert | Text | יוצרת ומכניסה רכיב טקסט חדש באינדקס שצוין. |
insert | Text | הוספת רכיב Text שצוין באינדקס שצוין, עם תוכן הטקסט שצוין. |
is | Boolean | קובע אם הרכיב נמצא בסוף Document. |
is | Boolean|null | מאחזר את ההגדרה משמאל לימין. |
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 | הגדרת יישור הטקסט. |
תיעוד מפורט
addPositionedImage(image)
יוצר ומכניס PositionedImage חדש מ-blob התמונה שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
image | Blob | נתוני התמונה |
חזרה
PositionedImage – התמונה החדשה עם המיקום
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendHorizontalRule()
יוצרת HorizontalRule חדש ומצרפת אותו.
חזרה
HorizontalRule – הקו האופקי החדש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendInlineImage(image)
יוצר ומצרף InlineImage חדש מבלוב התמונה שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
image | Blob | נתוני התמונה |
חזרה
InlineImage – התמונה שנוספה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendInlineImage(image)
הוספה של InlineImage.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
image | Inline | נתוני התמונה |
חזרה
InlineImage – התמונה שנוספה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendPageBreak()
יוצרת PageBreak חדש ומצרפת אותו.
הערה: יכול להיות ש-PageBreaks לא נכלל ב-TableCells.
אם הרכיב הנוכחי כלול בתא בטבלה, תופעל חריגה.
חזרה
PageBreak — רכיב מעבר הדף החדש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendPageBreak(pageBreak)
הוספה של PageBreak.
הערה: יכול להיות ש-PageBreaks לא נכלל ב-TableCells.
אם הרכיב הנוכחי כלול בתא בטבלה, תופעל חריגה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
page | Page | מעבר הדף לצירוף |
חזרה
PageBreak – רכיב מעבר הדף שנוסף
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendText(text)
appendText(text)
clear()
copy()
הפונקציה מחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
כל רכיבי הצאצא שקיימים ברכיב מועתקים גם הם. לרכיב החדש אין רכיב אב.
חזרה
ListItem — העותק החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
editAsText()
מקבלים גרסה Text של הרכיב הנוכחי לצורך עריכה.
אפשר להשתמש ב-editAsText כדי לשנות את תוכן הרכיבים כטקסט עשיר. במצב editAsText המערכת מתעלמת מאלמנטים שאינם טקסט (כמו InlineImage ו-HorizontalRule).
רכיבי צאצא שכלולים באופן מלא בטווח טקסט שנמחק מוסרים מהרכיב.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, 'An editAsText sample.'); body.insertHorizontalRule(0); body.insertParagraph(0, 'An example.'); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
חזרה
Text — גרסת טקסט של הרכיב הנוכחי
findElement(elementType)
מחפש בתוכן של הרכיב צאצא מסוג מסוים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
element | Element | סוג הרכיב לחיפוש. |
חזרה
RangeElement|null — תוצאת חיפוש שמציינת את המיקום של רכיב החיפוש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findElement(elementType, from)
הפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
element | Element | סוג הרכיב לחיפוש. |
from | Range | תוצאת החיפוש שממנה מתחילים את החיפוש. |
חזרה
RangeElement|null — תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findText(searchPattern)
מחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
קבוצת משנה של תכונות הביטוי הרגולרי של JavaScript לא נתמכות באופן מלא, כמו קבוצות לכידה ומשני מצב.
תבנית הביטוי הרגולרי שצוינה מושווית באופן עצמאי לכל בלוק טקסט שנכלל ברכיב הנוכחי.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
search | String | התבנית לחיפוש |
חזרה
RangeElement|null – תוצאת חיפוש שמציינת את המיקום של טקסט החיפוש, או null אם אין התאמה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
מחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
קבוצת משנה של תכונות הביטוי הרגולרי של JavaScript לא נתמכות באופן מלא, כמו קבוצות לכידה ומשני מצב.
תבנית הביטוי הרגולרי שצוינה מושווית באופן עצמאי לכל בלוק טקסט שנכלל ברכיב הנוכחי.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
search | String | התבנית לחיפוש |
from | Range | תוצאת החיפוש שממנה רוצים לחפש |
חזרה
RangeElement|null — תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או null אם אין התאמה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getAlignment()
מאחזר את HorizontalAlignment.
חזרה
HorizontalAlignment|null – היישור
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getAttributes()
מאחזר את המאפיינים של האלמנט.
התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין של רכיב תקין, כאשר כל שם מאפיין תואם לפריט בספירה DocumentApp.Attribute.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
חזרה
Object – מאפייני הרכיב.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getChild(childIndex)
מאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText('This is the first paragraph.'); }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס של רכיב הצאצא לאחזור. |
חזרה
Element – רכיב הצאצא באינדקס שצוין.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getChildIndex(child)
מאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Element | רכיב הצאצא שעבורו רוצים לאחזר את האינדקס. |
חזרה
Integer — אינדקס הילד.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getGlyphType()
getHeading()
מאחזר את ParagraphHeading.
חזרה
ParagraphHeading|null – הכותרת
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getIndentEnd()
מאחזרת את ההזחה בסוף, בנקודות.
חזרה
Number|null — סוף הכניסה, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getIndentFirstLine()
הפונקציה מאחזרת את גודל הכניסה של השורה הראשונה, בנקודות.
חזרה
Number|null — כניסת השורה הראשונה, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getIndentStart()
הפונקציה מחזירה את ההזחה של תחילת הפסקה.
חזרה
Number|null — התחלת הכניסה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getLineSpacing()
מאחזרת את הריווח בין השורות, בנקודות.
חזרה
Number|null – ריווח השורות, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getLinkUrl()
הפונקציה מחזירה את כתובת ה-URL של הקישור.
חזרה
String|null – כתובת ה-URL של הקישור, או null אם הרכיב מכיל כמה ערכים למאפיין הזה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getListId()
מאחזר את מזהה הרשימה.
חזרה
String|null – מזהה הרשימה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getNestingLevel()
מאחזר את רמת הקינון של הפריט ברשימה.
כברירת מחדל, רמת הקינון של פריטים ברשימה היא אפס. רמת הקינון קובעת את הגליף שמשמש את פריט הרשימה.
חזרה
Integer – רמת הסידור הפנימי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getNextSibling()
מאחזר את רכיב האח הבא של הרכיב.
לרכיב הבא באותה רמה יש את אותו רכיב אב והוא מופיע אחרי הרכיב הנוכחי.
חזרה
Element|null – רכיב האחים הבא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getNumChildren()
מאחזר את מספר הילדים.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);
חזרה
Integer — מספר הילדים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getParent()
מאחזר את רכיב ההורה של הרכיב.
רכיב ההורה מכיל את הרכיב הנוכחי.
חזרה
ContainerElement|null – רכיב ההורה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getPositionedImage(id)
הפונקציה מחזירה PositionedImage לפי מזהה התמונה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
id | String | מזהה התמונה |
חזרה
PositionedImage — התמונה הממוקמת
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getPositionedImages()
מקבל את כל אובייקטי PositionedImage שמעוגנים לפסקה.
חזרה
PositionedImage[] – רשימה של תמונות עם מיקום
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getPreviousSibling()
אחזור של רכיב האחות הקודם של הרכיב.
לאח או לאחות הקודמים יש את אותו רכיב אב והם קודמים לרכיב הנוכחי.
חזרה
Element|null – רכיב האח הקודם.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getSpacingAfter()
מחזירה את הריווח אחרי הרכיב, בנקודות.
חזרה
Number|null — הריווח אחרי הרכיב, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getSpacingBefore()
מחזירה את הריווח לפני הרכיב, בנקודות.
חזרה
Number|null – הריווח לפני הרכיב, בנקודות
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getText()
מאחזרת את התוכן של הרכיב כמחרוזת טקסט.
חזרה
String – התוכן של הרכיב כמחרוזת טקסט
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getTextAlignment()
מחזירה את יישור הטקסט. סוגי היישור הזמינים הם DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT ו-DocumentApp.TextAlignment.SUPERSCRIPT.
חזרה
TextAlignment|null – סוג יישור הטקסט, או null אם הטקסט מכיל כמה סוגים של יישור טקסט או אם יישור הטקסט לא הוגדר אף פעם
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getType()
אחזור ElementType של הרכיב.
משתמשים ב-getType() כדי לקבוע את הסוג המדויק של רכיב נתון.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
חזרה
ElementType – סוג הרכיב.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
יוצרת את התג HorizontalRule ומוסיפה אותו לאינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
חזרה
HorizontalRule — רכיב הסרגל האופקי החדש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
יוצר ומכניס InlineImage חדש מבלוב התמונה שצוין, באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
image | Blob | נתוני התמונה |
חזרה
InlineImage — רכיב התמונה המוטמעת שהוכנס
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
הפונקציה מוסיפה את InlineImage שצוין באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
image | Inline | נתוני התמונה |
חזרה
InlineImage — רכיב התמונה המוטמעת שהוכנס
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex)
יוצרת ומכניסה אובייקט PageBreak חדש באינדקס שצוין.
הערה: יכול להיות ש-PageBreaks לא נכלל ב-TableCells.
אם הרכיב הנוכחי כלול בתא בטבלה, תופעל חריגה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
חזרה
PageBreak — רכיב מעבר הדף החדש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex, pageBreak)
הפונקציה מוסיפה את PageBreak שצוין באינדקס שצוין.
הערה: יכול להיות ש-PageBreaks לא נכלל ב-TableCells.
אם הרכיב הנוכחי כלול בתא בטבלה, תופעל חריגה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
page | Page | מעבר הדף שרוצים להוסיף |
חזרה
PageBreak – רכיב מעבר הדף שנוסף
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
יוצרת ומכניסה רכיב טקסט חדש באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
text | String | תוכן הטקסט |
חזרה
Text – רכיב הטקסט החדש
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
הוספת רכיב Text שצוין באינדקס שצוין, עם תוכן הטקסט שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב |
text | Text | רכיב הטקסט להוספה |
חזרה
Text – רכיב הטקסט שנוסף
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
isLeftToRight()
מאחזר את ההגדרה משמאל לימין.
חזרה
Boolean|null – ההגדרה משמאל לימין
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
merge()
מיזוג הרכיב עם הרכיב הקודם מאותו סוג.
אפשר למזג רק רכיבים מאותו סוג ElementType. כל רכיבי הצאצא שכלולים ברכיב הנוכחי מועברים לרכיב האח הקודם.
האלמנט הנוכחי יוסר מהמסמך.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. const par1 = body.appendParagraph('Paragraph 1.'); const par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. const cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'], ]; // Build a table from the array. const table = body.appendTable(cells); // Get the first row in the table. const row = table.getRow(0); // Get the two cells in this row. const cell1 = row.getCell(0); const cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. const merged = cell2.merge();
חזרה
ListItem|null – הרכיב הממוזג.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
removeChild(child)
removeFromParent()
הפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
חזרה
ListItem|null — הרכיב שהוסר.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
removePositionedImage(id)
הסרת PositionedImage לפי מזהה התמונה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
id | String |
חזרה
Boolean — אם התמונה שצוינה הוסרה או לא
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
הפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים.
תבנית החיפוש מועברת כמחרוזת, ולא כאובייקט של ביטוי רגולרי ב-JavaScript. לכן, צריך לסמן בתו בריחה (escape) כל לוכסן הפוך בתבנית.
השיטה הזו משתמשת בספריית הביטויים הרגולריים RE2 של Google, שמגבילה את התחביר הנתמך.
תבנית הביטוי הרגולרי שצוינה מושווית באופן עצמאי לכל בלוק טקסט שנכלל ברכיב הנוכחי.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
search | String | תבנית הביטוי הרגולרי לחיפוש |
replacement | String | הטקסט שבו רוצים להשתמש להחלפה |
חזרה
Element – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setAlignment(alignment)
מגדירה את ה-HorizontalAlignment.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
alignment | Horizontal | היישור האופקי |
חזרה
ListItem – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setAttributes(attributes)
הגדרת המאפיינים של האלמנט.
פרמטר המאפיינים שצוין צריך להיות אובייקט שבו כל שם מאפיין הוא פריט בספירה DocumentApp.Attribute וכל ערך מאפיין הוא הערך החדש שיוחל.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
attributes | Object | המאפיינים של האלמנט. |
חזרה
ListItem – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setGlyphType(glyphType)
setHeading(heading)
מגדירה את ה-ParagraphHeading.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
heading | Paragraph | הכותרת |
חזרה
ListItem – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setIndentEnd(indentEnd)
מגדיר את הכניסה של סוף הפיסקה, בנקודות.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
indent | Number | הכניסה של סוף הפסקה, בנקודות |
חזרה
ListItem – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setIndentFirstLine(indentFirstLine)
הגדרת הכניסה של השורה הראשונה, בנקודות.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
indent | Number | הכניסה של השורה הראשונה, בנקודות |
חזרה
ListItem – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setIndentStart(indentStart)
הגדרת כניסה לתחילת הפיסקה, בנקודות.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
indent | Number | הכניסה לתחילת הפסקה, בנקודות |
חזרה
ListItem – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setLeftToRight(leftToRight)
setLineSpacing(multiplier)
הגדרה של המרווח בין השורות, כמספר שמציין את מספר השורות שמשמשות למרווח.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
multiplier | Number | מספר השורות |
חזרה
ListItem – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setLinkUrl(url)
setListId(listItem)
מגדירה את מזהה הרשימה.
מזהה הרשימה מוגדר לאותו ערך של ListItem שצוין. שני ListItems יטופלו כחברים באותה רשימה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
list | List | הפריט ברשימה שרוצים להשתמש במזהה הרשימה שלו |
חזרה
ListItem – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setNestingLevel(nestingLevel)
קובעת את רמת הקינון של הפריט ברשימה.
כברירת מחדל, רמת הקינון של פריטים ברשימה היא אפס. רמת הקינון קובעת את הגליף שמשמש את פריט הרשימה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
nesting | Integer | רמת הסידור הפנימי |
חזרה
ListItem – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setSpacingAfter(spacingAfter)
מגדיר את הריווח אחרי הרכיב, בנקודות.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
spacing | Number | הריווח אחרי הרכיב, בנקודות |
חזרה
ListItem – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setSpacingBefore(spacingBefore)
מגדיר את הריווח לפני הרכיב, בנקודות.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
spacing | Number | הריווח לפני הרכיב, בנקודות |
חזרה
ListItem – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setText(text)
מגדיר את התוכן של הפריט ברשימה כטקסט.
הערה: התוכן הקיים יימחק.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
text | String | התוכן של הטקסט החדש |
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
הגדרת יישור הטקסט. סוגי היישור הזמינים הם DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT ו-DocumentApp.TextAlignment.SUPERSCRIPT.
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
text | Text | סוג יישור הטקסט שרוצים להחיל |
חזרה
ListItem – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents