Class FootnoteSection

FootnoteSection

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

שיטות

שיטהסוג הערך שמוחזרתיאור קצר
appendParagraph(paragraph)Paragraphהפונקציה הזאת מצרפת את הערך Paragraph.
appendParagraph(text)Paragraphיצירה וצירוף של Paragraph חדש שמכיל את תוכן הטקסט שצוין.
clear()FootnoteSectionניקוי התוכן של הרכיב.
copy()FootnoteSectionמחזירה עותק מנותק ועמוק של הרכיב הנוכחי.
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מאחזר את אינדקס הצאצא של רכיב הצאצא שצוין.
getNextSibling()Elementשולפת את הרכיב האח הבא של הרכיב.
getNumChildren()Integerאחזור מספר הילדים.
getParagraphs()Paragraph[]מאחזר את כל Paragraphs שנכללו בקטע (כולל ListItems).
getParent()ContainerElementאחזור של רכיב ההורה של הרכיב.
getPreviousSibling()Elementאחזור הרכיב האח הקודם של הרכיב.
getText()Stringמאחזר את התוכן של הרכיב כמחרוזת טקסט.
getTextAlignment()TextAlignmentהפונקציה הזו משיגה את היישור של הטקסט.
getType()ElementTypeאחזור ה-ElementType של הרכיב.
insertParagraph(childIndex, paragraph)Paragraphהפונקציה מוסיפה את הערך הנתון Paragraph באינדקס שצוין.
insertParagraph(childIndex, text)Paragraphיוצרת ומוסיפה Paragraph חדש באינדקס שצוין, שמכיל את תוכן הטקסט שצוין.
removeChild(child)FootnoteSectionמסיר את רכיב הצאצא שצוין.
removeFromParent()FootnoteSectionמסיר את הרכיב מההורה שלו.
replaceText(searchPattern, replacement)Elementמחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים.
setAttributes(attributes)FootnoteSectionמגדיר את מאפייני הרכיב.
setText(text)FootnoteSectionמגדיר את התוכן כטקסט פשוט.
setTextAlignment(textAlignment)FootnoteSectionהגדרת יישור הטקסט.

תיעוד מפורט

appendParagraph(paragraph)

הפונקציה הזאת מצרפת את הערך Paragraph.

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

פרמטרים

שםתיאורהתיאור
paragraphParagraphהפסקה שצריך לצרף

החזרות

Paragraph - הפסקה המצורפת

הרשאות

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

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

appendParagraph(text)

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

פרמטרים

שםתיאורהתיאור
textStringתוכן הטקסט של הפסקה

החזרות

Paragraph - הפסקה החדשה

הרשאות

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

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

clear()

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

החזרות

FootnoteSection - הרכיב הנוכחי


copy()

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

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

החזרות

FootnoteSection - העותק החדש.

הרשאות

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

  • 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)

מחפשת צאצא מהסוג שצוין.

פרמטרים

שםתיאורהתיאור
elementTypeElementTypeסוג הרכיב שיש לחפש

החזרות

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

פרמטרים

שםתיאורהתיאור
elementTypeElementTypeסוג הרכיב שיש לחפש
fromRangeElementתוצאת החיפוש שממנה יש לחפש

החזרות

RangeElement - תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש

הרשאות

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

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

findText(searchPattern)

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

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

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

פרמטרים

שםתיאורהתיאור
searchPatternStringהדפוס שצריך לחפש

החזרות

RangeElement - תוצאת חיפוש שמציינת את מיקום הטקסט לחיפוש, או הערך null אם אין התאמה

הרשאות

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

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

findText(searchPattern, from)

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

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

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

פרמטרים

שםתיאורהתיאור
searchPatternStringהדפוס שצריך לחפש
fromRangeElementתוצאת החיפוש שממנה יש לחפש

החזרות

RangeElement - תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או הערך null אם אין התאמה

הרשאות

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

  • 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.");
}

פרמטרים

שםתיאורהתיאור
childIndexIntegerאת האינדקס של רכיב הצאצא שצריך לאחזר

החזרות

Element - רכיב הצאצא באינדקס שצוין

הרשאות

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

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

getChildIndex(child)

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

פרמטרים

שםתיאורהתיאור
childElementאת רכיב הצאצא שעבורו יש לאחזר את האינדקס

החזרות

Integer - אינדקס הצאצא

הרשאות

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

  • 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

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

getPreviousSibling()

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

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

החזרות

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

הרשאות

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

  • 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

insertParagraph(childIndex, paragraph)

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

פרמטרים

שםתיאורהתיאור
childIndexIntegerאת האינדקס שיש להכניס
paragraphParagraphהפסקה שיש להוסיף

החזרות

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

הרשאות

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

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

insertParagraph(childIndex, text)

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

פרמטרים

שםתיאורהתיאור
childIndexIntegerאת האינדקס שיש להכניס
textStringתוכן הטקסט של הפסקה

החזרות

Paragraph - הפסקה החדשה

הרשאות

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

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

removeChild(child)

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

פרמטרים

שםתיאורהתיאור
childElementאת רכיב הצאצא להסרה

החזרות

FootnoteSection - הרכיב הנוכחי

הרשאות

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

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

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

החזרות

FootnoteSection - הרכיב שהוסר.

הרשאות

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

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

replaceText(searchPattern, replacement)

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

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

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

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

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

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

פרמטרים

שםתיאורהתיאור
searchPatternStringאת הדפוס הרגולרי שצריך לחפש
replacementStringבטקסט שישמש כתחליף

החזרות

Element - הרכיב הנוכחי

הרשאות

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

  • 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);

פרמטרים

שםתיאורהתיאור
attributesObjectמאפייני הרכיב.

החזרות

FootnoteSection - הרכיב הנוכחי.

הרשאות

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

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

setText(text)

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

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

פרמטרים

שםתיאורהתיאור
textStringתוכן הטקסט החדש

החזרות

FootnoteSection - הרכיב הנוכחי

הרשאות

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

  • 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);

פרמטרים

שםתיאורהתיאור
textAlignmentTextAlignmentסוג היישור של הטקסט שצריך להחיל

החזרות

FootnoteSection - הרכיב הנוכחי

הרשאות

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

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

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