表示脚注的元素。每个 Footnote
都包含在一个 ListItem
中
或 Paragraph
,并且具有与脚注的相应 FootnoteSection
元素
内容。Footnote
本身不能包含任何其他元素。如需详细了解
请参阅有关
扩展 Google 文档。
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | Footnote | 返回当前元素的分离的深层副本。 |
getAttributes() | Object | 检索元素的属性。 |
getFootnoteContents() | FootnoteSection | 检索脚注元素的内容。 |
getNextSibling() | Element | 检索该元素的下一个同级元素。 |
getParent() | ContainerElement | 获取该元素的父元素。 |
getPreviousSibling() | Element | 检索该元素的前一个同级元素。 |
getType() | ElementType | 检索元素的 ElementType 。 |
isAtDocumentEnd() | Boolean | 确定元素是否在 Document 的末尾。 |
removeFromParent() | Footnote | 将元素从其父元素中移除。 |
setAttributes(attributes) | Footnote | 设置元素的属性。 |
详细文档
copy()
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()
getParent()
获取该元素的父元素。
父元素包含当前元素。
返回
ContainerElement
- 父元素。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
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()
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