דף זה תורגם על ידי Cloud Translation API.

Class HeaderSection

רכיב שמייצג קטע כותרת. בדרך כלל Document מכיל HeaderSection אחד לכל היותר. HeaderSection יכול להכיל את ListItem, Paragraph וגם רכיבי Table. למידע נוסף על מבנה המסמך, אפשר לעיין במדריך להרחבת Google Docs.

שיטות

שיטה	סוג הערך המוחזר	תיאור קצר
`appendHorizontalRule()`	`HorizontalRule`	יצירה והוספה של `HorizontalRule` חדש.
`appendImage(image)`	`InlineImage`	יצירה והוספה של `InlineImage` חדש מ-blob של התמונה שצוין.
`appendImage(image)`	`InlineImage`	הפונקציה מצרפת את הערך של `InlineImage` הנתון.
`appendListItem(listItem)`	`ListItem`	הפונקציה מצרפת את הערך של `ListItem` הנתון.
`appendListItem(text)`	`ListItem`	יצירה והוספה של `ListItem` חדש שמכיל את תוכן הטקסט שצוין.
`appendParagraph(paragraph)`	`Paragraph`	הפונקציה מצרפת את הערך של `Paragraph` הנתון.
`appendParagraph(text)`	`Paragraph`	יצירה והוספה של `Paragraph` חדש שמכיל את תוכן הטקסט שצוין.
`appendTable()`	`Table`	יצירה והוספה של `Table` חדש.
`appendTable(cells)`	`Table`	הפונקציה מצרפת `Table` חדש שמכיל `TableCell` לכל ערך מחרוזת שצוין.
`appendTable(table)`	`Table`	הפונקציה מצרפת את הערך של `Table` הנתון.
`clear()`	`HeaderSection`	ניקוי התוכן של הרכיב.
`copy()`	`HeaderSection`	הפונקציה מחזירה עותק עמוק בנפרד עבור הרכיב הנוכחי.
`editAsText()`	`Text`	מתקבלת גרסת `Text` של הרכיב הנוכחי, לעריכה.
`findElement(elementType)`	`RangeElement`	חיפוש תוכן הרכיב כדי למצוא צאצא מהסוג שצוין.
`findElement(elementType, from)`	`RangeElement`	מחפש את תוכן הרכיב כדי למצוא צאצא מהסוג שצוין, החל מ- ציינת `RangeElement`.
`findText(searchPattern)`	`RangeElement`	חיפוש תוכן הרכיב לפי דפוס הטקסט שצוין באמצעות ביטויים רגולריים.
`findText(searchPattern, from)`	`RangeElement`	חיפוש תוכן הרכיב לפי תבנית הטקסט שצוינה, החל ממאפיין נתון בתוצאות החיפוש.
`getAttributes()`	`Object`	אחזור המאפיינים של הרכיב.
`getChild(childIndex)`	`Element`	אחזור הרכיב הצאצא באינדקס הצאצא שצוין.
`getChildIndex(child)`	`Integer`	אחזור של אינדקס הצאצא לרכיב הצאצא שצוין.
`getImages()`	`InlineImage[]`	אחזור כל `InlineImages` הכלולים בקטע.
`getListItems()`	`ListItem[]`	אחזור כל `ListItems` הכלולים בקטע.
`getNumChildren()`	`Integer`	אחזור של מספר הילדים.
`getParagraphs()`	`Paragraph[]`	אחזור כל `Paragraphs` הכלולים בקטע (כולל `ListItems`).
`getParent()`	`ContainerElement`	אחזור הרכיב ההורה של הרכיב.
`getTables()`	`Table[]`	אחזור כל `Tables` הכלולים בקטע.
`getText()`	`String`	אחזור תוכן הרכיב כמחרוזת טקסט.
`getTextAlignment()`	`TextAlignment`	מקבל את היישור של הטקסט.
`getType()`	`ElementType`	מאחזר את `ElementType` של הרכיב.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	יצירה והוספה של `HorizontalRule` חדש באינדקס שצוין.
`insertImage(childIndex, image)`	`InlineImage`	יצירה והוספה של `InlineImage` מה-blob של התמונה שצוין, בתרחיש שצוין להוסיף לאינדקס.
`insertImage(childIndex, image)`	`InlineImage`	מוסיפה את `InlineImage` הנתון באינדקס שצוין.
`insertListItem(childIndex, listItem)`	`ListItem`	מוסיפה את `ListItem` הנתון באינדקס שצוין.
`insertListItem(childIndex, text)`	`ListItem`	יצירה והוספה של `ListItem` חדש באינדקס שצוין, שמכיל את הערך שצוין את תוכן הטקסט.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	מוסיפה את `Paragraph` הנתון באינדקס שצוין.
`insertParagraph(childIndex, text)`	`Paragraph`	יצירה והוספה של `Paragraph` חדש באינדקס שצוין, שמכיל את הערך שצוין את תוכן הטקסט.
`insertTable(childIndex)`	`Table`	יצירה והוספה של `Table` חדש באינדקס שצוין.
`insertTable(childIndex, cells)`	`Table`	יצירה והוספה של `Table` חדש שמכיל את התאים שצוינו, באינדקס שצוין.
`insertTable(childIndex, table)`	`Table`	מוסיפה את `Table` הנתון באינדקס שצוין.
`removeChild(child)`	`HeaderSection`	הסרת רכיב הצאצא שצוין.
`removeFromParent()`	`HeaderSection`	הסרת הרכיב מרכיב ההורה שלו.
`replaceText(searchPattern, replacement)`	`Element`	מחליפה את כל המופעים של תבנית טקסט נתונה במחרוזת החלפה נתונה, באמצעות הפונקציה הרגילה הבעות פנים.
`setAttributes(attributes)`	`HeaderSection`	מגדיר את המאפיינים של הרכיב.
`setText(text)`	`HeaderSection`	מגדיר את התוכן כטקסט פשוט.
`setTextAlignment(textAlignment)`	`HeaderSection`	מגדיר את יישור הטקסט.

שיטות שהוצאו משימוש

שיטה	סוג הערך המוחזר	תיאור קצר
`getFootnotes()`	`Footnote[]`	אחזור כל `Footnotes` הכלולים בקטע.
`getLinkUrl()`	`String`	אחזור כתובת ה-URL של הקישור.
`getNextSibling()`	`Element`	אחזור של רכיב האח הבא של הרכיב.
`getPreviousSibling()`	`Element`	אחזור של רכיב האח הקודם של הרכיב.
`isAtDocumentEnd()`	`Boolean`	הפונקציה קובעת אם הרכיב נמצא בסוף `Document`.
`setLinkUrl(url)`	`HeaderSection`	מגדיר את כתובת האתר של הקישור.

מסמכי תיעוד מפורטים

`appendHorizontalRule()`

יצירה והוספה של HorizontalRule חדש.

השדה HorizontalRule ייכלל בקובץ Paragraph חדש.

חזרה

HorizontalRule – הכלל האופקי החדש.

אישור

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

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

`appendImage(image)`

יצירה והוספה של InlineImage חדש מ-blob של התמונה שצוין.

התמונה תיכלל בקובץ Paragraph חדש.

פרמטרים

שם	סוג	תיאור
`image`	`BlobSource`	נתוני התמונה.

חזרה

InlineImage – התמונה שמצורפת.

אישור

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

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

`appendImage(image)`

הפונקציה מצרפת את הערך של InlineImage הנתון.

השדה InlineImage ייכלל בקובץ Paragraph חדש.

צריך להשתמש בגרסה הזו של appendImage כשמצרפים עותק של InlineImage קיים.

פרמטרים

שם	סוג	תיאור
`image`	`InlineImage`	נתוני התמונה.

חזרה

InlineImage – התמונה שמצורפת.

אישור

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

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

`appendListItem(listItem)`

הפונקציה מצרפת את הערך של ListItem הנתון.

צריך להשתמש בגרסה הזו של appendListItem כשמצרפים עותק של ListItem קיים.

פרמטרים

שם	סוג	תיאור
`listItem`	`ListItem`	הפריט ברשימה שיש לצרף.

חזרה

ListItem – הפריט שצורף ברשימה.

אישור

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

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

`appendListItem(text)`

יצירה והוספה של ListItem חדש שמכיל את תוכן הטקסט שצוין.

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

פרמטרים

שם	סוג	תיאור
`text`	`String`	תוכן הטקסט של הפריט ברשימה.

חזרה

ListItem – הפריט החדש ברשימה.

אישור

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

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

`appendParagraph(paragraph)`

הפונקציה מצרפת את הערך של Paragraph הנתון.

צריך להשתמש בגרסה הזו של appendParagraph כשמצרפים עותק של Paragraph קיים.

פרמטרים

שם	סוג	תיאור
`paragraph`	`Paragraph`	הפסקה שצריך לצרף.

חזרה

Paragraph – הפסקה שצורפה.

אישור

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

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

`appendParagraph(text)`

יצירה והוספה של Paragraph חדש שמכיל את תוכן הטקסט שצוין.

פרמטרים

שם	סוג	תיאור
`text`	`String`	תוכן הטקסט של הפסקה.

חזרה

Paragraph – הפסקה החדשה.

אישור

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

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

`appendTable()`

יצירה והוספה של Table חדש.

השיטה הזו גם תוסיף פסקה ריקה אחרי הטבלה, מפני שמסמכי Google Docs לא יכול להסתיים בטבלה.

חזרה

Table – הטבלה החדשה.

אישור

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

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

`appendTable(cells)`

הפונקציה מצרפת Table חדש שמכיל TableCell לכל ערך מחרוזת שצוין.

השיטה הזו גם תוסיף פסקה ריקה אחרי הטבלה, מפני שמסמכי Google Docs לא יכול להסתיים בטבלה.

פרמטרים

שם	סוג	תיאור
`cells`	`String[][]`	תוכן הטקסט של תאי הטבלה, שאותו רוצים להוסיף לטבלה החדשה.

חזרה

Table – הטבלה המצורפת.

אישור

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

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

`appendTable(table)`

הפונקציה מצרפת את הערך של Table הנתון.

צריך להשתמש בגרסה הזו של appendTable כשמצרפים עותק של Table קיים. השיטה הזו גם תוסיף פסקה ריקה אחרי הטבלה, מפני שמסמכי Google Docs לא יכול להסתיים בטבלה.

פרמטרים

שם	סוג	תיאור
`table`	`Table`	הטבלה שצריך לצרף.

חזרה

Table – הטבלה המצורפת.

אישור

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

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

`clear()`

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

חזרה

HeaderSection – הרכיב הנוכחי.

`copy()`

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

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

חזרה

HeaderSection – העותק החדש.

אישור

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

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

`editAsText()`

מתקבלת גרסת Text של הרכיב הנוכחי, לעריכה.

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

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

var 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 - תוצאת חיפוש שמציינת את המיקום של רכיב החיפוש.

אישור

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

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

`findElement(elementType, from)`

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

var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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

`getAttributes()`

אחזור המאפיינים של הרכיב.

התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין חוקי של רכיב שבו כל אחד שם המאפיין תואם לפריט בספירה DocumentApp.Attribute.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Append a styled paragraph.
var par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
var atts = par.getAttributes();

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

חזרה

Object – המאפיינים של הרכיב.

אישור

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

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

`getChild(childIndex)`

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

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

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

`getImages()`

אחזור כל InlineImages הכלולים בקטע.

חזרה

InlineImage[] – תמונות הקטע.

אישור

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

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

`getListItems()`

אחזור כל ListItems הכלולים בקטע.

חזרה

ListItem[] – הפריטים ברשימת הקטעים.

אישור

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

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

`getNumChildren()`

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

var 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

`getParagraphs()`

אחזור כל Paragraphs הכלולים בקטע (כולל ListItems).

חזרה

Paragraph[] – הפסקאות בקטע.

אישור

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

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

`getTables()`

אחזור כל Tables הכלולים בקטע.

חזרה

Table[] – טבלאות הקטעים.

אישור

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

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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's body.

var firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

חזרה

ElementType – סוג הרכיב.

אישור

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

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

`insertHorizontalRule(childIndex)`

יצירה והוספה של HorizontalRule חדש באינדקס שצוין.

השדה HorizontalRule ייכלל בקובץ Paragraph חדש.

פרמטרים

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

חזרה

HorizontalRule – הכלל האופקי החדש.

אישור

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

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

`insertImage(childIndex, image)`

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

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו יש להוסיף את הרכיב.
`image`	`BlobSource`	נתוני התמונה.

חזרה

InlineImage – התמונה בתוך השורה שהוכנסה.

אישור

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

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

`insertImage(childIndex, image)`

מוסיפה את InlineImage הנתון באינדקס שצוין.

התמונה תיכלל בקובץ Paragraph חדש.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו יש להוסיף את הרכיב.
`image`	`InlineImage`	התמונה להוספה.

חזרה

InlineImage – התמונה בתוך השורה שהוכנסה.

אישור

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

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

`insertListItem(childIndex, listItem)`

מוסיפה את ListItem הנתון באינדקס שצוין.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו יש להוסיף.
`listItem`	`ListItem`	הפריט שרוצים להוסיף ברשימה.

חזרה

ListItem – הפריט שנוסף ברשימה.

אישור

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

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

`insertListItem(childIndex, text)`

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

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו יש להוסיף.
`text`	`String`	תוכן הטקסט של הפריט ברשימה.

חזרה

ListItem – הפריט החדש ברשימה.

אישור

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

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

`insertParagraph(childIndex, paragraph)`

מוסיפה את Paragraph הנתון באינדקס שצוין.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו יש להוסיף.
`paragraph`	`Paragraph`	הפסקה להוספה.

חזרה

Paragraph – הפסקה שהוכנסה.

אישור

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

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

`insertParagraph(childIndex, text)`

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

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו יש להוסיף.
`text`	`String`	תוכן הטקסט של הפסקה.

חזרה

Paragraph – הפסקה החדשה.

אישור

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

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

`insertTable(childIndex)`

יצירה והוספה של Table חדש באינדקס שצוין.

פרמטרים

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

חזרה

Table – הטבלה החדשה.

אישור

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

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

`insertTable(childIndex, cells)`

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

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו יש להוסיף.
`cells`	`String[][]`	תוכן הטקסט של תאי הטבלה, שאותו רוצים להוסיף לטבלה החדשה.

חזרה

Table – הטבלה החדשה.

אישור

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

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

`insertTable(childIndex, table)`

מוסיפה את Table הנתון באינדקס שצוין.

פרמטרים

שם	סוג	תיאור
`childIndex`	`Integer`	האינדקס שבו יש להוסיף.
`table`	`Table`	הטבלה להוספה.

חזרה

Table – הטבלה שהוכנסה.

אישור

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

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

`removeChild(child)`

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

פרמטרים

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

חזרה

HeaderSection – הרכיב הנוכחי.

אישור

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

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

`removeFromParent()`

הסרת הרכיב מרכיב ההורה שלו.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab()
var body = documentTab.getBody();

// Remove all images in the active tab's body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

חזרה

HeaderSection – הרכיב שהוסר.

אישור

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

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

`replaceText(searchPattern, replacement)`

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

דפוס החיפוש מועבר כמחרוזת, ולא כאובייקט של ביטוי רגולרי של JavaScript. לכן, צריך לסמן בתו בריחה (escape) את כל לוכסן הפוך בתבנית.

בשיטה הזאת נעשה שימוש במודל RE2 הרגיל של Google של ביטויים, שמגבילה את התחביר הנתמך.

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

var 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

`setAttributes(attributes)`

מגדיר את המאפיינים של הרכיב.

פרמטר המאפיינים שצוין חייב להיות אובייקט שבו כל שם מאפיין הוא פריט ב- הספירה של DocumentApp.Attribute וכל ערך מאפיין הוא הערך החדש שצריך הוחלו.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Define a custom paragraph style.
var style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
var par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

פרמטרים

שם	סוג	תיאור
`attributes`	`Object`	המאפיינים של הרכיב.

חזרה

HeaderSection – הרכיב הנוכחי.

אישור

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

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

`setText(text)`

מגדיר את התוכן כטקסט פשוט.

הערה: התוכן הקיים נמחק.

פרמטרים

שם	סוג	תיאור
`text`	`String`	תוכן הטקסט החדש.

חזרה

HeaderSection – הרכיב הנוכחי.

אישור

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

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.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

פרמטרים

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

חזרה

HeaderSection – הרכיב הנוכחי

אישור

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

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

שיטות שהוצאו משימוש

`getFootnotes()`

הוצא משימוש. הרכיב הזה לא יכול להכיל Footnote.

אחזור כל Footnotes הכלולים בקטע.

חזרה

Footnote[] – הערות השוליים לקטע.

אישור

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

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

`getPreviousSibling()`

הוצא משימוש. לרכיב הזה אין אחים ואחיות.

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

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

חזרה

Element — רכיב האח הקודם.

אישור

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

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

`isAtDocumentEnd()`

הוצא משימוש. השיטה הזו לא מהימנה ל-HeaderSection.

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

חזרה

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

אישור

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

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

`setLinkUrl(url)`

הוצא משימוש. במקום להחיל קישור על קטע שלם, אפשר להחיל את הקישור על רכיב בקטע.

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

פרמטרים

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

חזרה

HeaderSection – הרכיב הנוכחי

אישור

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

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