Class Paragraph

רכיב שמייצג פסקה. רכיב Paragraph יכול להכיל את הרכיבים Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak ו-Text. מידע נוסף על מבנה המסמך זמין במדריך להרחבת Google Docs.

הערך Paragraphs לא יכול להכיל תווי מעבר לשורה חדשה. תווים של שורה חדשה ("\n") מומרים לתווים של מעבר שורה ("\r").

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a tab header paragraph.
const header = body.appendParagraph('A Document');
header.setHeading(DocumentApp.ParagraphHeading.HEADING1);

// Append a section header paragraph.
const section = body.appendParagraph('Section 1');
section.setHeading(DocumentApp.ParagraphHeading.HEADING2);

// Append a regular paragraph.
body.appendParagraph('This is a typical paragraph.');

Methods

שיטה	סוג הערך שמוחזר	תיאור קצר
`addPositionedImage(image)`	`PositionedImage`	יוצר ומכניס `PositionedImage` חדש מ-blob התמונה שצוין.
`appendHorizontalRule()`	`HorizontalRule`	יוצרת `HorizontalRule` חדש ומצרפת אותו.
`appendInlineImage(image)`	`InlineImage`	יוצר ומצרף `InlineImage` חדש מבלוב התמונה שצוין.
`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\|null`	מחפש בתוכן של הרכיב צאצא מסוג מסוים.
`findElement(elementType, from)`	`RangeElement\|null`	הפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מ`RangeElement` שצוין.
`findText(searchPattern)`	`RangeElement\|null`	מחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.
`findText(searchPattern, from)`	`RangeElement\|null`	מחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.
`getAlignment()`	`HorizontalAlignment\|null`	מאחזר את `HorizontalAlignment`.
`getAttributes()`	`Object`	מאחזר את המאפיינים של האלמנט.
`getChild(childIndex)`	`Element`	מאחזר את רכיב הצאצא באינדקס הצאצא שצוין.
`getChildIndex(child)`	`Integer`	מאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
`getHeading()`	`ParagraphHeading\|null`	מאחזר את `ParagraphHeading`.
`getIndentEnd()`	`Number\|null`	מאחזרת את ההזחה בסוף, בנקודות.
`getIndentFirstLine()`	`Number\|null`	הפונקציה מאחזרת את גודל הכניסה של השורה הראשונה, בנקודות.
`getIndentStart()`	`Number\|null`	הפונקציה מחזירה את ההזחה של תחילת הפסקה.
`getLineSpacing()`	`Number\|null`	מאחזרת את הריווח בין השורות, בנקודות.
`getLinkUrl()`	`String\|null`	הפונקציה מחזירה את כתובת ה-URL של הקישור.
`getNextSibling()`	`Element\|null`	מאחזר את רכיב האח הבא של הרכיב.
`getNumChildren()`	`Integer`	מאחזר את מספר הילדים.
`getParent()`	`ContainerElement\|null`	מאחזר את רכיב ההורה של הרכיב.
`getPositionedImage(id)`	`PositionedImage`	הפונקציה מחזירה `PositionedImage` לפי מזהה התמונה.
`getPositionedImages()`	`PositionedImage[]`	מקבל את כל אובייקטי `PositionedImage` שמעוגנים לפסקה.
`getPreviousSibling()`	`Element\|null`	אחזור של רכיב האחות הקודם של הרכיב.
`getSpacingAfter()`	`Number\|null`	מחזירה את הריווח אחרי הרכיב, בנקודות.
`getSpacingBefore()`	`Number\|null`	מחזירה את הריווח לפני הרכיב, בנקודות.
`getText()`	`String`	מאחזרת את התוכן של הרכיב כמחרוזת טקסט.
`getTextAlignment()`	`TextAlignment\|null`	מחזירה את יישור הטקסט.
`getType()`	`ElementType`	אחזור `ElementType` של הרכיב.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	יוצרת את התג `HorizontalRule` ומוסיפה אותו לאינדקס שצוין.
`insertInlineImage(childIndex, image)`	`InlineImage`	יוצר ומכניס `InlineImage` חדש מבלוב התמונה שצוין, באינדקס שצוין.
`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\|null`	מאחזר את ההגדרה משמאל לימין.
`merge()`	`Paragraph\|null`	מיזוג הרכיב עם הרכיב הקודם מאותו סוג.
`removeChild(child)`	`Paragraph`	הסרת רכיב הבן שצוין.
`removeFromParent()`	`Paragraph\|null`	הפונקציה מסירה את הרכיב מהרכיב ההורה שלו.
`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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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 tab, anchored to the first paragraph.
paragraph.addPositionedImage(image);

פרמטרים

שם	סוג	תיאור
`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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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 חדש מבלוב התמונה שצוין.

// 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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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);

פרמטרים

שם	סוג	תיאור
`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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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);

פרמטרים

שם	סוג	תיאור
`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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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);

פרמטרים

שם	סוג	תיאור
`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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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.');

פרמטרים

שם	סוג	תיאור
`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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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);

פרמטרים

שם	סוג	תיאור
`text`	`Text`	רכיב הטקסט לצירוף.

חזרה

‫Text — רכיב הטקסט שנוסף.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`clear()`

מחיקת התוכן של הרכיב.

חזרה

‫Paragraph – הרכיב הנוכחי.

`copy()`

הפונקציה מחזירה עותק מנותק ועמוק של הרכיב הנוכחי.

כל רכיבי הצאצא שקיימים ברכיב מועתקים גם הם. לרכיב החדש אין רכיב אב.

חזרה

‫Paragraph — העותק החדש.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`editAsText()`

מקבלים גרסה Text של הרכיב הנוכחי לצורך עריכה.

אפשר להשתמש ב-editAsText כדי לשנות את תוכן הרכיבים כטקסט עשיר. במצב editAsText המערכת מתעלמת מאלמנטים שאינם טקסט (כמו InlineImage ו-HorizontalRule).

רכיבי צאצא שכלולים באופן מלא בטווח טקסט שנמחק מוסרים מהרכיב.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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|null — תוצאת חיפוש שמציינת את המיקום של רכיב החיפוש.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findElement(elementType, from)`

הפונקציה מחפשת בתוכן של הרכיב צאצא מסוג מסוים, החל מRangeElement שצוין.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

פרמטרים

שם	סוג	תיאור
`elementType`	`ElementType`	סוג הרכיב לחיפוש.
`from`	`RangeElement`	תוצאת החיפוש שממנה מתחילים את החיפוש.

חזרה

‫RangeElement|null — תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findText(searchPattern)`

מחפשת בתוכן של הרכיב את תבנית הטקסט שצוינה באמצעות ביטויים רגולריים.

קבוצת משנה של תכונות הביטוי הרגולרי של JavaScript לא נתמכות באופן מלא, כמו קבוצות לכידה ומשני מצב.

תבנית הביטוי הרגולרי שצוינה מושווית באופן עצמאי לכל בלוק טקסט שנכלל ברכיב הנוכחי.

פרמטרים

שם	סוג	תיאור
`searchPattern`	`String`	התבנית לחיפוש

חזרה

‫RangeElement|null – תוצאת חיפוש שמציינת את המיקום של טקסט החיפוש, או null אם אין התאמה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`findText(searchPattern, from)`

מחפש בתוכן של הרכיב את תבנית הטקסט שצוינה, החל מתוצאת חיפוש נתונה.

קבוצת משנה של תכונות הביטוי הרגולרי של JavaScript לא נתמכות באופן מלא, כמו קבוצות לכידה ומשני מצב.

תבנית הביטוי הרגולרי שצוינה מושווית באופן עצמאי לכל בלוק טקסט שנכלל ברכיב הנוכחי.

פרמטרים

שם	סוג	תיאור
`searchPattern`	`String`	התבנית לחיפוש
`from`	`RangeElement`	תוצאת החיפוש שממנה רוצים לחפש

חזרה

‫RangeElement|null — תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או null אם אין התאמה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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|null — היישור.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

`getChild(childIndex)`

מאחזר את רכיב הצאצא באינדקס הצאצא שצוין.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const 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

`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('123abc');

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab('123abc').asDocumentTab().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|null — הכותרת.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getIndentEnd()`

מאחזרת את ההזחה בסוף, בנקודות.

חזרה

‫Number|null — סוף הכניסה, בנקודות

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getIndentFirstLine()`

הפונקציה מאחזרת את גודל הכניסה של השורה הראשונה, בנקודות.

חזרה

‫Number|null — כניסת השורה הראשונה, בנקודות

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getIndentStart()`

הפונקציה מחזירה את ההזחה של תחילת הפסקה.

חזרה

‫Number|null — התחלת הכניסה

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getLineSpacing()`

מאחזרת את הריווח בין השורות, בנקודות.

חזרה

‫Number|null – ריווח השורות, בנקודות

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getLinkUrl()`

הפונקציה מחזירה את כתובת ה-URL של הקישור.

חזרה

‫String|null – כתובת ה-URL של הקישור, או 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

`getNumChildren()`

מאחזר את מספר הילדים.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

חזרה

‫Integer — מספר הילדים.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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

`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()`

אחזור של רכיב האחות הקודם של הרכיב.

לאח או לאחות הקודמים יש את אותו רכיב אב והם קודמים לרכיב הנוכחי.

חזרה

‫Element|null – רכיב האח הקודם.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getSpacingAfter()`

מחזירה את הריווח אחרי הרכיב, בנקודות.

חזרה

‫Number|null — הריווח אחרי הרכיב, בנקודות

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getSpacingBefore()`

מחזירה את הריווח לפני הרכיב, בנקודות.

חזרה

‫Number|null – הריווח לפני הרכיב, בנקודות

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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 – סוג יישור הטקסט, או 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

`insertHorizontalRule(childIndex)`

יוצרת את התג HorizontalRule ומוסיפה אותו לאינדקס שצוין.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו יתווסף הרכיב

חזרה

‫HorizontalRule — רכיב הסרגל האופקי החדש

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`insertInlineImage(childIndex, image)`

יוצר ומכניס InlineImage חדש מבלוב התמונה שצוין, באינדקס שצוין.

פרמטרים

שם	סוג	תיאור
`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`	מעבר הדף שרוצים להוסיף

חזרה

‫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()`

קובע אם הרכיב נמצא בסוף Document.

חזרה

‫Boolean — אם הרכיב נמצא בסוף הכרטיסייה.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`isLeftToRight()`

מאחזר את ההגדרה משמאל לימין.

חזרה

‫Boolean|null – ההגדרה משמאל לימין

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`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();

חזרה

‫Paragraph|null – הרכיב הממוזג.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`removeChild(child)`

הסרת רכיב הבן שצוין.

פרמטרים

שם	סוג	תיאור
`child`	`Element`	רכיב הצאצא שרוצים להסיר

חזרה

‫Paragraph – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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();
}

חזרה

‫Paragraph|null — הרכיב שהוסר.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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, שמגבילה את התחביר הנתמך.

תבנית הביטוי הרגולרי שצוינה מושווית באופן עצמאי לכל בלוק טקסט שנכלל ברכיב הנוכחי.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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`	היישור האופקי

חזרה

‫Paragraph – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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`	המאפיינים של האלמנט.

חזרה

‫Paragraph – הרכיב הנוכחי.

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setHeading(heading)`

מגדירה את ה-ParagraphHeading.

פרמטרים

שם	סוג	תיאור
`heading`	`ParagraphHeading`	הכותרת

חזרה

‫Paragraph – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setIndentEnd(indentEnd)`

מגדיר את הכניסה של סוף הפיסקה, בנקודות.

פרמטרים

שם	סוג	תיאור
`indentEnd`	`Number`	הכניסה של סוף הפסקה, בנקודות

חזרה

‫Paragraph – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setIndentFirstLine(indentFirstLine)`

הגדרת הכניסה של השורה הראשונה, בנקודות.

פרמטרים

שם	סוג	תיאור
`indentFirstLine`	`Number`	הכניסה של השורה הראשונה, בנקודות

חזרה

‫Paragraph – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setIndentStart(indentStart)`

הגדרת כניסה לתחילת הפיסקה, בנקודות.

פרמטרים

שם	סוג	תיאור
`indentStart`	`Number`	הכניסה לתחילת הפסקה, בנקודות

חזרה

‫Paragraph – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setLeftToRight(leftToRight)`

הגדרה משמאל לימין.

פרמטרים

שם	סוג	תיאור
`leftToRight`	`Boolean`	ההגדרה משמאל לימין

חזרה

‫Paragraph – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setLineSpacing(multiplier)`

הגדרה של המרווח בין השורות, כמספר שמציין את מספר השורות שמשמשות למרווח.

פרמטרים

שם	סוג	תיאור
`multiplier`	`Number`	מספר השורות

חזרה

‫Paragraph – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setLinkUrl(url)`

מגדיר את כתובת ה-URL של הקישור.

פרמטרים

שם	סוג	תיאור
`url`	`String`	כתובת ה-URL של הקישור

חזרה

‫Paragraph – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setSpacingAfter(spacingAfter)`

מגדיר את הריווח אחרי הרכיב, בנקודות.

פרמטרים

שם	סוג	תיאור
`spacingAfter`	`Number`	הריווח אחרי הרכיב, בנקודות

חזרה

‫Paragraph – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setSpacingBefore(spacingBefore)`

מגדיר את הריווח לפני הרכיב, בנקודות.

פרמטרים

שם	סוג	תיאור
`spacingBefore`	`Number`	הריווח לפני הרכיב, בנקודות

חזרה

‫Paragraph – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

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 in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

פרמטרים

שם	סוג	תיאור
`textAlignment`	`TextAlignment`	סוג יישור הטקסט שרוצים להחיל

חזרה

‫Paragraph – הרכיב הנוכחי

אישור

סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחת או יותר מההיקפים הבאים:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

Class Paragraph קל לארגן דפים בעזרת אוספים אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.

Methods

תיעוד מפורט

addPositionedImage(image)

פרמטרים

חזרה

אישור

appendHorizontalRule()

חזרה

אישור

appendInlineImage(image)

פרמטרים

חזרה

אישור

appendInlineImage(image)

פרמטרים

חזרה

אישור

appendPageBreak()

חזרה

אישור

appendPageBreak(pageBreak)

פרמטרים

חזרה

אישור

appendText(text)

פרמטרים

חזרה

אישור

appendText(text)

פרמטרים

חזרה

אישור

clear()

חזרה

copy()

חזרה

אישור

editAsText()

חזרה

findElement(elementType)

פרמטרים

חזרה

אישור

findElement(elementType, from)

פרמטרים

חזרה

אישור

findText(searchPattern)

פרמטרים

חזרה

אישור

findText(searchPattern, from)

פרמטרים

חזרה

אישור

getAlignment()

חזרה

אישור

getAttributes()

חזרה

אישור

getChild(childIndex)

פרמטרים

חזרה

אישור

getChildIndex(child)

פרמטרים

חזרה

אישור

getHeading()

חזרה

אישור

getIndentEnd()

חזרה

אישור

getIndentFirstLine()

חזרה

אישור

getIndentStart()

Class Paragraph

`addPositionedImage(image)`

`appendHorizontalRule()`

`appendInlineImage(image)`

`appendInlineImage(image)`

`appendPageBreak()`

`appendPageBreak(pageBreak)`

`appendText(text)`

`appendText(text)`

`clear()`

`copy()`

`editAsText()`

`findElement(elementType)`

`findElement(elementType, from)`

`findText(searchPattern)`

`findText(searchPattern, from)`

`getAlignment()`

`getAttributes()`

`getChild(childIndex)`

`getChildIndex(child)`

`getHeading()`

`getIndentEnd()`

`getIndentFirstLine()`

`getIndentStart()`

`getLineSpacing()`

`getLinkUrl()`

`getNextSibling()`

`getNumChildren()`

`getParent()`

`getPositionedImage(id)`

`getPositionedImages()`

`getPreviousSibling()`

`getSpacingAfter()`

`getSpacingBefore()`

`getText()`

`getTextAlignment()`

`getType()`

`insertHorizontalRule(childIndex)`

`insertInlineImage(childIndex, image)`

`insertInlineImage(childIndex, image)`

`insertPageBreak(childIndex)`

`insertPageBreak(childIndex, pageBreak)`

`insertText(childIndex, text)`

`insertText(childIndex, text)`