表示页脚部分的元素。一个 Document
通常最多包含一个 FooterSection
。FooterSection
可能包含 ListItem
、Paragraph
和
Table
元素。有关文档结构的详细信息,请参阅扩展 Google 文档指南。
方法
详细文档
appendHorizontalRule()
创建并附加新的 HorizontalRule
。
HorizontalRule
将包含在新 Paragraph
中。
返回
HorizontalRule
- 新的水平规则。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
根据指定的图片 blob 创建并附加新的 InlineImage
。
图片将包含到新的 Paragraph
中。
参数
名称 | 类型 | 说明 |
---|---|---|
image | BlobSource | 图片数据。 |
返回
InlineImage
- 附加的图片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
附加指定的 InlineImage
。
InlineImage
将包含在新 Paragraph
中。
附加现有 InlineImage
的副本时,请使用此版本的 appendImage
。
参数
名称 | 类型 | 说明 |
---|---|---|
image | InlineImage | 图片数据。 |
返回
InlineImage
- 附加的图片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(listItem)
appendListItem(text)
appendParagraph(paragraph)
appendParagraph(text)
appendTable()
appendTable(cells)
appendTable(table)
clear()
copy()
返回当前元素的分离的深层副本。
元素中存在的所有子元素也会被复制。新元素不含 。
返回
FooterSection
- 新副本。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
获取当前元素的 Text
版本,以用于修改。
使用 editAsText
可将元素内容处理为富文本格式。editAsText
模式会忽略非文本元素(例如 InlineImage
和 HorizontalRule
)。
完全包含在已删除文本范围内的子元素会从相应元素中移除。
var 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
- 当前元素的文本版本
findElement(elementType)
搜索指定类型的后代元素的内容。
参数
名称 | 类型 | 说明 |
---|---|---|
elementType | ElementType | 要搜索的元素的类型。 |
返回
RangeElement
- 表示搜索元素位置的搜索结果。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
搜索指定类型的后代元素的内容,从
指定的 RangeElement
。
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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; } }
参数
名称 | 类型 | 说明 |
---|---|---|
elementType | ElementType | 要搜索的元素的类型。 |
from | RangeElement | 要搜索的搜索结果。 |
返回
RangeElement
- 表示搜索元素的下一个位置的搜索结果。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
使用正则表达式搜索指定文本格式的元素内容。
部分 JavaScript 正则表达式功能尚不完全受支持,例如 捕获组和模式修饰符。
所提供的正则表达式格式会与每个文本块独立进行匹配 当前元素中包含的某些内容。
参数
名称 | 类型 | 说明 |
---|---|---|
searchPattern | String | 要搜索的模式 |
返回
RangeElement
- 表示搜索文本位置的搜索结果;如果没有搜索文本的位置,则为 null
匹配
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
搜索指定文本格式的元素内容,从指定的 搜索结果。
部分 JavaScript 正则表达式功能尚不完全受支持,例如 捕获组和模式修饰符。
所提供的正则表达式格式会与每个文本块独立进行匹配 当前元素中包含的某些内容。
参数
名称 | 类型 | 说明 |
---|---|---|
searchPattern | String | 要搜索的模式 |
from | RangeElement | 要搜索的搜索结果 |
返回
RangeElement
- 表示搜索文本下一个位置的搜索结果;如果没有搜索文本的下一个位置,则返回 null。
匹配
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
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
getChild(childIndex)
检索指定子索引处的子元素。
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. 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."); }
参数
名称 | 类型 | 说明 |
---|---|---|
childIndex | Integer | 要检索的子元素的索引。 |
返回
Element
- 位于指定索引处的子元素。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
getImages()
检索相应区段中包含的所有 InlineImages
。
返回
InlineImage[]
- 版块的图片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getListItems()
检索相应区段中包含的所有 ListItems
。
返回
ListItem[]
- 该部分列表项。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
检索子元素的数量。
var 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
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
getTables()
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 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
insertHorizontalRule(childIndex)
在指定索引处创建并插入新的 HorizontalRule
。
HorizontalRule
将包含在新 Paragraph
中。
参数
名称 | 类型 | 说明 |
---|---|---|
childIndex | Integer | 要插入元素的索引。 |
返回
HorizontalRule
- 新的水平规则。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
在指定的图片 blob 处创建并插入 InlineImage
。
索引中。
参数
名称 | 类型 | 说明 |
---|---|---|
childIndex | Integer | 要插入元素的索引。 |
image | BlobSource | 图片数据。 |
返回
InlineImage
- 插入的内嵌图片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
在指定索引处插入给定 InlineImage
。
图片将包含到新的 Paragraph
中。
参数
名称 | 类型 | 说明 |
---|---|---|
childIndex | Integer | 要插入元素的索引。 |
image | InlineImage | 要插入的图片。 |
返回
InlineImage
- 插入的内嵌图片。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
insertListItem(childIndex, text)
insertParagraph(childIndex, paragraph)
insertParagraph(childIndex, text)
insertTable(childIndex)
insertTable(childIndex, cells)
insertTable(childIndex, table)
removeChild(child)
删除指定的子元素。
参数
名称 | 类型 | 说明 |
---|---|---|
child | Element | 要移除的子元素。 |
返回
FooterSection
- 当前元素。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
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(); }
返回
FooterSection
- 已移除的元素。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
使用常规 表达式。
搜索模式作为字符串(而非 JavaScript 正则表达式对象)传递。 因此,您需要对模式中的所有反斜杠进行转义。
此方法使用 Google 的 RE2 常规 表达式库,限制了支持的语法。
所提供的正则表达式格式会与每个文本块独立进行匹配 当前元素中包含的某些内容。
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
参数
名称 | 类型 | 说明 |
---|---|---|
searchPattern | String | 要搜索的正则表达式模式 |
replacement | String | 要用作替换的文本 |
返回
Element
- 当前元素
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
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 | 元素的属性。 |
返回
FooterSection
- 当前元素。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
将内容设置为纯文本。
注意:现有内容会被清除。
参数
名称 | 类型 | 说明 |
---|---|---|
text | String | 新文本内容。 |
返回
FooterSection
- 当前元素。
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
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 in the active tab be superscript. var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); var text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
参数
名称 | 类型 | 说明 |
---|---|---|
textAlignment | TextAlignment | 要应用的文字对齐方式类型 |
返回
FooterSection
- 当前元素
授权
使用此方法的脚本需要获得以下一个或多个范围的授权:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents