Interface Element

מחזירה את הרכיב הנוכחי כ-Body.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-Date.

אם אתם יודעים שרכיב מסוים הוא Date, אתם יכולים להשתמש בשיטה הזו כדי להגדיר את הסוג שלו כ-Date. כך, ההשלמה האוטומטית בכלי לעריכת סקריפטים של Apps Script תציג לכם את השיטות שבהן תוכלו להשתמש עם Date.

חזרה

‫Date – הרכיב הנוכחי עם הסוג שלו שמוגדר כ-Date.

אישור

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

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

מחזירה את הרכיב הנוכחי כ-Equation.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-EquationFunction.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-EquationFunctionArgumentSeparator.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-EquationSymbol.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-FooterSection.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-Footnote.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-FootnoteSection.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-HeaderSection.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-HorizontalRule.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-InlineDrawing.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-InlineImage.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-ListItem.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-PageBreak.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-Paragraph.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-Person.

אם אתם יודעים שרכיב מסוים הוא Person, אתם יכולים להשתמש בשיטה הזו כדי להגדיר את הסוג שלו כ'אדם'. כך ההשלמה האוטומטית בכלי לעריכת סקריפטים של Apps Script תציג לכם את השיטות שבהן אפשר להשתמש עם רכיב person.

חזרה

‫Person – הרכיב הנוכחי עם הסוג שלו שמוגדר כ-Person.

אישור

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

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

מחזירה את הרכיב הנוכחי כ-RichLink, לדוגמה, קישור לקובץ Google Sheets.

אם אתם יודעים שרכיב מסוים הוא RichLink, אתם יכולים להשתמש בשיטה הזו כדי להגדיר את הסוג שלו כ-RichLink. כך, ההשלמה האוטומטית בכלי לעריכת סקריפטים של Apps Script תציג לכם את השיטות שבהן תוכלו להשתמש עם RichLink.

חזרה

‫RichLink – הרכיב הנוכחי עם הסוג שלו שמוגדר כ-RichLink.

אישור

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

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

מחזירה את הרכיב הנוכחי כ-Table.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-TableCell.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-TableOfContents.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-TableRow.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

מחזירה את הרכיב הנוכחי כ-Text.

משתמשים בשיטה הזו כדי להשלים אוטומטית כל רכיב מסוג מסוים.

חזרה

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

אישור

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

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

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

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

חזרה

‫Element – העותק החדש.

אישור

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

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

מאחזר את המאפיינים של האלמנט.

התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין תקין של רכיב, כאשר כל שם מאפיין תואם לפריט בספירה 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

מחזירה את רכיב האח הבא של הרכיב.

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

חזרה

‫Element|null – הרכיב הבא באותה רמה.

אישור

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

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

מאחזר את אלמנט ההורה של האלמנט.

רכיב ההורה מכיל את הרכיב הנוכחי.

חזרה

‫ContainerElement|null – רכיב ההורה.

אישור

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

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

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

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

חזרה

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

אישור

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

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

אחזור 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

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

חזרה

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

אישור

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

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

מיזוג הרכיב עם הרכיב הקודם מאותו סוג.

אפשר למזג רק רכיבים מאותו סוג 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();

חזרה

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

אישור

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

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

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

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

חזרה

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

אישור

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

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

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

פרמטר המאפיינים שצוין צריך להיות אובייקט שבו כל שם מאפיין הוא פריט בספירה 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);

פרמטרים

חזרה

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

אישור

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

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