רכיב שמייצג קטע של כותרת תחתונה. Document
מכיל בדרך כלל FooterSection
אחד לכל היותר. השדה FooterSection
עשוי להכיל רכיבי ListItem
, Paragraph
ו-Table
. למידע נוסף על מבנה מסמכים, אפשר לעיין במדריך להרחבת Google Docs.
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
appendHorizontalRule() | HorizontalRule | יצירה וצירוף של HorizontalRule חדש. |
appendImage(image) | InlineImage | יצירה וצירוף של InlineImage חדש מה-blob של התמונה שצוין. |
appendImage(image) | InlineImage | הפונקציה הזאת מצרפת את הערך InlineImage . |
appendListItem(listItem) | ListItem | הפונקציה הזאת מצרפת את הערך ListItem . |
appendListItem(text) | ListItem | יצירה וצירוף של ListItem חדש שמכיל את תוכן הטקסט שצוין. |
appendParagraph(paragraph) | Paragraph | הפונקציה הזאת מצרפת את הערך Paragraph . |
appendParagraph(text) | Paragraph | יצירה וצירוף של Paragraph חדש שמכיל את תוכן הטקסט שצוין. |
appendTable() | Table | יצירה וצירוף של Table חדש. |
appendTable(cells) | Table | הפונקציה מצרפת Table חדש שמכיל TableCell לכל ערך מחרוזת שצוין. |
appendTable(table) | Table | הפונקציה הזאת מצרפת את הערך Table . |
clear() | FooterSection | ניקוי התוכן של הרכיב. |
copy() | FooterSection | מחזירה עותק מנותק ועמוק של הרכיב הנוכחי. |
editAsText() | Text | משיג את גרסת Text של הרכיב הנוכחי, לצורך עריכה. |
findElement(elementType) | RangeElement | מחפשת צאצא מהסוג שצוין. |
findElement(elementType, from) | RangeElement | מחפשת בתוכן הרכיב צאצא מהסוג שצוין, החל מה-RangeElement שצוין. |
findText(searchPattern) | RangeElement | מחפש את תוכן הרכיב כדי לאתר את דפוס הטקסט שצוין באמצעות ביטויים רגולריים. |
findText(searchPattern, from) | RangeElement | מחפש את תוכן הרכיב לפי דפוס הטקסט שצוין, החל מתוצאת חיפוש נתונה. |
getAttributes() | Object | מאחזר את מאפייני הרכיב. |
getChild(childIndex) | Element | מאחזר את רכיב הצאצא באינדקס הצאצא שצוין. |
getChildIndex(child) | Integer | מאחזר את אינדקס הצאצא של רכיב הצאצא שצוין. |
getImages() | InlineImage[] | מאחזר את כל InlineImages שנכללו בקטע. |
getListItems() | ListItem[] | מאחזר את כל ListItems שנכללו בקטע. |
getNumChildren() | Integer | אחזור מספר הילדים. |
getParagraphs() | Paragraph[] | מאחזר את כל Paragraphs שנכללו בקטע (כולל ListItems ). |
getParent() | ContainerElement | אחזור של רכיב ההורה של הרכיב. |
getTables() | Table[] | מאחזר את כל Tables שנכללו בקטע. |
getText() | String | מאחזר את התוכן של הרכיב כמחרוזת טקסט. |
getTextAlignment() | TextAlignment | הפונקציה הזו משיגה את היישור של הטקסט. |
getType() | ElementType | אחזור ה-ElementType של הרכיב. |
insertHorizontalRule(childIndex) | HorizontalRule | יוצרת ומוסיפה HorizontalRule חדש באינדקס שצוין. |
insertImage(childIndex, image) | InlineImage | הפונקציה יוצרת ומוסיפה InlineImage מה-blob של התמונה שצוין, באינדקס
שצוין. |
insertImage(childIndex, image) | InlineImage | הפונקציה מוסיפה את הערך הנתון InlineImage באינדקס שצוין. |
insertListItem(childIndex, listItem) | ListItem | הפונקציה מוסיפה את הערך הנתון ListItem באינדקס שצוין. |
insertListItem(childIndex, text) | ListItem | יוצרת ומוסיפה ListItem חדש באינדקס שצוין, שמכיל את תוכן הטקסט שצוין. |
insertParagraph(childIndex, paragraph) | Paragraph | הפונקציה מוסיפה את הערך הנתון Paragraph באינדקס שצוין. |
insertParagraph(childIndex, text) | Paragraph | יוצרת ומוסיפה Paragraph חדש באינדקס שצוין, שמכיל את תוכן הטקסט שצוין. |
insertTable(childIndex) | Table | יוצרת ומוסיפה Table חדש באינדקס שצוין. |
insertTable(childIndex, cells) | Table | יוצרת ומוסיפה Table חדש שמכיל את התאים שצוינו, באינדקס שצוין. |
insertTable(childIndex, table) | Table | הפונקציה מוסיפה את הערך הנתון Table באינדקס שצוין. |
removeChild(child) | FooterSection | מסיר את רכיב הצאצא שצוין. |
removeFromParent() | FooterSection | מסיר את הרכיב מההורה שלו. |
replaceText(searchPattern, replacement) | Element | מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים. |
setAttributes(attributes) | FooterSection | מגדיר את מאפייני הרכיב. |
setText(text) | FooterSection | מגדיר את התוכן כטקסט פשוט. |
setTextAlignment(textAlignment) | FooterSection | הגדרת יישור הטקסט. |
תיעוד מפורט
appendHorizontalRule()
יצירה וצירוף של HorizontalRule
חדש.
ה-HorizontalRule
ייכלל ב-Paragraph
חדש.
החזרות
HorizontalRule
- הכלל האופקי החדש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
יצירה וצירוף של InlineImage
חדש מה-blob של התמונה שצוין.
התמונה תצורף ל-Paragraph
חדש.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
image | BlobSource | נתוני התמונה |
החזרות
InlineImage
– התמונה המצורפת
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
הפונקציה הזאת מצרפת את הערך InlineImage
.
ה-InlineImage
ייכלל ב-Paragraph
חדש.
יש להשתמש בגרסה הזו של appendImage
כשמוסיפים עותק של InlineImage
קיים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
image | InlineImage | נתוני התמונה |
החזרות
InlineImage
– התמונה המצורפת
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(listItem)
הפונקציה הזאת מצרפת את הערך ListItem
.
יש להשתמש בגרסה הזו של appendListItem
כשמוסיפים עותק של ListItem
קיים.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
listItem | ListItem | את הפריט שצריך לצרף לרשימה |
החזרות
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
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()
מחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
גם רכיבי צאצא הקיימים ברכיב יועתקו. לרכיב החדש אין הורה.
החזרות
FooterSection
- העותק החדש.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
משיג את גרסת Text
של הרכיב הנוכחי, לצורך עריכה.
שימוש בפונקציה editAsText
לשינוי תוכן הרכיבים כטקסט עשיר. המצב editAsText
מתעלם מאלמנטים שאינם טקסט (כמו InlineImage
ו-HorizontalRule
).
רכיבי צאצא שנכללים במלואם בטווח טקסט שנמחק, מוסרים מהרכיב.
var body = DocumentApp.getActiveDocument().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, "An editAsText sample."); body.insertHorizontalRule(0); body.insertParagraph(0, "An example."); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
החזרות
Text
– גרסת טקסט של הרכיב הנוכחי
findElement(elementType)
מחפשת צאצא מהסוג שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
elementType | ElementType | סוג הרכיב שיש לחפש |
החזרות
RangeElement
- תוצאת חיפוש שמציינת את המיקום של רכיב החיפוש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
מחפשת בתוכן הרכיב צאצא מהסוג שצוין, החל מה-RangeElement
שצוין.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
פרמטרים
שם | תיאור | התיאור |
---|---|---|
elementType | ElementType | סוג הרכיב שיש לחפש |
from | RangeElement | תוצאת החיפוש שממנה יש לחפש |
החזרות
RangeElement
- תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
מחפש את תוכן הרכיב כדי לאתר את דפוס הטקסט שצוין באמצעות ביטויים רגולריים.
אין תמיכה מלאה בקבוצת משנה של תכונות של ביטויים רגולריים ב-JavaScript, כמו קבוצות צילום ומגבילי מצב.
הדפוס של הביטוי הרגולרי שסופק מותאם בנפרד לכל גוש טקסט שכלול ברכיב הנוכחי.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
searchPattern | String | הדפוס שצריך לחפש |
החזרות
RangeElement
- תוצאת חיפוש שמציינת את מיקום הטקסט לחיפוש, או הערך null אם אין
התאמה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
מחפש את תוכן הרכיב לפי דפוס הטקסט שצוין, החל מתוצאת חיפוש נתונה.
אין תמיכה מלאה בקבוצת משנה של תכונות של ביטויים רגולריים ב-JavaScript, כמו קבוצות צילום ומגבילי מצב.
הדפוס של הביטוי הרגולרי שסופק מותאם בנפרד לכל גוש טקסט שכלול ברכיב הנוכחי.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
searchPattern | String | הדפוס שצריך לחפש |
from | RangeElement | תוצאת החיפוש שממנה יש לחפש |
החזרות
RangeElement
- תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או הערך null אם אין התאמה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
מאחזר את מאפייני הרכיב.
התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין חוקי של רכיב, כאשר כל
שם המאפיין תואם לפריט במונה DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
החזרות
Object
- מאפייני הרכיב.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
מאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. var firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText("This is the first paragraph."); }
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס של רכיב הצאצא שצריך לאחזר |
החזרות
Element
- רכיב הצאצא באינדקס שצוין
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
מאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
child | Element | את רכיב הצאצא שעבורו יש לאחזר את האינדקס |
החזרות
Integer
- אינדקס הצאצא
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getImages()
מאחזר את כל InlineImages
שנכללו בקטע.
החזרות
InlineImage[]
– תמונות הקטע
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getListItems()
מאחזר את כל ListItems
שנכללו בקטע.
החזרות
ListItem[]
– הפריטים ברשימת הקטעים
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
אחזור מספר הילדים.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
החזרות
Integer
– מספר הילדים
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParagraphs()
מאחזר את כל Paragraphs
שנכללו בקטע (כולל ListItems
).
החזרות
Paragraph[]
- הפסקאות בקטע
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
אחזור של רכיב ההורה של הרכיב.
רכיב ההורה מכיל את הרכיב הנוכחי.
החזרות
ContainerElement
- רכיב ההורה.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
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
אם הטקסט מכיל סוגים שונים של יישור טקסט או אם יישור הטקסט מעולם לא הוגדר
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
אחזור ה-ElementType
של הרכיב.
השתמשו בפונקציה getType()
כדי לקבוע את הסוג המדויק של רכיב נתון.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
החזרות
ElementType
- סוג הרכיב.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
יוצרת ומוסיפה HorizontalRule
חדש באינדקס שצוין.
ה-HorizontalRule
ייכלל ב-Paragraph
חדש.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
החזרות
HorizontalRule
- הכלל האופקי החדש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
הפונקציה יוצרת ומוסיפה InlineImage
מה-blob של התמונה שצוין, באינדקס
שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
image | BlobSource | נתוני התמונה |
החזרות
InlineImage
– התמונה המוטבעת שהוכנסה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
הפונקציה מוסיפה את הערך הנתון InlineImage
באינדקס שצוין.
התמונה תצורף ל-Paragraph
חדש.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
image | InlineImage | התמונה להוספה |
החזרות
InlineImage
– התמונה המוטבעת שהוכנסה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
הפונקציה מוסיפה את הערך הנתון ListItem
באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שיש להכניס |
listItem | ListItem | פריט הרשימה להוספה |
החזרות
ListItem
– הפריט שנוסף ברשימה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, text)
יוצרת ומוסיפה ListItem
חדש באינדקס שצוין, שמכיל את תוכן הטקסט שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שיש להכניס |
text | String | תוכן הטקסט של פריט הרשימה |
החזרות
ListItem
– הפריט החדש ברשימה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, paragraph)
הפונקציה מוסיפה את הערך הנתון Paragraph
באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שיש להכניס |
paragraph | Paragraph | הפסקה שיש להוסיף |
החזרות
Paragraph
– הפסקה שהוכנסה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
יוצרת ומוסיפה Paragraph
חדש באינדקס שצוין, שמכיל את תוכן הטקסט שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שיש להכניס |
text | String | תוכן הטקסט של הפסקה |
החזרות
Paragraph
- הפסקה החדשה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex)
insertTable(childIndex, cells)
יוצרת ומוסיפה Table
חדש שמכיל את התאים שצוינו, באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שיש להכניס |
cells | String[][] | תוכן הטקסט של תאי הטבלה להוספה לטבלה החדשה |
החזרות
Table
– הטבלה החדשה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertTable(childIndex, table)
הפונקציה מוסיפה את הערך הנתון Table
באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שיש להכניס |
table | Table | הטבלה להוספה |
החזרות
Table
– הטבלה שהוכנסה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
מסיר את רכיב הצאצא שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
child | Element | את רכיב הצאצא להסרה |
החזרות
FooterSection
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
מסיר את הרכיב מההורה שלו.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
החזרות
FooterSection
- הרכיב שהוסר.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים.
דפוס החיפוש מועבר כמחרוזת, ולא כאובייקט של ביטוי רגולרי ב-JavaScript. לכן, תצטרכו להשתמש בתו בריחה (escape) של כל לוכסן הפוך בתבנית.
בשיטה הזו נעשה שימוש בספריית הביטויים הרגולריים RE2 של Google, שמגבילה את התחביר הנתמך.
הדפוס של הביטוי הרגולרי שסופק מותאם בנפרד לכל גוש טקסט שכלול ברכיב הנוכחי.
var body = DocumentApp.getActiveDocument().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
פרמטרים
שם | תיאור | התיאור |
---|---|---|
searchPattern | String | את הדפוס הרגולרי שצריך לחפש |
replacement | String | בטקסט שישמש כתחליף |
החזרות
Element
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
מגדיר את מאפייני הרכיב.
פרמטר המאפיינים שצוין חייב להיות אובייקט שבו כל שם מאפיין הוא פריט
בספירה של DocumentApp.Attribute
וכל ערך של מאפיין הוא הערך החדש שיש להחיל.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
פרמטרים
שם | תיאור | התיאור |
---|---|---|
attributes | Object | מאפייני הרכיב. |
החזרות
FooterSection
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
מגדיר את התוכן כטקסט פשוט.
הערה: התוכן הקיים נמחק.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
text | String | תוכן הטקסט החדש |
החזרות
FooterSection
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
הגדרת יישור הטקסט. סוגי ההתאמה הזמינים הם DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
ו-DocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
פרמטרים
שם | תיאור | התיאור |
---|---|---|
textAlignment | TextAlignment | סוג היישור של הטקסט שצריך להחיל |
החזרות
FooterSection
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents