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

Class Footnote

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

שיטות

שיטה	סוג הערך המוחזר	תיאור קצר
`copy()`	`Footnote`	הפונקציה מחזירה עותק עמוק בנפרד עבור הרכיב הנוכחי.
`getAttributes()`	`Object`	אחזור המאפיינים של הרכיב.
`getFootnoteContents()`	`FootnoteSection`	אחזור התוכן של הרכיב של הערת שוליים.
`getNextSibling()`	`Element`	אחזור של רכיב האח הבא של הרכיב.
`getParent()`	`ContainerElement`	אחזור הרכיב ההורה של הרכיב.
`getPreviousSibling()`	`Element`	אחזור של רכיב האח הקודם של הרכיב.
`getType()`	`ElementType`	מאחזר את `ElementType` של הרכיב.
`isAtDocumentEnd()`	`Boolean`	הפונקציה קובעת אם הרכיב נמצא בסוף `Document`.
`removeFromParent()`	`Footnote`	הסרת הרכיב מרכיב ההורה שלו.
`setAttributes(attributes)`	`Footnote`	מגדיר את המאפיינים של הרכיב.

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

`copy()`

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

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

חזרה

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

אישור

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

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

`getFootnoteContents()`

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

חזרה

FootnoteSection – הקטע של הערות השוליים

אישור

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

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

`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

`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

`isAtDocumentEnd()`

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

חזרה

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

אישור

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

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

חזרה

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

אישור

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

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

חזרה

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

אישור

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

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