רכיב שמייצג קישור למשאב של 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 doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.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()
אחזור של רכיב האח הבא של הרכיב.
לאחות הבאה יש אותו הורה והוא עוקב אחר הרכיב הנוכחי.
חזרה
Element
— רכיב האח הבא.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
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
getPreviousSibling()
אחזור של רכיב האח הקודם של הרכיב.
לאחות הקודמת יש אותו הורה ולפני הרכיב הנוכחי.
חזרה
Element
— רכיב האח הקודם.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTitle()
מחזירה את הכותרת המוצגת של הקישור. הכותרת הזו תואמת לכותרת של המשאב המקושר
מועד הוספת הקישור או העדכון האחרון של הקישור. לדוגמה, אם הקישור הזה מפנה
במסמך Docs בשם 'ניתוח', הפונקציה מחזירה את הערך Analysis
.
חזרה
String
– השם המוצג של הקישור.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
מאחזר את ElementType
של הרכיב.
משתמשים בפונקציה getType()
כדי לקבוע את הסוג המדויק של רכיב נתון.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Obtain the first element in the active tab's 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()
הפונקציה קובעת אם הרכיב נמצא בסוף Document
.
חזרה
Boolean
– האם הרכיב נמצא בסוף הכרטיסייה.
אישור
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
ממזג את הרכיב עם האח הקודם מאותו סוג.
אפשר למזג רק רכיבים של אותו ElementType
. רכיבי צאצא שנכללים
הרכיב הנוכחי מועבר לרכיב האח הקודם.
הרכיב הנוכחי יוסר מהמסמך.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. 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 doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab() var body = documentTab.getBody(); // Remove all images in the active tab's 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 doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.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