רכיב כללי. תכנים של Document
מיוצגים כרכיבים. לדוגמה, ListItem
, Paragraph
ו-Table
הם רכיבים ויורשים את כל השיטות שהוגדרו על ידי Element
, למשל getType()
.
הטמעה של כיתות
שם | תיאור קצר |
---|---|
Body | רכיב שמייצג גוף מסמך. |
ContainerElement | רכיב גנרי שעשוי להכיל רכיבים אחרים. |
Date | רכיב שמייצג תאריך בפורמט |
Equation | רכיב שמייצג ביטוי מתמטי. |
EquationFunction | רכיב שמייצג פונקציה בפונקציה Equation מתמטית. |
EquationFunctionArgumentSeparator | רכיב שמייצג מפריד פונקציה בפונקציה Equation מתמטית. |
EquationSymbol | רכיב שמייצג סמל בפונקציה Equation מתמטית. |
FooterSection | רכיב שמייצג קטע של כותרת תחתונה. |
Footnote | רכיב שמייצג הערת שוליים. |
FootnoteSection | רכיב שמייצג קטע של הערת שוליים. |
HeaderSection | רכיב שמייצג קטע של כותרת. |
HorizontalRule | רכיב שמייצג כלל אופקי. |
InlineDrawing | רכיב שמייצג שרטוט מוטמע. |
InlineImage | רכיב שמייצג תמונה מוטמעת. |
ListItem | רכיב שמייצג פריט ברשימה. |
PageBreak | רכיב שמייצג מעבר דף. |
Paragraph | רכיב שמייצג פסקה. |
Person | רכיב שמייצג קישור לאדם. |
RichLink | רכיב שמייצג קישור למשאב של Google, כמו קובץ ב-Drive או סרטון ב-YouTube. |
Table | רכיב שמייצג טבלה. |
TableCell | רכיב שמייצג תא בטבלה. |
TableOfContents | רכיב שמכיל תוכן עניינים. |
TableRow | רכיב שמייצג שורה בטבלה. |
Text | רכיב שמייצג אזור של טקסט עשיר. |
UnsupportedElement | רכיב שמייצג אזור לא ידוע או שלא ניתן להשפיע עליו מסקריפט, כמו מספר דף. |
שיטות
תיעוד מפורט
asBody()
מחזירה את הרכיב הנוכחי כ-Body
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
Body
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asDate()
מחזירה את הרכיב הנוכחי כ-Date
.
אם יודעים שרכיב הוא Date
, משתמשים בשיטה הזו כדי להגדיר את הסוג שלו כ-Date
. כך תוכלו לראות בהשלמה האוטומטית בעורך Apps Script את השיטות שבהן אפשר להשתמש עם Date
.
החזרות
Date
- הרכיב הנוכחי שהסוג שלו מוגדר כ-Date
.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asEquation()
מחזירה את הרכיב הנוכחי כ-Equation
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
Equation
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asEquationFunction()
מחזירה את הרכיב הנוכחי כ-EquationFunction
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
EquationFunction
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asEquationFunctionArgumentSeparator()
מחזירה את הרכיב הנוכחי כ-EquationFunctionArgumentSeparator
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
EquationFunctionArgumentSeparator
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asEquationSymbol()
מחזירה את הרכיב הנוכחי כ-EquationSymbol
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
EquationSymbol
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asFootnote()
מחזירה את הרכיב הנוכחי כ-Footnote
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
Footnote
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asFootnoteSection()
מחזירה את הרכיב הנוכחי כ-FootnoteSection
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
FootnoteSection
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asHeaderSection()
מחזירה את הרכיב הנוכחי כ-HeaderSection
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
HeaderSection
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asHorizontalRule()
מחזירה את הרכיב הנוכחי כ-HorizontalRule
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
HorizontalRule
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asInlineDrawing()
מחזירה את הרכיב הנוכחי כ-InlineDrawing
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
InlineDrawing
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asInlineImage()
מחזירה את הרכיב הנוכחי כ-InlineImage
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
InlineImage
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asListItem()
מחזירה את הרכיב הנוכחי כ-ListItem
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
ListItem
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asPageBreak()
מחזירה את הרכיב הנוכחי כ-PageBreak
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
PageBreak
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asParagraph()
מחזירה את הרכיב הנוכחי כ-Paragraph
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
Paragraph
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asPerson()
מחזירה את הרכיב הנוכחי כ-Person
.
אם יודעים שרכיב הוא Person
, משתמשים בשיטה הזו כדי להגדיר את הסוג שלו כאדם.
כך תוכלו לראות בהשלמה האוטומטית בעורך Apps Script את השיטות שבהן אפשר להשתמש עם רכיב אישי.
החזרות
Person
- הרכיב הנוכחי שהסוג שלו מוגדר כ-Person
.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asRichLink()
מחזירה את הרכיב הנוכחי כ-RichLink
, לדוגמה, קישור לקובץ Google Sheets.
אם יודעים שרכיב הוא RichLink
, משתמשים בשיטה הזו כדי להגדיר את הסוג שלו כ-RichLink
. כך תוכלו לראות בהשלמה האוטומטית בעורך Apps Script את השיטות שבהן אפשר להשתמש עם RichLink
.
החזרות
RichLink
- הרכיב הנוכחי שהסוג שלו מוגדר כ-RichLink
.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asTable()
מחזירה את הרכיב הנוכחי כ-Table
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
Table
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asTableCell()
מחזירה את הרכיב הנוכחי כ-TableCell
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
TableCell
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asTableOfContents()
מחזירה את הרכיב הנוכחי כ-TableOfContents
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
TableOfContents
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asTableRow()
מחזירה את הרכיב הנוכחי כ-TableRow
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
TableRow
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
asText()
מחזירה את הרכיב הנוכחי כ-Text
.
כדאי להשתמש בשיטה הזו כדי לעזור להשלמה האוטומטית כאשר ידוע שרכיב מסוים הוא מסוג מסוים.
החזרות
Text
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
copy()
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
getNextSibling()
getParent()
אחזור של רכיב ההורה של הרכיב.
רכיב ההורה מכיל את הרכיב הנוכחי.
החזרות
ContainerElement
- רכיב ההורה.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
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
isAtDocumentEnd()
merge()
ממזג את הרכיב עם האח הקודם מאותו הסוג.
אפשר למזג רק רכיבים של אותו ElementType
. כל רכיבי הצאצא שנכללים ברכיב הנוכחי מועברים אל הרכיב האח הקודם.
הרכיב הנוכחי יוסר מהמסמך.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var 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. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
החזרות
Element
- הרכיב שמוזג.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
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(); }
החזרות
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 | מאפייני הרכיב. |
החזרות
Element
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents