רכיב כללי. התוכן של Document מיוצג כאלמנטים. לדוגמה, ListItem, Paragraph ו-Table הם רכיבים שמקבלים בירושה את כל השיטות שמוגדרות על ידי Element, כמו getType().
הטמעה של כיתות
| שם | תיאור קצר |
|---|---|
Body | התוכן של כרטיסייה במסמך Google Docs. |
Container | רכיב כללי שיכול להכיל רכיבים אחרים. |
Date | רכיב שמייצג תאריך בפורמט מסוים |
Equation | רכיב שמייצג ביטוי מתמטי. |
Equation | רכיב שמייצג פונקציה ב-Equation מתמטית. |
Equation | רכיב שמייצג מפריד פונקציות בביטוי מתמטי Equation. |
Equation | רכיב שמייצג סמל ב-Equation מתמטי. |
Footer | רכיב שמייצג קטע של כותרת תחתונה. |
Footnote | רכיב שמייצג הערת שוליים. |
Footnote | רכיב שמייצג קטע של הערות שוליים. |
Header | רכיב שמייצג קטע כותרת. |
Horizontal | רכיב שמייצג קו אופקי. |
Inline | רכיב שמייצג ציור מוטמע. |
Inline | רכיב שמייצג תמונה מוטמעת. |
List | רכיב שמייצג פריט ברשימה. |
Page | רכיב שמייצג מעבר דף. |
Paragraph | רכיב שמייצג פסקה. |
Person | רכיב שמייצג קישור לאדם. |
Rich | רכיב שמייצג קישור למקור מידע של Google, כמו קובץ ב-Drive או סרטון ב-YouTube. |
Table | רכיב שמייצג טבלה. |
Table | רכיב שמייצג תא בטבלה. |
Table | רכיב שמכיל תוכן עניינים. |
Table | רכיב שמייצג שורה בטבלה. |
Text | רכיב שמייצג אזור של טקסט עשיר. |
Unsupported | רכיב שמייצג אזור לא ידוע או אזור שלא ניתן להשפיע עליו באמצעות סקריפט, כמו מספר עמוד. |
Methods
תיעוד מפורט
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 – הרכיב הנוכחי עם הסוג שלו שמוגדר כ-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()
הפונקציה מחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
כל רכיבי הצאצא שקיימים ברכיב מועתקים גם הם. לרכיב החדש אין רכיב אב.
חזרה
Element — העותק החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
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
getNextSibling()
מאחזר את רכיב האח הבא של הרכיב.
לרכיב הבא באותה רמה יש את אותו רכיב אב והוא מופיע אחרי הרכיב הנוכחי.
חזרה
Element|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
getPreviousSibling()
אחזור של רכיב האחות הקודם של הרכיב.
לאח או לאחות הקודמים יש את אותו רכיב אב והם קודמים לרכיב הנוכחי.
חזרה
Element|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
isAtDocumentEnd()
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();
חזרה
Element|null – הרכיב הממוזג.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
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(); }
חזרה
Element|null — הרכיב שהוסר.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
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 | המאפיינים של האלמנט. |
חזרה
Element – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents