רכיב שמייצג פסקה. השדה Paragraph
עשוי להכיל רכיבים של Equation
, Footnote
, HorizontalRule
, InlineDrawing
, InlineImage
, PageBreak
וגם Text
. מידע נוסף על מבנה המסמך זמין במדריך בנושא הרחבת Google Docs.
Paragraphs
לא יכול להכיל תווים בשורה חדשה. תווים בשורה חדשה ("\n") מומרים לתווים של מעבר שורה ("COM").
var body = DocumentApp.getActiveDocument().getBody(); // Append a document header paragraph. var header = body.appendParagraph("A Document"); header.setHeading(DocumentApp.ParagraphHeading.HEADING1); // Append a section header paragraph. var section = body.appendParagraph("Section 1"); section.setHeading(DocumentApp.ParagraphHeading.HEADING2); // Append a regular paragraph. body.appendParagraph("This is a typical paragraph.");
שיטות
Method | סוג הערך המוחזר | תיאור קצר |
---|---|---|
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() | Paragraph | ניקוי התוכן של הרכיב. |
copy() | Paragraph | מחזירה עותק עמוק ומנותק של הרכיב הנוכחי. |
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 | אחזור של אינדקס הצאצא עבור רכיב הצאצא שצוין. |
getHeading() | ParagraphHeading | מאחזר את ParagraphHeading . |
getIndentEnd() | Number | מאחזרת את כניסת הסיום, בנקודות. |
getIndentFirstLine() | Number | מאחזרת את כניסת השורה הראשונה, בנקודות. |
getIndentStart() | Number | אחזור של התחלת הכניסה. |
getLineSpacing() | Number | אחזור הריווח בין נקודות, בנקודות. |
getLinkUrl() | String | מאחזר את כתובת ה-URL של הקישור. |
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() | Paragraph | ממזג את האלמנט עם אח שנמצא באותו סוג. |
removeChild(child) | Paragraph | הסרת רכיב הצאצא שצוין. |
removeFromParent() | Paragraph | הסרת הרכיב מהורה. |
removePositionedImage(id) | Boolean | מתבצעת הסרה של PositionedImage לפי מזהה התמונה. |
replaceText(searchPattern, replacement) | Element | החלפת כל המופעים של תבנית טקסט נתונה במחרוזת החלפה נתונה באמצעות ביטויים רגולריים. |
setAlignment(alignment) | Paragraph | מגדיר את HorizontalAlignment . |
setAttributes(attributes) | Paragraph | מגדיר את המאפיינים של הרכיב. |
setHeading(heading) | Paragraph | מגדיר את ParagraphHeading . |
setIndentEnd(indentEnd) | Paragraph | המדיניות הזו קובעת את הכניסה הסופית, בנקודות. |
setIndentFirstLine(indentFirstLine) | Paragraph | הגדרת הכניסה הראשונה של השורה, בנקודות. |
setIndentStart(indentStart) | Paragraph | הגדרת הכניסה בתחילת השורה, בנקודות. |
setLeftToRight(leftToRight) | Paragraph | ההגדרה משמאל לימין. |
setLineSpacing(multiplier) | Paragraph | מגדירה את הריווח בין שורות, ככמות המציינת את מספר השורות שבהן יש להשתמש לריווח. |
setLinkUrl(url) | Paragraph | הגדרת כתובת ה-URL של הקישור. |
setSpacingAfter(spacingAfter) | Paragraph | פונקציה זו מגדירה את הריווח אחרי הרכיב, בנקודות. |
setSpacingBefore(spacingBefore) | Paragraph | מגדירה את הריווח לפני הרכיב, בנקודות. |
setText(text) | void | מגדיר את התוכן של הפסקה כטקסט. |
setTextAlignment(textAlignment) | Paragraph | הגדרת יישור הטקסט. |
תיעוד מפורט
addPositionedImage(image)
יצירה והוספה של PositionedImage
חדש מה-blob שצוין.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body. const body = doc.getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Fetches the specified image URL. const image = UrlFetchApp.fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-24dp/logo_apps_script_color_1x_web_24dp.png'); // Adds the image to the document, anchored to the first paragraph. paragraph.addPositionedImage(image);
פרמטרים
שם | Type | תיאור |
---|---|---|
image | BlobSource | נתוני התמונה. |
חזרה
PositionedImage
— התמונה שממוקמת מחדש.
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendHorizontalRule()
יצירה וצירוף של HorizontalRule
חדש.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body. const body = doc.getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a horizontal line under the first paragraph. paragraph.appendHorizontalRule();
חזרה
HorizontalRule
— הכלל האופקי החדש.
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendInlineImage(image)
יצירה וצירוף של InlineImage
חדש מה-blob שצוין.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body. const body = doc.getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Fetches the image from the specified image URL. const image = UrlFetchApp .fetch('https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-96dp/logo_apps_script_color_1x_web_96dp.png'); // Adds the image to the first paragraph. paragraph.appendInlineImage(image);
פרמטרים
שם | Type | תיאור |
---|---|---|
image | BlobSource | נתוני התמונה. |
חזרה
InlineImage
— התמונה המצורפת.
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendInlineImage(image)
הפונקציה מצרפת את InlineImage
הנתון.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body. const body = doc.getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Makes a copy of the first image in the body. const image = body.getImages()[0].copy();; // Adds the image to the first paragraph. paragraph.appendInlineImage(image);
פרמטרים
שם | Type | תיאור |
---|---|---|
image | InlineImage | נתוני התמונה. |
חזרה
InlineImage
— התמונה המצורפת.
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak()
יצירה וצירוף של PageBreak
חדש.
הערה: ייתכן ש-PageBreaks
לא נכלל ב-TableCells
.
אם הרכיב הנוכחי נמצא בתא בטבלה, המערכת תחריג אותו.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body. const body = doc.getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a page break after the first paragraph. paragraph.appendPageBreak();
חזרה
PageBreak
— הרכיב החדש של מעבר דף.
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak(pageBreak)
הפונקציה מצרפת את PageBreak
הנתון.
הערה: אי אפשר לכלול את PageBreaks
בתוך TableCells
.
אם הרכיב הנוכחי קיים בתא בטבלה, הסקריפט יגרום לחריגה.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body. const body = doc.getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a page break after the first paragraph. const pageBreak = paragraph.appendPageBreak(); // Makes a copy of the page break. const newPageBreak = pageBreak.copy(); // Adds the copied page break to the paragraph. paragraph.appendPageBreak(newPageBreak);
פרמטרים
שם | Type | תיאור |
---|---|---|
pageBreak | PageBreak | מעבר הדף להוספה. |
חזרה
PageBreak
— הרכיב שנוסף לדף.
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendText(text)
יצירה וצירוף של רכיב Text
חדש עם התכנים שצוינו.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body. const body = doc.getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a string to the paragraph. paragraph.appendText('This is a new sentence.');
פרמטרים
שם | Type | תיאור |
---|---|---|
text | String | תוכן הטקסט. |
חזרה
Text
— רכיב הטקסט החדש.
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendText(text)
הפונקציה מצרפת את הרכיב Text
הנתון.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body. const body = doc.getBody(); // Gets the text from the first paragraph in the body. const paragraph1 = body.getParagraphs()[0]; const text = paragraph1.getText(); // Gets the third paragraph in the body. const paragraph3 = body.getParagraphs()[2]; // Adds the text from the first paragraph to the third paragraph. paragraph3.appendText(text);
פרמטרים
שם | Type | תיאור |
---|---|---|
text | Text | רכיב הטקסט לצירוף. |
חזרה
Text
— רכיב הטקסט המצורף.
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
מחזירה עותק עמוק ומנותק של הרכיב הנוכחי.
גם כל רכיבי הצאצא שנמצאים ברכיב מועתקים. לאלמנט החדש אין הורה.
חזרה
Paragraph
— העותק החדש.
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
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)
חיפוש בתוכן של הרכיב עבור צאצא מהסוג שצוין.
פרמטרים
שם | Type | תיאור |
---|---|---|
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; } }
פרמטרים
שם | Type | תיאור |
---|---|---|
elementType | ElementType | סוג הרכיב שיש לחפש |
from | RangeElement | תוצאת החיפוש שממנה יש לחפש |
חזרה
RangeElement
— תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
מתבצע חיפוש של תוכן הרכיב עבור דפוס הטקסט שצוין באמצעות ביטויים רגולריים.
אין תמיכה מלאה בקבוצת משנה של תכונות הביטוי הרגולרי של JavaScript, כמו קבוצות לחילוץ ומשנים של מצב.
דפוס הביטוי הרגיל שסופק מותאם באופן עצמאי לכל בלוק טקסט שמכיל את הרכיב הנוכחי.
פרמטרים
שם | Type | תיאור |
---|---|---|
searchPattern | String | דוגמת העיצוב לחיפוש |
חזרה
RangeElement
— תוצאת חיפוש שמציינת את המיקום של טקסט החיפוש, או ריק אם אין
התאמה
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
מבצע חיפוש בתוכן של הרכיב עבור דפוס הטקסט שצוין, החל מתוצאת חיפוש נתונה.
אין תמיכה מלאה בקבוצת משנה של תכונות הביטוי הרגולרי של JavaScript, כמו קבוצות לחילוץ ומשנים של מצב.
דפוס הביטוי הרגיל שסופק מותאם באופן עצמאי לכל בלוק טקסט שמכיל את הרכיב הנוכחי.
פרמטרים
שם | Type | תיאור |
---|---|---|
searchPattern | String | דוגמת העיצוב לחיפוש |
from | RangeElement | תוצאת החיפוש שממנה יש לחפש |
חזרה
RangeElement
— תוצאת חיפוש שמציינת את המיקום הבא של הטקסט בחיפוש, או ריק אם אין
התאמה
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAlignment()
מאחזר את HorizontalAlignment
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body. const body = doc.getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Sets the horizontal alignment to left for the first paragraph. paragraph.setAlignment(DocumentApp.HorizontalAlignment.LEFT); // Gets the horizontal alignment of the first paragraph and logs it to the console. console.log(paragraph.getAlignment().toString());
חזרה
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."); }
פרמטרים
שם | Type | תיאור |
---|---|---|
childIndex | Integer | האינדקס של רכיב הצאצא לאחזור |
חזרה
Element
— רכיב הצאצא באינדקס שצוין
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
אחזור של אינדקס הצאצא עבור רכיב הצאצא שצוין.
פרמטרים
שם | Type | תיאור |
---|---|---|
child | Element | רכיב הצאצא שעבורו ניתן לאחזר את האינדקס |
חזרה
Integer
– אינדקס הצאצא
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getHeading()
מאחזר את ParagraphHeading
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('abc123456'); // Gets the document body. const body = doc.getBody(); // Adds a paragraph to the body. const paragraph = body.appendParagraph('Title heading'); // Sets the paragraph heading style to 'Title.' paragraph.setHeading(DocumentApp.ParagraphHeading.TITLE); // Gets the heading style and logs it to the console. console.log(paragraph.getHeading().toString());
חזרה
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
getNextSibling()
מאחזר את רכיב האחות הבא של הרכיב.
לאח/ה או אח/ות אחרים יש אותו הורה ומוגדר/ת בהתאם לרכיב הנוכחי.
חזרה
Element
— רכיב האחות הבא.
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
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
לפי מזהה התמונה.
פרמטרים
שם | Type | תיאור |
---|---|---|
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
באינדקס שצוין.
פרמטרים
שם | Type | תיאור |
---|---|---|
childIndex | Integer | האינדקס שבו יש להכניס את הרכיב |
חזרה
HorizontalRule
— רכיב הכלל האופקי החדש
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
יצירה והוספה של InlineImage
חדש מ-blob התמונה שצוין, באינדקס שצוין.
פרמטרים
שם | Type | תיאור |
---|---|---|
childIndex | Integer | האינדקס שבו יש להכניס את הרכיב |
image | BlobSource | נתוני התמונה |
חזרה
InlineImage
— רכיב התמונה המוטבע שנוסף
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
הפונקציה מוסיפה את InlineImage
הנתון באינדקס שצוין.
פרמטרים
שם | Type | תיאור |
---|---|---|
childIndex | Integer | האינדקס שבו יש להכניס את הרכיב |
image | InlineImage | נתוני התמונה |
חזרה
InlineImage
— רכיב התמונה המוטבע שנוסף
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex)
יצירה והוספה של PageBreak
חדש באינדקס שצוין.
הערה: ייתכן ש-PageBreaks
לא נכלל ב-TableCells
.
אם הרכיב הנוכחי נמצא בתא בטבלה, המערכת תחריג אותו.
פרמטרים
שם | Type | תיאור |
---|---|---|
childIndex | Integer | האינדקס שבו יש להכניס את הרכיב |
חזרה
PageBreak
— הרכיב החדש של מעבר דף
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex, pageBreak)
הפונקציה מוסיפה את PageBreak
הנתון באינדקס שצוין.
הערה: ייתכן ש-PageBreaks
לא נכלל ב-TableCells
.
אם הרכיב הנוכחי נמצא בתא בטבלה, המערכת תחריג אותו.
פרמטרים
שם | Type | תיאור |
---|---|---|
childIndex | Integer | האינדקס שבו יש להכניס את הרכיב |
pageBreak | PageBreak | [הפסקה] להוספה |
חזרה
PageBreak
— הרכיב של מעבר הדף שנוסף
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
יצירה והוספה של רכיב טקסט חדש באינדקס שצוין.
פרמטרים
שם | Type | תיאור |
---|---|---|
childIndex | Integer | האינדקס שבו יש להכניס את הרכיב |
text | String | את תוכן הטקסט |
חזרה
Text
— רכיב הטקסט החדש
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
הפונקציה מוסיפה את הרכיב Text
הנתון באינדקס שצוין, עם תוכן הטקסט שצוין.
פרמטרים
שם | Type | תיאור |
---|---|---|
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();
חזרה
Paragraph
— הרכיב שמוזג.
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
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(); }
חזרה
Paragraph
— הרכיב שהוסר.
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removePositionedImage(id)
מתבצעת הסרה של PositionedImage
לפי מזהה התמונה.
פרמטרים
שם | Type | תיאור |
---|---|---|
id | String | מזהה התמונה |
חזרה
Boolean
— בין אם התמונה שצוינה הוסרה או לא
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
החלפת כל המופעים של תבנית טקסט נתונה במחרוזת החלפה נתונה באמצעות ביטויים רגולריים.
דפוס החיפוש מועבר כמחרוזת, ולא כאובייקט ביטוי רגולרי של JavaScript. לכן, עליך לסמן בתו בריחה (escape) את הקו הנטוי הנטוי שבקו ביטול הנעילה.
השיטה הזו משתמשת בספריית הביטויים הרגילים של Google RE2, שמגבילה את התחביר הנתמך.
דפוס הביטוי הרגיל שסופק מותאם באופן עצמאי לכל בלוק טקסט שמכיל את הרכיב הנוכחי.
var body = DocumentApp.getActiveDocument().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
פרמטרים
שם | Type | תיאור |
---|---|---|
searchPattern | String | דפוס הביטוי הרגולרי לחיפוש |
replacement | String | הטקסט שישמש כתחליף |
חזרה
Element
— הרכיב הנוכחי
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAlignment(alignment)
מגדיר את HorizontalAlignment
.
פרמטרים
שם | Type | תיאור |
---|---|---|
alignment | HorizontalAlignment | היישור האופקי |
חזרה
Paragraph
— הרכיב הנוכחי
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
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);
פרמטרים
שם | Type | תיאור |
---|---|---|
attributes | Object | המאפיינים של הרכיב. |
חזרה
Paragraph
— הרכיב הנוכחי.
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setHeading(heading)
מגדיר את ParagraphHeading
.
פרמטרים
שם | Type | תיאור |
---|---|---|
heading | ParagraphHeading | הכותרת |
חזרה
Paragraph
— הרכיב הנוכחי
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentEnd(indentEnd)
המדיניות הזו קובעת את הכניסה הסופית, בנקודות.
פרמטרים
שם | Type | תיאור |
---|---|---|
indentEnd | Number | כניסת הפיסקה, בנקודות |
חזרה
Paragraph
— הרכיב הנוכחי
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentFirstLine(indentFirstLine)
הגדרת הכניסה הראשונה של השורה, בנקודות.
פרמטרים
שם | Type | תיאור |
---|---|---|
indentFirstLine | Number | כניסת השורה הראשונה, בנקודות |
חזרה
Paragraph
— הרכיב הנוכחי
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentStart(indentStart)
setLeftToRight(leftToRight)
setLineSpacing(multiplier)
מגדירה את הריווח בין שורות, ככמות המציינת את מספר השורות שבהן יש להשתמש לריווח.
פרמטרים
שם | Type | תיאור |
---|---|---|
multiplier | Number | מספר הקווים |
חזרה
Paragraph
— הרכיב הנוכחי
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
setSpacingAfter(spacingAfter)
פונקציה זו מגדירה את הריווח אחרי הרכיב, בנקודות.
פרמטרים
שם | Type | תיאור |
---|---|---|
spacingAfter | Number | הריווח אחרי הרכיב, בנקודות |
חזרה
Paragraph
— הרכיב הנוכחי
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSpacingBefore(spacingBefore)
מגדירה את הריווח לפני הרכיב, בנקודות.
פרמטרים
שם | Type | תיאור |
---|---|---|
spacingBefore | Number | הריווח לפני הרכיב, בנקודות |
חזרה
Paragraph
— הרכיב הנוכחי
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
מגדיר את התוכן של הפסקה כטקסט.
הערה: התוכן הקיים ינוקה.
פרמטרים
שם | Type | תיאור |
---|---|---|
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);
פרמטרים
שם | Type | תיאור |
---|---|---|
textAlignment | TextAlignment | סוג יישור הטקסט שיש להחיל |
חזרה
Paragraph
— הרכיב הנוכחי
הרשאה
סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה באחד או יותר מההיקפים הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents