רכיב שמייצג קישור לאדם. קישור לאדם הוא כתובת אימייל, ויכול להיות שיהיה משויך לכתובת גם שם. אם השם מוגדר, הוא השם שמוצג בגוף המסמך.
Methods
| שיטה | סוג הערך שמוחזר | תיאור קצר |
|---|---|---|
copy() | Person | הפונקציה מחזירה עותק מנותק ועמוק של הרכיב הנוכחי. |
get | Object | מאחזר את המאפיינים של האלמנט. |
get | String | מחזירה את כתובת האימייל של האדם. |
get | String|null | הפונקציה מחזירה את השם לתצוגה של האדם, אם הוא מוגדר. |
get | Element|null | מאחזר את רכיב האח הבא של הרכיב. |
get | Container | מאחזר את רכיב ההורה של הרכיב. |
get | Element|null | אחזור של רכיב האחות הקודם של הרכיב. |
get | Element | אחזור Element של הרכיב. |
is | Boolean | קובע אם הרכיב נמצא בסוף Document. |
merge() | Person|null | מיזוג הרכיב עם הרכיב הקודם מאותו סוג. |
remove | Person|null | הפונקציה מסירה את הרכיב מהרכיב ההורה שלו. |
set | Person | הגדרת המאפיינים של האלמנט. |
תיעוד מפורט
copy()
הפונקציה מחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
כל רכיבי הצאצא שקיימים ברכיב מועתקים גם הם. לרכיב החדש אין רכיב אב.
חזרה
Person — העותק החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
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
getEmail()
מחזירה את כתובת האימייל של האדם.
חזרה
String — כתובת האימייל של האדם.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getName()
הפונקציה מחזירה את השם לתצוגה של האדם, אם הוא מוגדר.
חזרה
String|null – השם לתצוגה של הקישור לאדם, או null אם הרכיב מציג את כתובת האימייל במקום זאת.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
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();
חזרה
Person|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(); }
חזרה
Person|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 | המאפיינים של האלמנט. |
חזרה
Person – הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents