התוכן של כרטיסייה במסמך Google Docs. התג Body עשוי להכיל את הרכיבים ListItem, Paragraph, Table ו-TableOfContents. מידע נוסף על מבנה המסמך זמין במדריך להרחבת Google Docs.
התג Body בדרך כלל מכיל את כל התוכן של הכרטיסייה, למעט התגים HeaderSection, FooterSection וכל רכיבי FootnoteSection.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a paragraph and a page break to the tab's body section directly. body.appendParagraph('A paragraph.'); body.appendPageBreak();
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
append | Horizontal | יוצרת Horizontal חדש ומצרפת אותו. |
append | Inline | יוצר ומצרף Inline חדש מבלוב התמונה שצוין. |
append | Inline | הוספה של Inline. |
append | List | הוספה של List. |
append | List | יוצרת ומצרפת רכיב List חדש שמכיל את תוכן הטקסט שצוין. |
append | Page | יוצרת Page חדש ומצרפת אותו. |
append | Page | הוספה של Page. |
append | Paragraph | הוספה של Paragraph. |
append | Paragraph | יוצרת ומצרפת רכיב Paragraph חדש שמכיל את תוכן הטקסט שצוין. |
append | Table | יוצרת Table חדש ומצרפת אותו. |
append | Table | הפונקציה מוסיפה Table חדש שמכיל Table לכל ערך מחרוזת שצוין. |
append | Table | הוספה של Table. |
clear() | Body | מחיקת התוכן של הרכיב. |
copy() | Body | הפונקציה מחזירה עותק מנותק ועמוק של הרכיב הנוכחי. |
edit | Text | מקבלים גרסה Text של הרכיב הנוכחי לצורך עריכה. |
find | Range | מחפש בתוכן של הרכיב צאצא מסוג מסוים. |
find | Range | הפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRange שצוין. |
find | Range | מחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים. |
find | Range | מחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה. |
get | Object | מאחזר את המאפיינים של האלמנט. |
get | Element | מאחזר את רכיב הצאצא באינדקס הצאצא שצוין. |
get | Integer | מאחזר את אינדקס הצאצא של רכיב הצאצא שצוין. |
get | Object | הפונקציה מאחזרת את קבוצת המאפיינים של Paragraph שצוין. |
get | Inline | מאחזר את כל ה-Inline שמופיעים בקטע. |
get | List | מאחזר את כל ה-List שמופיעים בקטע. |
get | Number|null | הפונקציה מאחזרת את השוליים התחתונים, בנקודות. |
get | Number|null | מאחזרת את השוליים השמאליים, בנקודות. |
get | Number|null | מחזירה את השוליים הימניים. |
get | Number|null | מחזירה את השוליים העליונים. |
get | Integer | מאחזר את מספר הילדים. |
get | Number|null | מאחזר את גובה הדף, בנקודות. |
get | Number|null | מאחזר את רוחב הדף, בנקודות. |
get | Paragraph[]|null | מאחזר את כל Paragraphs שמופיעים בקטע (כולל List). |
get | Container | מאחזר את רכיב ההורה של הרכיב. |
get | Table[]|null | מאחזר את כל ה-Tables שמופיעים בקטע. |
get | String | מאחזרת את התוכן של הרכיב כמחרוזת טקסט. |
get | Text | מחזירה את יישור הטקסט. |
get | Element | אחזור Element של הרכיב. |
insert | Horizontal | יוצרת ומכניסה אובייקט Horizontal חדש באינדקס שצוין. |
insert | Inline | יוצרת ומכניסה Inline מבלוב התמונה שצוין, באינדקס שצוין. |
insert | Inline | הפונקציה מוסיפה את Inline שצוין באינדקס שצוין. |
insert | List | הפונקציה מוסיפה את List שצוין באינדקס שצוין. |
insert | List | יוצרת ומכניסה List חדש באינדקס שצוין, שמכיל את תוכן הטקסט שצוין. |
insert | Page | יוצרת ומכניסה אובייקט Page חדש באינדקס שצוין. |
insert | Page | הפונקציה מוסיפה את Page שצוין באינדקס שצוין. |
insert | Paragraph | הפונקציה מוסיפה את Paragraph שצוין באינדקס שצוין. |
insert | Paragraph | יוצרת ומכניסה Paragraph חדש באינדקס שצוין, שמכיל את תוכן הטקסט שצוין. |
insert | Table | יוצרת ומכניסה אובייקט Table חדש באינדקס שצוין. |
insert | Table | הפונקציה יוצרת תא חדש Table שמכיל את התאים שצוינו, ומכניסה אותו לאינדקס שצוין. |
insert | Table | הפונקציה מוסיפה את Table שצוין באינדקס שצוין. |
remove | Body | הסרת רכיב הבן שצוין. |
replace | Element | הפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים. |
set | Body | הגדרת המאפיינים של האלמנט. |
set | Body | הגדרת המאפיינים של Paragraph שצוין. |
set | Body | מגדיר את השוליים התחתונים, בנקודות. |
set | Body | הגדרה של השוליים השמאליים, בנקודות. |
set | Body | מגדיר את השוליים הימניים, בנקודות. |
set | Body | הגדרת השוליים העליונים. |
set | Body | הגדרת גובה הדף, בנקודות. |
set | Body | הגדרה של רוחב הדף, בנקודות. |
set | Body | הגדרת התוכן כטקסט פשוט. |
set | Body | הגדרת יישור הטקסט. |
תיעוד מפורט
appendHorizontalRule()
יוצרת HorizontalRule חדש ומצרפת אותו.
התג HorizontalRule ייכלל בתג Paragraph חדש.
חזרה
HorizontalRule — הקו האופקי החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendImage(image)
יוצר ומצרף InlineImage חדש מבלוב התמונה שצוין.
התמונה תהיה בתוך תג Paragraph חדש.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
image | Blob | נתוני התמונה. |
חזרה
InlineImage – התמונה שצורפה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendImage(image)
הוספה של InlineImage.
התג InlineImage ייכלל בתג Paragraph חדש.
משתמשים בגרסה הזו של appendImage כשמוסיפים עותק של InlineImage קיים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
image | Inline | נתוני התמונה. |
חזרה
InlineImage – התמונה שצורפה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendListItem(listItem)
הוספה של ListItem.
משתמשים בגרסה הזו של appendListItem כשמוסיפים עותק של ListItem קיים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
list | List | הפריט ברשימה שרוצים לצרף. |
חזרה
ListItem — הפריט שנוסף לרשימה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendListItem(text)
יוצרת ומצרפת רכיב ListItem חדש שמכיל את תוכן הטקסט שצוין.
פריטים עוקבים ברשימה מתווספים כחלק מאותה רשימה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
text | String | תוכן הטקסט של הפריט ברשימה. |
חזרה
ListItem — הפריט החדש ברשימה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendPageBreak()
appendPageBreak(pageBreak)
הוספה של PageBreak.
התג PageBreak ייכלל בתג Paragraph חדש.
משתמשים בגרסה הזו של appendPageBreak כשמוסיפים עותק של PageBreak קיים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
page | Page | מעבר הדף שרוצים להוסיף. |
חזרה
PageBreak — מעבר הדף שנוסף.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendParagraph(paragraph)
הוספה של Paragraph.
משתמשים בגרסה הזו של appendParagraph כשמוסיפים עותק של Paragraph קיים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
paragraph | Paragraph | הפסקה שרוצים לצרף. |
חזרה
Paragraph – הפסקה שנוספה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendParagraph(text)
יוצרת ומצרפת רכיב Paragraph חדש שמכיל את תוכן הטקסט שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
text | String | תוכן הטקסט של הפסקה. |
חזרה
Paragraph — הפיסקה החדשה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendTable()
יוצרת Table חדש ומצרפת אותו.
בשיטה הזו יצורף גם פסק ריק אחרי הטבלה, כי מסמכי Google Docs לא יכולים להסתיים בטבלה.
חזרה
Table — הטבלה החדשה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendTable(cells)
הפונקציה מוסיפה Table חדש שמכיל TableCell לכל ערך מחרוזת שצוין.
בשיטה הזו יצורף גם פסק ריק אחרי הטבלה, כי מסמכי Google Docs לא יכולים להסתיים בטבלה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
cells | String[][] | תוכן הטקסט של תאי הטבלה שרוצים להוסיף לטבלה החדשה. |
חזרה
Table — הטבלה שצורפה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
appendTable(table)
הוספה של Table.
משתמשים בגרסה הזו של appendTable כשמוסיפים עותק של Table קיים.
בשיטה הזו יצורף גם פסק ריק אחרי הטבלה, כי מסמכי Google Docs לא יכולים להסתיים בטבלה.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
table | Table | הטבלה שאליה רוצים לצרף את הנתונים. |
חזרה
Table — הטבלה שצורפה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
clear()
copy()
הפונקציה מחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
כל רכיבי הצאצא שקיימים ברכיב מועתקים גם הם. לרכיב החדש אין רכיב אב.
חזרה
Body — העותק החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
editAsText()
מקבלים גרסה Text של הרכיב הנוכחי לצורך עריכה.
אפשר להשתמש ב-editAsText כדי לשנות את תוכן הרכיבים כטקסט עשיר. במצב editAsText המערכת מתעלמת מאלמנטים שאינם טקסט (כמו InlineImage ו-HorizontalRule).
רכיבי צאצא שכלולים באופן מלא בטווח טקסט שנמחק מוסרים מהרכיב.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, 'An editAsText sample.'); body.insertHorizontalRule(0); body.insertParagraph(0, 'An example.'); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
חזרה
Text — גרסת טקסט של הרכיב הנוכחי
findElement(elementType)
מחפש בתוכן של הרכיב צאצא מסוג מסוים.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
element | Element | סוג הרכיב לחיפוש. |
חזרה
RangeElement|null — תוצאת חיפוש שמציינת את המיקום של רכיב החיפוש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findElement(elementType, from)
הפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
element | Element | סוג הרכיב לחיפוש. |
from | Range | תוצאת החיפוש שממנה מתחילים את החיפוש. |
חזרה
RangeElement|null — תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findText(searchPattern)
מחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
קבוצת משנה של תכונות הביטוי הרגולרי של JavaScript לא נתמכות באופן מלא, כמו קבוצות לכידה ומשני מצב.
תבנית הביטוי הרגולרי שצוינה מושווית באופן עצמאי לכל בלוק טקסט שנכלל ברכיב הנוכחי.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
search | String | התבנית לחיפוש |
חזרה
RangeElement|null – תוצאת חיפוש שמציינת את המיקום של טקסט החיפוש, או null אם אין התאמה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
מחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
קבוצת משנה של תכונות הביטוי הרגולרי של JavaScript לא נתמכות באופן מלא, כמו קבוצות לכידה ומשני מצב.
תבנית הביטוי הרגולרי שצוינה מושווית באופן עצמאי לכל בלוק טקסט שנכלל ברכיב הנוכחי.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
search | String | התבנית לחיפוש |
from | Range | תוצאת החיפוש שממנה רוצים לחפש |
חזרה
RangeElement|null — תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או null אם אין התאמה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getAttributes()
מאחזר את המאפיינים של האלמנט.
התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין של רכיב תקין, כאשר כל שם מאפיין תואם לפריט בספירה DocumentApp.Attribute.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
חזרה
Object – מאפייני הרכיב.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
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
getHeadingAttributes(paragraphHeading)
הפונקציה מאחזרת את קבוצת המאפיינים של ParagraphHeading שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
paragraph | Paragraph | הכותרת שצריך לאחזר את המאפיינים שלה. |
חזרה
Object – מיפוי של המאפיינים והערכים הנוכחיים שלהם.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getImages()
מאחזר את כל ה-InlineImages שמופיעים בקטע.
חזרה
InlineImage[]|null — תמונות של החלק.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getListItems()
מאחזר את כל ה-ListItems שמופיעים בקטע.
חזרה
ListItem[]|null — הפריטים ברשימת הקטעים.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getMarginBottom()
הפונקציה מאחזרת את השוליים התחתונים, בנקודות.
חזרה
Number|null – השוליים התחתונים, בנקודות.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getMarginLeft()
מאחזרת את השוליים השמאליים, בנקודות.
חזרה
Number|null — השוליים השמאליים, בנקודות.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getMarginRight()
מחזירה את השוליים הימניים.
חזרה
Number|null — השוליים הימניים, בנקודות.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getMarginTop()
מחזירה את השוליים העליונים.
חזרה
Number|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
getPageHeight()
מאחזר את גובה הדף, בנקודות.
חזרה
Number|null – גובה הדף, בנקודות.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getPageWidth()
מאחזר את רוחב הדף, בנקודות.
חזרה
Number|null — רוחב הדף, בנקודות.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getParagraphs()
מאחזר את כל Paragraphs שמופיעים בקטע (כולל ListItems).
חזרה
Paragraph[]|null – פסקאות הקטע.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getParent()
מאחזר את רכיב ההורה של הרכיב.
רכיב ההורה מכיל את הרכיב הנוכחי.
חזרה
ContainerElement|null – רכיב ההורה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getTables()
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 חדש באינדקס שצוין.
התג HorizontalRule ייכלל בתג Paragraph חדש.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב. |
חזרה
HorizontalRule — הקו האופקי החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
יוצרת ומכניסה InlineImage מבלוב התמונה שצוין, באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב. |
image | Blob | נתוני התמונה. |
חזרה
InlineImage – התמונה המוטמעת שנוספה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
הפונקציה מוסיפה את InlineImage שצוין באינדקס שצוין.
התמונה תהיה בתוך תג Paragraph חדש.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב. |
image | Inline | התמונה שרוצים להוסיף. |
חזרה
InlineImage – התמונה המוטמעת שנוספה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
הפונקציה מוסיפה את ListItem שצוין באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הערך. |
list | List | הפריט ברשימה שרוצים להוסיף. |
חזרה
ListItem – הפריט שנוסף לרשימה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertListItem(childIndex, text)
יוצרת ומכניסה ListItem חדש באינדקס שצוין, שמכיל את תוכן הטקסט שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הערך. |
text | String | תוכן הטקסט של הפריט ברשימה. |
חזרה
ListItem — הפריט החדש ברשימה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex)
יוצרת ומכניסה אובייקט PageBreak חדש באינדקס שצוין.
התג PageBreak ייכלל בתג Paragraph חדש.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב. |
חזרה
PageBreak — מעבר הדף החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex, pageBreak)
הפונקציה מוסיפה את PageBreak שצוין באינדקס שצוין.
התג PageBreak ייכלל בתג Paragraph חדש.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הרכיב. |
page | Page | מעבר הדף שרוצים להוסיף. |
חזרה
PageBreak – מעבר הדף שנוסף.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, paragraph)
הפונקציה מוסיפה את Paragraph שצוין באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הערך. |
paragraph | Paragraph | הפסקה שרוצים להוסיף. |
חזרה
Paragraph – הפיסקה שנוספה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
יוצרת ומכניסה Paragraph חדש באינדקס שצוין, שמכיל את תוכן הטקסט שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הערך. |
text | String | תוכן הטקסט של הפסקה. |
חזרה
Paragraph — הפיסקה החדשה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertTable(childIndex)
יוצרת ומכניסה אובייקט Table חדש באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הערך. |
חזרה
Table — הטבלה החדשה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertTable(childIndex, cells)
הפונקציה יוצרת תא חדש Table שמכיל את התאים שצוינו, ומכניסה אותו לאינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הערך. |
cells | String[][] | תוכן הטקסט של תאי הטבלה שרוצים להוסיף לטבלה החדשה. |
חזרה
Table — הטבלה החדשה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
insertTable(childIndex, table)
הפונקציה מוסיפה את Table שצוין באינדקס שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
child | Integer | האינדקס שבו יתווסף הערך. |
table | Table | הטבלה שרוצים להוסיף. |
חזרה
Table – הטבלה שנוספה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
removeChild(child)
replaceText(searchPattern, replacement)
הפונקציה מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת חלופית נתונה, באמצעות ביטויים רגולריים.
תבנית החיפוש מועברת כמחרוזת, ולא כאובייקט של ביטוי רגולרי ב-JavaScript. לכן, צריך לסמן בתו בריחה (escape) כל לוכסן הפוך בתבנית.
השיטה הזו משתמשת בספריית הביטויים הרגולריים RE2 של Google, שמגבילה את התחביר הנתמך.
תבנית הביטוי הרגולרי שצוינה מושווית באופן עצמאי לכל בלוק טקסט שנכלל ברכיב הנוכחי.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
search | String | תבנית הביטוי הרגולרי לחיפוש |
replacement | String | הטקסט שבו רוצים להשתמש להחלפה |
חזרה
Element – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setAttributes(attributes)
הגדרת המאפיינים של האלמנט.
פרמטר המאפיינים שצוין צריך להיות אובייקט שבו כל שם מאפיין הוא פריט בספירה DocumentApp.Attribute וכל ערך מאפיין הוא הערך החדש שיוחל.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
attributes | Object | המאפיינים של האלמנט. |
חזרה
Body – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setHeadingAttributes(paragraphHeading, attributes)
הגדרת המאפיינים של ParagraphHeading שצוין.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
paragraph | Paragraph | הכותרת שצריך להגדיר את המאפיינים שלה. |
attributes | Object | מיפוי של מאפיינים והערכים שצריך להגדיר להם. |
חזרה
Body – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setMarginBottom(marginBottom)
מגדיר את השוליים התחתונים, בנקודות.
פרמטרים
| שם | סוג | תיאור |
|---|---|---|
margin | Number | השוליים התחתונים, בנקודות. |
חזרה
Body – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setMarginLeft(marginLeft)
setMarginRight(marginRight)
setMarginTop(marginTop)
setPageHeight(pageHeight)
setPageWidth(pageWidth)
setText(text)
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 | סוג יישור הטקסט שרוצים להחיל |
חזרה
Body – הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents