רכיב שמייצג קישור למשאב של Google, כמו קובץ ב-Drive או סרטון ב-YouTube.
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
copy() | RichLink | מחזירה עותק מנותק ועמוק של הרכיב הנוכחי. |
getAttributes() | Object | מאחזר את מאפייני הרכיב. |
getMimeType() | String | מחזירה את סוג ה-MIME של הקישור, שזמין כאשר הפריט הוא קישור לקובץ Drive וגם null . |
getNextSibling() | Element | שולפת את הרכיב האח הבא של הרכיב. |
getParent() | ContainerElement | אחזור של רכיב ההורה של הרכיב. |
getPreviousSibling() | Element | אחזור הרכיב האח הקודם של הרכיב. |
getTitle() | String | מחזירה את הכותרת המוצגת של הקישור. |
getType() | ElementType | אחזור ה-ElementType של הרכיב. |
getUrl() | String | מחזירה את כתובת ה-URL של המשאב. |
isAtDocumentEnd() | Boolean | קובע אם הרכיב נמצא בסוף Document . |
merge() | RichLink | ממזג את הרכיב עם האח הקודם מאותו הסוג. |
removeFromParent() | RichLink | מסיר את הרכיב מההורה שלו. |
setAttributes(attributes) | RichLink | מגדיר את מאפייני הרכיב. |
תיעוד מפורט
copy()
מחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
גם רכיבי צאצא הקיימים ברכיב יועתקו. לרכיב החדש אין הורה.
החזרות
RichLink
- העותק החדש.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
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
getMimeType()
מחזירה את סוג ה-MIME של הקישור, שזמין כאשר הפריט הוא קישור לקובץ Drive וגם null
.
לדוגמה, אם הקישור מפנה לקובץ Google Docs, הפונקציה הזו תחזיר את המחרוזת
application/vnd.google-apps.document
.
החזרות
String
- סוג ה-MIME של הקישור, אם הוא זמין.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
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()
getTitle()
מחזירה את הכותרת המוצגת של הקישור. השם הזה תואם לשם של המשאב המקושר בזמן ההוספה או העדכון האחרון של הקישור. לדוגמה, אם הקישור הזה מפנה למסמך Google Docs בשם 'Analysis', הפונקציה הזו מחזירה את הערך Analysis
.
החזרות
String
– השם המוצג של הקישור.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
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
getUrl()
מחזירה את כתובת ה-URL של המשאב.
החזרות
String
- כתובת ה-URL של המשאב.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
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();
החזרות
RichLink
- הרכיב שמוזג.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
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(); }
החזרות
RichLink
- הרכיב שהוסר.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
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 | מאפייני הרכיב. |
החזרות
RichLink
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents