רכיב שמייצג קטע של הערת שוליים. Footnote
מכיל את הטקסט שתואם ל-Footnote
. ה-Footnote
יכול להכיל רכיבי List
או Paragraph
. מידע נוסף על מבנה המסמך זמין במדריך להרחבת Google Docs.
Methods
שיטה | סוג הערך המוחזר | תיאור קצר |
---|---|---|
append | Paragraph | הוספה של Paragraph הנתון. |
append | Paragraph | יצירת Paragraph חדש שמצורף אליו תוכן הטקסט שצוין. |
clear() | Footnote | ניקוי התוכן של הרכיב. |
copy() | Footnote | הפונקציה מחזירה עותק מנותק ומעמיק של הרכיב הנוכחי. |
edit | Text | הצגת גרסת Text של הרכיב הנוכחי לצורך עריכה. |
find | Range | חיפוש בתוכן של הרכיב אחר צאצא מהסוג שצוין. |
find | Range | הפונקציה מחפשת בתוכן של הרכיב צאצא מהסוג שצוין, החל מ-Range שצוין. |
find | Range | חיפוש דפוס הטקסט שצוין בתוכן של האלמנט באמצעות ביטויים רגולריים. |
find | Range | חיפוש של דפוס הטקסט שצוין בתוכן הרכיב, החל מתוצאת חיפוש נתונה. |
get | Object | אחזור המאפיינים של האלמנט. |
get | Element | אחזור רכיב הצאצא לפי אינדקס הצאצא שצוין. |
get | Integer | אחזור של מדד הצאצא של רכיב הצאצא שצוין. |
get | Element | אחזור הרכיב הבא של הרכיב. |
get | Integer | אחזור מספר הילדים. |
get | Paragraph[] | אחזור כל ה-Paragraphs שמכיל הקטע (כולל List ). |
get | Container | אחזור של רכיב ההורה של האלמנט. |
get | Element | אחזור של רכיב האח הקודם של הרכיב. |
get | String | אחזור התוכן של הרכיב כמחרוזת טקסט. |
get | Text | הפונקציה מקבלת את יישור הטקסט. |
get | Element | אחזור הערך של Element ברכיב. |
insert | Paragraph | הוספת Paragraph הנתון באינדקס שצוין. |
insert | Paragraph | יצירת Paragraph חדש והוספה שלו לאינדקס שצוין, עם תוכן הטקסט שצוין. |
remove | Footnote | הסרה של רכיב הבן שצוין. |
remove | Footnote | הסרת הרכיב מהרכיב ההורה שלו. |
replace | Element | מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים. |
set | Footnote | הגדרת המאפיינים של האלמנט. |
set | Footnote | הגדרת התוכן כטקסט פשוט. |
set | Footnote | הגדרת יישור הטקסט. |
מסמכים מפורטים
append Paragraph(paragraph)
הוספה של Paragraph
הנתון.
משתמשים בגרסה הזו של append
כשמחברים עותק של Paragraph
קיים.
פרמטרים
שם | סוג | תיאור |
---|---|---|
paragraph | Paragraph | הפסקה שרוצים לצרף. |
חזרה
Paragraph
– הפיסקה שנוספה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
append Paragraph(text)
יצירת Paragraph
חדש שמצורף אליו תוכן הטקסט שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | String | תוכן הטקסט של הפסקה. |
חזרה
Paragraph
— הפיסקה החדשה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
הפונקציה מחזירה עותק מנותק ומעמיק של הרכיב הנוכחי.
כל אלמנטי הצאצא שנמצאים באלמנט יועתקו גם כן. לאלמנט החדש אין הורה.
חזרה
Footnote
– העותק החדש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
edit As Text()
הצגת גרסת Text
של הרכיב הנוכחי לצורך עריכה.
משתמשים ב-edit
כדי לבצע פעולות על תוכן הרכיבים כטקסט עשיר. במצב edit
המערכת מתעלמת מאלמנטים שאינם טקסט (כמו Inline
ו-Horizontal
).
רכיבי צאצא שנכללים במלואם בטווח הטקסט שנמחק יוסרו מהרכיב.
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
— גרסה טקסטואלית של הרכיב הנוכחי
find Element(elementType)
חיפוש בתוכן של הרכיב אחר צאצא מהסוג שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
element | Element | סוג הרכיב שרוצים לחפש. |
חזרה
Range
— תוצאת חיפוש שמציינת את המיקום של רכיב החיפוש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Element(elementType, from)
הפונקציה מחפשת בתוכן של הרכיב צאצא מהסוג שצוין, החל מ-Range
שצוין.
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; } }
פרמטרים
שם | סוג | תיאור |
---|---|---|
element | Element | סוג הרכיב שרוצים לחפש. |
from | Range | תוצאת החיפוש שממנה רוצים לבצע חיפוש. |
חזרה
Range
— תוצאת חיפוש שמציינת את המיקום הבא של רכיב החיפוש.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern)
חיפוש דפוס הטקסט שצוין בתוכן של האלמנט באמצעות ביטויים רגולריים.
אין תמיכה מלאה בקבוצת משנה של תכונות הביטויים הרגולריים של JavaScript, כמו קבוצות תיעוד (capture groups) ומשתני שינוי מצב (mode modifiers).
תבנית הביטוי הרגולרי שצוינה מותאמת בנפרד לכל בלוק טקסט שמכיל את הרכיב הנוכחי.
פרמטרים
שם | סוג | תיאור |
---|---|---|
search | String | הדפוס שרוצים לחפש |
חזרה
Range
– תוצאת חיפוש שמציינת את המיקום של טקסט החיפוש, או null אם אין התאמה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern, from)
חיפוש של דפוס הטקסט שצוין בתוכן הרכיב, החל מתוצאת חיפוש נתונה.
אין תמיכה מלאה בקבוצת משנה של תכונות הביטויים הרגולריים של JavaScript, כמו קבוצות תיעוד (capture groups) ומשתני שינוי מצב (mode modifiers).
תבנית הביטוי הרגולרי שצוינה מותאמת בנפרד לכל בלוק טקסט שמכיל את הרכיב הנוכחי.
פרמטרים
שם | סוג | תיאור |
---|---|---|
search | String | הדפוס שרוצים לחפש |
from | Range | תוצאת החיפוש שבה רוצים לבצע חיפוש |
חזרה
Range
– תוצאת חיפוש שמציינת את המיקום הבא של טקסט החיפוש, או null אם אין התאמה
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Attributes()
אחזור המאפיינים של האלמנט.
התוצאה היא אובייקט שמכיל מאפיין לכל מאפיין רכיב תקין, כאשר כל שם מאפיין תואם לפריט בספירה Document
.
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
get Child(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.'); }
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס של רכיב הצאצא שרוצים לאחזר. |
חזרה
Element
– רכיב הצאצא במדד שצוין.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get ChildIndex(child)
אחזור של מדד הצאצא של רכיב הצאצא שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Element | רכיב הצאצא שעבורו רוצים לאחזר את האינדקס. |
חזרה
Integer
— האינדקס של הצאצא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Next Sibling()
אחזור הרכיב הבא של הרכיב.
לרכיב האח הבא יש אותו הורה והוא מופיע אחרי הרכיב הנוכחי.
חזרה
Element
– רכיב האח הבא.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Num Children()
אחזור מספר הילדים.
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
get Paragraphs()
אחזור כל ה-Paragraphs
שמכיל הקטע (כולל List
).
חזרה
Paragraph[]
– הפסקות בקטע.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Parent()
אחזור של רכיב ההורה של האלמנט.
רכיב ההורה מכיל את הרכיב הנוכחי.
חזרה
Container
– רכיב ההורה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Previous Sibling()
אחזור של רכיב האח הקודם של הרכיב.
לרכיב האח הקודם יש אותו הורה והוא מופיע לפני הרכיב הנוכחי.
חזרה
Element
— רכיב האח/ה הקודם.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text()
אחזור התוכן של הרכיב כמחרוזת טקסט.
חזרה
String
– התוכן של הרכיב כמחרוזת טקסט
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text Alignment()
הפונקציה מקבלת את יישור הטקסט. סוגי ההתאמה הזמינים הם Document
, Document
ו-Document
.
חזרה
Text
– סוג היישור של הטקסט, או null
אם הטקסט מכיל כמה סוגים של יישור טקסט או אם יישור הטקסט מעולם לא הוגדר
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Type()
אחזור הערך של Element
ברכיב.
אפשר להשתמש ב-get
כדי לקבוע את הסוג המדויק של רכיב נתון.
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.'); }
חזרה
Element
– סוג הרכיב.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Paragraph(childIndex, paragraph)
הוספת Paragraph
הנתון באינדקס שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. |
paragraph | Paragraph | הפסקה שרוצים להוסיף. |
חזרה
Paragraph
– הפיסקה שנוספה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Paragraph(childIndex, text)
יצירת Paragraph
חדש והוספה שלו לאינדקס שצוין, עם תוכן הטקסט שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Integer | האינדקס שבו רוצים להוסיף את הרכיב. |
text | String | תוכן הטקסט של הפסקה. |
חזרה
Paragraph
— הפיסקה החדשה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove Child(child)
הסרה של רכיב הבן שצוין.
פרמטרים
שם | סוג | תיאור |
---|---|---|
child | Element | רכיב הצאצא שרוצים להסיר. |
חזרה
Footnote
– הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove From Parent()
הסרת הרכיב מהרכיב ההורה שלו.
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(); }
חזרה
Footnote
– הרכיב שהוסרה.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replace Text(searchPattern, replacement)
מחליפה את כל המופעים של דפוס טקסט נתון במחרוזת החלפה נתונה, באמצעות ביטויים רגולריים.
דפוס החיפוש מועבר כמחרוזת, ולא כאובייקט של ביטוי רגולרי ב-JavaScript. לכן צריך להשתמש בתו בריחה (escape) לפני כל קו נטוי לאחור בתבנית.
השיטות האלה משתמשות בספריית הביטויים הרגולריים של Google, RE2, שמגבילה את התחביר הנתמך.
תבנית הביטוי הרגולרי שצוינה מותאמת בנפרד לכל בלוק טקסט שמכיל את הרכיב הנוכחי.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
פרמטרים
שם | סוג | תיאור |
---|---|---|
search | String | דפוס הביטוי הרגולרי לחיפוש |
replacement | String | הטקסט שישמש להחלפה |
חזרה
Element
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Attributes(attributes)
הגדרת המאפיינים של האלמנט.
פרמטר המאפיינים שצוין חייב להיות אובייקט שבו כל שם מאפיין הוא פריט בספירה של Document
וכל ערך מאפיין הוא הערך החדש שרוצים להחיל.
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 | המאפיינים של האלמנט. |
חזרה
Footnote
– הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text(text)
הגדרת התוכן כטקסט פשוט.
הערה: התוכן הקיים יימחק.
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | String | תוכן הטקסט החדש. |
חזרה
Footnote
– הרכיב הנוכחי.
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text Alignment(textAlignment)
הגדרת יישור הטקסט. סוגי ההתאמה הזמינים הם Document
, Document
ו-Document
.
// 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);
פרמטרים
שם | סוג | תיאור |
---|---|---|
text | Text | סוג יישור הטקסט שרוצים להחיל |
חזרה
Footnote
– הרכיב הנוכחי
אישור
סקריפטים שמשתמשים בשיטה הזו דורשים הרשאה עם אחד או יותר מהיקפי הגישה הבאים:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents