רכיב שמייצג פריט ברשימה. השדה ListItem
הוא Paragraph
שמשויך למזהה רשימה. ListItem
עשוי להכיל את הרכיבים Equation
, Footnote
, HorizontalRule
, InlineDrawing
, InlineImage
, PageBreak
ו-Text
. למידע נוסף על מבנה מסמכים, אפשר לעיין במדריך להרחבת Google Docs.
ListItems
לא יכול להכיל תווים בשורה החדשה. תווים בשורה החדשה ("\n") מומרים לתווים של מעבר שורה ("\r").
ListItems
עם אותו מזהה רשימה שייכים לאותה רשימה וממוספרים בהתאם.
הערכים של ListItems
ברשימה נתונה לא חייבים להיות סמוכים למסמך, ואפילו לא
מכילים את אותו רכיב הורה. שני פריטים ששייכים לאותה רשימה יכולים להתקיים במקום כלשהו במסמך, תוך שמירה על מספור עוקב, כפי שניתן לראות בדוגמה הבאה:
var body = DocumentApp.getActiveDocument().getBody(); // Append a new list item to the body. var item1 = body.appendListItem('Item 1'); // Log the new list item's list ID. Logger.log(item1.getListId()); // Append a table after the list item. body.appendTable([ ['Cell 1', 'Cell 2'] ]); // Append a second list item with the same list ID. The two items are treated as the same list, // despite not being consecutive. var item2 = body.appendListItem('Item 2'); item2.setListId(item1);
שיטות
שיטה | סוג הערך שמוחזר | תיאור קצר |
---|---|---|
addPositionedImage(image) | PositionedImage | יצירה והוספה של PositionedImage חדש מתוך ה-blob של התמונה שצוין. |
appendHorizontalRule() | HorizontalRule | יצירה וצירוף של HorizontalRule חדש. |
appendInlineImage(image) | InlineImage | יצירה וצירוף של InlineImage חדש מה-blob של התמונה שצוין. |
appendInlineImage(image) | InlineImage | הפונקציה הזאת מצרפת את הערך InlineImage . |
appendPageBreak() | PageBreak | יצירה וצירוף של PageBreak חדש. |
appendPageBreak(pageBreak) | PageBreak | הפונקציה הזאת מצרפת את הערך PageBreak . |
appendText(text) | Text | יוצר ומוסיף רכיב Text חדש עם התוכן שצוין. |
appendText(text) | Text | צירוף של הרכיב Text הנתון. |
clear() | ListItem | ניקוי התוכן של הרכיב. |
copy() | ListItem | מחזירה עותק מנותק ועמוק של הרכיב הנוכחי. |
editAsText() | Text | משיג את גרסת Text של הרכיב הנוכחי, לצורך עריכה. |
findElement(elementType) | RangeElement | מחפשת צאצא מהסוג שצוין. |
findElement(elementType, from) | RangeElement | מחפשת בתוכן הרכיב צאצא מהסוג שצוין, החל מה-RangeElement שצוין. |
findText(searchPattern) | RangeElement | מחפש את תוכן הרכיב כדי לאתר את דפוס הטקסט שצוין באמצעות ביטויים רגולריים. |
findText(searchPattern, from) | RangeElement | מחפש את תוכן הרכיב לפי דפוס הטקסט שצוין, החל מתוצאת חיפוש נתונה. |
getAlignment() | HorizontalAlignment | מאחזר את HorizontalAlignment . |
getAttributes() | Object | מאחזר את מאפייני הרכיב. |
getChild(childIndex) | Element | מאחזר את רכיב הצאצא באינדקס הצאצא שצוין. |
getChildIndex(child) | Integer | מאחזר את אינדקס הצאצא של רכיב הצאצא שצוין. |
getGlyphType() | GlyphType | מאחזר את GlyphType של פריט הרשימה. |
getHeading() | ParagraphHeading | מאחזר את ParagraphHeading . |
getIndentEnd() | Number | אחזור של כניסת הסוף, בנקודות. |
getIndentFirstLine() | Number | אחזור של כניסת השורה הראשונה, בנקודות. |
getIndentStart() | Number | אחזור של התחלת הכניסה. |
getLineSpacing() | Number | מאחזר את המרווח בין השורות, בנקודות. |
getLinkUrl() | String | אחזור של כתובת ה-URL של הקישור. |
getListId() | String | אחזור של מזהה הרשימה. |
getNestingLevel() | Integer | מאחזר את רמת הקינון של פריט ברשימה. |
getNextSibling() | Element | שולפת את הרכיב האח הבא של הרכיב. |
getNumChildren() | Integer | אחזור מספר הילדים. |
getParent() | ContainerElement | אחזור של רכיב ההורה של הרכיב. |
getPositionedImage(id) | PositionedImage | הפונקציה מקבלת PositionedImage לפי מזהה התמונה. |
getPositionedImages() | PositionedImage[] | משייך את כל PositionedImage האובייקטים לפסקה. |
getPreviousSibling() | Element | אחזור הרכיב האח הקודם של הרכיב. |
getSpacingAfter() | Number | מאחזרת את הריווח אחרי הרכיב, בנקודות. |
getSpacingBefore() | Number | אחזור הריווח לפני הרכיב, בנקודות. |
getText() | String | מאחזר את התוכן של הרכיב כמחרוזת טקסט. |
getTextAlignment() | TextAlignment | הפונקציה הזו משיגה את היישור של הטקסט. |
getType() | ElementType | אחזור ה-ElementType של הרכיב. |
insertHorizontalRule(childIndex) | HorizontalRule | יוצרת ומוסיפה HorizontalRule באינדקס שצוין. |
insertInlineImage(childIndex, image) | InlineImage | הפונקציה יוצרת ומוסיפה InlineImage חדש מה-blob של התמונה שצוין, באינדקס
שצוין. |
insertInlineImage(childIndex, image) | InlineImage | הפונקציה מוסיפה את הערך הנתון InlineImage באינדקס שצוין. |
insertPageBreak(childIndex) | PageBreak | יוצרת ומוסיפה PageBreak חדש באינדקס שצוין. |
insertPageBreak(childIndex, pageBreak) | PageBreak | הפונקציה מוסיפה את הערך הנתון PageBreak באינדקס שצוין. |
insertText(childIndex, text) | Text | יוצרת ומוסיפה רכיב טקסט חדש באינדקס שצוין. |
insertText(childIndex, text) | Text | הוספת הרכיב Text הנתון לאינדקס שצוין, עם תוכן הטקסט שצוין. |
isAtDocumentEnd() | Boolean | קובע אם הרכיב נמצא בסוף Document . |
isLeftToRight() | Boolean | מאחזר את ההגדרה משמאל לימין. |
merge() | ListItem | ממזג את הרכיב עם האח הקודם מאותו הסוג. |
removeChild(child) | ListItem | מסיר את רכיב הצאצא שצוין. |
removeFromParent() | ListItem | מסיר את הרכיב מההורה שלו. |
removePositionedImage(id) | Boolean | מסירה את PositionedImage לפי מזהה התמונה. |
replaceText(searchPattern, replacement) | Element | מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים. |
setAlignment(alignment) | ListItem | מגדיר את HorizontalAlignment . |
setAttributes(attributes) | ListItem | מגדיר את מאפייני הרכיב. |
setGlyphType(glyphType) | ListItem | מגדיר את GlyphType של פריט הרשימה. |
setHeading(heading) | ListItem | מגדיר את ParagraphHeading . |
setIndentEnd(indentEnd) | ListItem | המדיניות מגדירה את כניסת הפיסקה הסופית, בנקודות. |
setIndentFirstLine(indentFirstLine) | ListItem | מגדיר את כניסת השורה הראשונה, בנקודות. |
setIndentStart(indentStart) | ListItem | המדיניות הזו מגדירה את הכניסה של כניסת פיסקה, בנקודות. |
setLeftToRight(leftToRight) | ListItem | קובעת את ההגדרה משמאל לימין. |
setLineSpacing(multiplier) | ListItem | מגדיר את המרווח בין השורות, ככמות שמציינת את מספר השורות שישמשו לריווח. |
setLinkUrl(url) | ListItem | מגדיר את כתובת האתר של הקישור. |
setListId(listItem) | ListItem | מגדיר את מזהה הרשימה. |
setNestingLevel(nestingLevel) | ListItem | מגדיר את רמת הקינון של פריט ברשימה. |
setSpacingAfter(spacingAfter) | ListItem | מגדיר את הריווח אחרי הרכיב, בנקודות. |
setSpacingBefore(spacingBefore) | ListItem | מגדיר את הריווח לפני הרכיב, בנקודות. |
setText(text) | void | מגדיר את התוכן של פריט ברשימה כטקסט. |
setTextAlignment(textAlignment) | ListItem | הגדרת יישור הטקסט. |
תיעוד מפורט
addPositionedImage(image)
יצירה והוספה של PositionedImage
חדש מתוך ה-blob של התמונה שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
image | BlobSource | נתוני התמונה |
החזרות
PositionedImage
– התמונה המוצבת החדשה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendHorizontalRule()
יצירה וצירוף של HorizontalRule
חדש.
החזרות
HorizontalRule
- הכלל האופקי החדש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendInlineImage(image)
יצירה וצירוף של InlineImage
חדש מה-blob של התמונה שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
image | BlobSource | נתוני התמונה |
החזרות
InlineImage
– התמונה המצורפת
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendInlineImage(image)
הפונקציה הזאת מצרפת את הערך InlineImage
.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
image | InlineImage | נתוני התמונה |
החזרות
InlineImage
– התמונה המצורפת
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak()
יצירה וצירוף של PageBreak
חדש.
הערה: אסור לכלול PageBreaks
בתוך TableCells
.
אם הרכיב הנוכחי כלול בתא בטבלה, המערכת תתריע בפני חריג.
החזרות
PageBreak
- הרכיב החדש של מעבר הדף
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak(pageBreak)
הפונקציה הזאת מצרפת את הערך PageBreak
.
הערה: אסור לכלול PageBreaks
בתוך TableCells
.
אם הרכיב הנוכחי כלול בתא בטבלה, המערכת תתריע בפני חריג.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
pageBreak | PageBreak | מעבר הדף להוספה |
החזרות
PageBreak
– הרכיב המצורף של מעבר הדף
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendText(text)
appendText(text)
clear()
copy()
מחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
גם רכיבי צאצא הקיימים ברכיב יועתקו. לרכיב החדש אין הורה.
החזרות
ListItem
- העותק החדש.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
משיג את גרסת Text
של הרכיב הנוכחי, לצורך עריכה.
שימוש בפונקציה editAsText
לשינוי תוכן הרכיבים כטקסט עשיר. המצב editAsText
מתעלם מאלמנטים שאינם טקסט (כמו InlineImage
ו-HorizontalRule
).
רכיבי צאצא שנכללים במלואם בטווח טקסט שנמחק, מוסרים מהרכיב.
var body = DocumentApp.getActiveDocument().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, "An editAsText sample."); body.insertHorizontalRule(0); body.insertParagraph(0, "An example."); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
החזרות
Text
– גרסת טקסט של הרכיב הנוכחי
findElement(elementType)
מחפשת צאצא מהסוג שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
elementType | ElementType | סוג הרכיב שיש לחפש |
החזרות
RangeElement
- תוצאת חיפוש שמציינת את המיקום של רכיב החיפוש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
מחפשת בתוכן הרכיב צאצא מהסוג שצוין, החל מה-RangeElement
שצוין.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
פרמטרים
שם | תיאור | התיאור |
---|---|---|
elementType | ElementType | סוג הרכיב שיש לחפש |
from | RangeElement | תוצאת החיפוש שממנה יש לחפש |
החזרות
RangeElement
- תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
מחפש את תוכן הרכיב כדי לאתר את דפוס הטקסט שצוין באמצעות ביטויים רגולריים.
אין תמיכה מלאה בקבוצת משנה של תכונות של ביטויים רגולריים ב-JavaScript, כמו קבוצות צילום ומגבילי מצב.
הדפוס של הביטוי הרגולרי שסופק מותאם בנפרד לכל גוש טקסט שכלול ברכיב הנוכחי.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
searchPattern | String | הדפוס שצריך לחפש |
החזרות
RangeElement
- תוצאת חיפוש שמציינת את מיקום הטקסט לחיפוש, או הערך null אם אין
התאמה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
מחפש את תוכן הרכיב לפי דפוס הטקסט שצוין, החל מתוצאת חיפוש נתונה.
אין תמיכה מלאה בקבוצת משנה של תכונות של ביטויים רגולריים ב-JavaScript, כמו קבוצות צילום ומגבילי מצב.
הדפוס של הביטוי הרגולרי שסופק מותאם בנפרד לכל גוש טקסט שכלול ברכיב הנוכחי.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
searchPattern | String | הדפוס שצריך לחפש |
from | RangeElement | תוצאת החיפוש שממנה יש לחפש |
החזרות
RangeElement
- תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או הערך null אם אין התאמה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAlignment()
מאחזר את HorizontalAlignment
.
החזרות
HorizontalAlignment
– היישור
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
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
getChild(childIndex)
מאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. var firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText("This is the first paragraph."); }
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס של רכיב הצאצא שצריך לאחזר |
החזרות
Element
- רכיב הצאצא באינדקס שצוין
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
מאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
child | Element | את רכיב הצאצא שעבורו יש לאחזר את האינדקס |
החזרות
Integer
- אינדקס הצאצא
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getGlyphType()
getHeading()
מאחזר את ParagraphHeading
.
החזרות
ParagraphHeading
– הכותרת
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getIndentEnd()
אחזור של כניסת הסוף, בנקודות.
החזרות
Number
– כניסת הפיסקה בסוף, בנקודות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getIndentFirstLine()
אחזור של כניסת השורה הראשונה, בנקודות.
החזרות
Number
– כניסת השורה הראשונה, בנקודות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getIndentStart()
אחזור של התחלת הכניסה.
החזרות
Number
– תחילת כניסת הפיסקה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLineSpacing()
מאחזר את המרווח בין השורות, בנקודות.
החזרות
Number
– המרווח בין השורות, בנקודות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
אחזור של כתובת ה-URL של הקישור.
החזרות
String
- כתובת ה-URL של הקישור, או הערך null אם הרכיב מכיל כמה ערכים למאפיין הזה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getListId()
אחזור של מזהה הרשימה.
החזרות
String
– מזהה הרשימה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNestingLevel()
מאחזר את רמת הקינון של פריט ברשימה.
כברירת מחדל, רמת ההוספה של פריטים ברשימה היא אפס. רמת הקינון קובעת את הגליף המשמש את פריט הרשימה.
החזרות
Integer
– רמת הסידור הפנימי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
getNumChildren()
אחזור מספר הילדים.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
החזרות
Integer
– מספר הילדים
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
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
getPositionedImage(id)
הפונקציה מקבלת PositionedImage
לפי מזהה התמונה.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
id | String | מזהה התמונה |
החזרות
PositionedImage
– התמונה המוצבת
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPositionedImages()
משייך את כל PositionedImage
האובייקטים לפסקה.
החזרות
PositionedImage[]
– רשימה של תמונות ממוקמות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
getSpacingAfter()
מאחזרת את הריווח אחרי הרכיב, בנקודות.
החזרות
Number
– הריווח אחרי הרכיב, בנקודות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSpacingBefore()
אחזור הריווח לפני הרכיב, בנקודות.
החזרות
Number
– הריווח לפני הרכיב, בנקודות
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getText()
מאחזר את התוכן של הרכיב כמחרוזת טקסט.
החזרות
String
- תוכן הרכיב כמחרוזת טקסט
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
הפונקציה הזו משיגה את היישור של הטקסט. סוגי ההתאמה הזמינים הם DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
ו-DocumentApp.TextAlignment.SUPERSCRIPT
.
החזרות
TextAlignment
— סוג היישור של הטקסט. לחלופין, null
אם הטקסט מכיל סוגים שונים של יישור טקסט או אם יישור הטקסט מעולם לא הוגדר
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
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
insertHorizontalRule(childIndex)
יוצרת ומוסיפה HorizontalRule
באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
החזרות
HorizontalRule
- הרכיב החדש של הכלל האופקי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
הפונקציה יוצרת ומוסיפה InlineImage
חדש מה-blob של התמונה שצוין, באינדקס
שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
image | BlobSource | נתוני התמונה |
החזרות
InlineImage
- רכיב התמונה המוטמעת שהוכנסה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
הפונקציה מוסיפה את הערך הנתון InlineImage
באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
image | InlineImage | נתוני התמונה |
החזרות
InlineImage
- רכיב התמונה המוטמעת שהוכנסה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex)
יוצרת ומוסיפה PageBreak
חדש באינדקס שצוין.
הערה: אסור לכלול PageBreaks
בתוך TableCells
.
אם הרכיב הנוכחי כלול בתא בטבלה, המערכת תתריע בפני חריג.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
החזרות
PageBreak
- הרכיב החדש של מעבר הדף
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex, pageBreak)
הפונקציה מוסיפה את הערך הנתון PageBreak
באינדקס שצוין.
הערה: אסור לכלול PageBreaks
בתוך TableCells
.
אם הרכיב הנוכחי כלול בתא בטבלה, המערכת תתריע בפני חריג.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
pageBreak | PageBreak | ה P[הפסקה בגיל להוספה |
החזרות
PageBreak
- רכיב מעבר הדף שנוסף
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
יוצרת ומוסיפה רכיב טקסט חדש באינדקס שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
text | String | תוכן הטקסט |
החזרות
Text
- רכיב הטקסט החדש
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
הוספת הרכיב Text
הנתון לאינדקס שצוין, עם תוכן הטקסט שצוין.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
childIndex | Integer | את האינדקס שבו יש להכניס את הרכיב |
text | Text | רכיב הטקסט להוספה |
החזרות
Text
- רכיב הטקסט שנוסף
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
isLeftToRight()
מאחזר את ההגדרה משמאל לימין.
החזרות
Boolean
– ההגדרה משמאל לימין
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
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();
החזרות
ListItem
- הרכיב שמוזג.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
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(); }
החזרות
ListItem
- הרכיב שהוסר.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removePositionedImage(id)
מסירה את PositionedImage
לפי מזהה התמונה.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
id | String |
החזרות
Boolean
– בין אם התמונה שצוינה הוסרה
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים.
דפוס החיפוש מועבר כמחרוזת, ולא כאובייקט של ביטוי רגולרי ב-JavaScript. לכן, תצטרכו להשתמש בתו בריחה (escape) של כל לוכסן הפוך בתבנית.
בשיטה הזו נעשה שימוש בספריית הביטויים הרגולריים RE2 של Google, שמגבילה את התחביר הנתמך.
הדפוס של הביטוי הרגולרי שסופק מותאם בנפרד לכל גוש טקסט שכלול ברכיב הנוכחי.
var body = DocumentApp.getActiveDocument().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
פרמטרים
שם | תיאור | התיאור |
---|---|---|
searchPattern | String | את הדפוס הרגולרי שצריך לחפש |
replacement | String | בטקסט שישמש כתחליף |
החזרות
Element
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAlignment(alignment)
מגדיר את HorizontalAlignment
.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
alignment | HorizontalAlignment | היישור האופקי |
החזרות
ListItem
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
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 | מאפייני הרכיב. |
החזרות
ListItem
- הרכיב הנוכחי.
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setGlyphType(glyphType)
setHeading(heading)
מגדיר את ParagraphHeading
.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
heading | ParagraphHeading | הכותרת |
החזרות
ListItem
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentEnd(indentEnd)
המדיניות מגדירה את כניסת הפיסקה הסופית, בנקודות.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
indentEnd | Number | נקודת הסיום של כניסת הפיסקה, בנקודות |
החזרות
ListItem
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentFirstLine(indentFirstLine)
מגדיר את כניסת השורה הראשונה, בנקודות.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
indentFirstLine | Number | כניסת השורה הראשונה, בנקודות |
החזרות
ListItem
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentStart(indentStart)
המדיניות הזו מגדירה את הכניסה של כניסת פיסקה, בנקודות.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
indentStart | Number | בהתחלה של כניסת הפיסקה, בנקודות |
החזרות
ListItem
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLeftToRight(leftToRight)
setLineSpacing(multiplier)
מגדיר את המרווח בין השורות, ככמות שמציינת את מספר השורות שישמשו לריווח.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
multiplier | Number | את מספר השורות |
החזרות
ListItem
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
setListId(listItem)
מגדיר את מזהה הרשימה.
מזהה הרשימה מוגדר לאותו ערך עבור ListItem
שצוין. המערכת תתייחס לשני ה-ListItems
כאל חברים באותה רשימה.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
listItem | ListItem | את פריט הרשימה שיש להשתמש במזהה הרשימה שלו |
החזרות
ListItem
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setNestingLevel(nestingLevel)
מגדיר את רמת הקינון של פריט ברשימה.
כברירת מחדל, רמת ההוספה של פריטים ברשימה היא אפס. רמת הקינון קובעת את הגליף המשמש את פריט הרשימה.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
nestingLevel | Integer | רמת הדירוג |
החזרות
ListItem
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSpacingAfter(spacingAfter)
מגדיר את הריווח אחרי הרכיב, בנקודות.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
spacingAfter | Number | הריווח אחרי הרכיב, בנקודות |
החזרות
ListItem
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSpacingBefore(spacingBefore)
מגדיר את הריווח לפני הרכיב, בנקודות.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
spacingBefore | Number | הריווח לפני הרכיב, בנקודות |
החזרות
ListItem
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
מגדיר את התוכן של פריט ברשימה כטקסט.
הערה: התוכן הקיים נמחק.
פרמטרים
שם | תיאור | התיאור |
---|---|---|
text | String | תוכן הטקסט החדש |
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
הגדרת יישור הטקסט. סוגי ההתאמה הזמינים הם DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
ו-DocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
פרמטרים
שם | תיאור | התיאור |
---|---|---|
textAlignment | TextAlignment | סוג היישור של הטקסט שצריך להחיל |
החזרות
ListItem
- הרכיב הנוכחי
הרשאות
לסקריפטים שמשתמשים בשיטה הזו נדרשת הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents