此页面由 Cloud Translation API 翻译。

Class ListItem

表示列表项的元素。ListItem 是与列表 ID 关联的 Paragraph。ListItem 可以包含 Equation、Footnote、HorizontalRule、InlineDrawing、InlineImage、PageBreak 和 Text 元素。如需详细了解文档结构，请参阅关于扩展 Google 文档的指南。

“ListItems”不得包含换行符。换行符 ("\n") 会转换为换行符 ("\r")。

具有相同列表 ID 的 ListItems 属于同一列表，并相应地进行编号。给定列表的 ListItems 无需在文档中相邻，甚至不必具有相同的父元素。属于同一列表的两个项可以存在于文档中的任何位置，同时保持连续编号，如以下示例所示：

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

// Append a new list item to the body.
var item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([
  ['Cell 1', 'Cell 2']
]);

// Append a second list item with the same list ID. The two items are treated as the same list,
// despite not being consecutive.
var item2 = body.appendListItem('Item 2');
item2.setListId(item1);

方法

方法	返回类型	简介
`addPositionedImage(image)`	`PositionedImage`	从指定的图片 Blob 创建并插入新的 `PositionedImage`。
`appendHorizontalRule()`	`HorizontalRule`	创建并附加新的 `HorizontalRule`。
`appendInlineImage(image)`	`InlineImage`	从指定的图片 Blob 创建并附加新的 `InlineImage`。
`appendInlineImage(image)`	`InlineImage`	附加指定的 `InlineImage`。
`appendPageBreak()`	`PageBreak`	创建并附加新的 `PageBreak`。
`appendPageBreak(pageBreak)`	`PageBreak`	附加指定的 `PageBreak`。
`appendText(text)`	`Text`	使用指定的内容创建并附加新的 `Text` 元素。
`appendText(text)`	`Text`	附加指定的 `Text` 元素。
`clear()`	`ListItem`	清除元素的内容。
`copy()`	`ListItem`	返回当前元素的已分离深层副本。
`editAsText()`	`Text`	获取当前元素的 `Text` 版本，以进行修改。
`findElement(elementType)`	`RangeElement`	在该元素的内容中搜索指定类型的后代。
`findElement(elementType, from)`	`RangeElement`	从指定的 `RangeElement` 开始，在元素的内容中搜索指定类型的后代。
`findText(searchPattern)`	`RangeElement`	使用正则表达式在元素的内容中搜索指定的文本模式。
`findText(searchPattern, from)`	`RangeElement`	从指定的搜索结果中开始搜索指定文本格式的元素内容。
`getAlignment()`	`HorizontalAlignment`	检索 `HorizontalAlignment`。
`getAttributes()`	`Object`	检索元素的属性。
`getChild(childIndex)`	`Element`	检索指定的子索引处的子元素。
`getChildIndex(child)`	`Integer`	检索指定子元素的子索引。
`getGlyphType()`	`GlyphType`	检索列表项的 `GlyphType`。
`getHeading()`	`ParagraphHeading`	检索 `ParagraphHeading`。
`getIndentEnd()`	`Number`	检索结束缩进（以点为单位）。
`getIndentFirstLine()`	`Number`	检索首行缩进（以点为单位）。
`getIndentStart()`	`Number`	检索起始缩进。
`getLineSpacing()`	`Number`	检索行间距（以点为单位）。
`getLinkUrl()`	`String`	检索链接网址。
`getListId()`	`String`	检索列表 ID。
`getNestingLevel()`	`Integer`	检索列表项的嵌套级别。
`getNextSibling()`	`Element`	检索该元素的下一个同级元素。
`getNumChildren()`	`Integer`	检索子项的数量。
`getParent()`	`ContainerElement`	检索元素的父元素。
`getPositionedImage(id)`	`PositionedImage`	根据图片的 ID 获取 `PositionedImage`。
`getPositionedImages()`	`PositionedImage[]`	获取锚定到段落中的所有 `PositionedImage` 对象。
`getPreviousSibling()`	`Element`	检索该元素的上一个同级元素。
`getSpacingAfter()`	`Number`	检索元素后的间距（以点为单位）。
`getSpacingBefore()`	`Number`	检索元素之前的间距（以点为单位）。
`getText()`	`String`	以文本字符串的形式检索元素的内容。
`getTextAlignment()`	`TextAlignment`	获取文本对齐方式。
`getType()`	`ElementType`	检索元素的 `ElementType`。
`insertHorizontalRule(childIndex)`	`HorizontalRule`	在指定索引处创建并插入 `HorizontalRule`。
`insertInlineImage(childIndex, image)`	`InlineImage`	从指定图片 Blob 的指定索引处创建并插入新的 `InlineImage`。
`insertInlineImage(childIndex, image)`	`InlineImage`	在指定索引处插入指定的 `InlineImage`。
`insertPageBreak(childIndex)`	`PageBreak`	在指定索引处创建并插入新的 `PageBreak`。
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	在指定索引处插入指定的 `PageBreak`。
`insertText(childIndex, text)`	`Text`	在指定索引处创建并插入新的文本元素。
`insertText(childIndex, text)`	`Text`	在指定索引处插入具有指定文本内容的给定 `Text` 元素。
`isAtDocumentEnd()`	`Boolean`	确定元素是否位于 `Document` 末尾。
`isLeftToRight()`	`Boolean`	用于检索从左到右的设置。
`merge()`	`ListItem`	将元素与前面具有相同类型的同级项合并。
`removeChild(child)`	`ListItem`	移除指定的子元素。
`removeFromParent()`	`ListItem`	从父元素中移除元素。
`removePositionedImage(id)`	`Boolean`	根据图片 ID 移除 `PositionedImage`。
`replaceText(searchPattern, replacement)`	`Element`	使用正则表达式替换给定文本模式中出现的所有字符。
`setAlignment(alignment)`	`ListItem`	设置 `HorizontalAlignment`。
`setAttributes(attributes)`	`ListItem`	设置元素的属性。
`setGlyphType(glyphType)`	`ListItem`	设置列表项的 `GlyphType`。
`setHeading(heading)`	`ListItem`	设置 `ParagraphHeading`。
`setIndentEnd(indentEnd)`	`ListItem`	设置结束缩进（以点为单位）。
`setIndentFirstLine(indentFirstLine)`	`ListItem`	设置首行缩进（以点为单位）。
`setIndentStart(indentStart)`	`ListItem`	设置开始缩进（以点为单位）。
`setLeftToRight(leftToRight)`	`ListItem`	设置从左至右的设置。
`setLineSpacing(multiplier)`	`ListItem`	将行间距设置为数量，用于指明间距的行数。
`setLinkUrl(url)`	`ListItem`	设置链接网址。
`setListId(listItem)`	`ListItem`	设置列表 ID。
`setNestingLevel(nestingLevel)`	`ListItem`	设置列表项的嵌套级别。
`setSpacingAfter(spacingAfter)`	`ListItem`	设置元素后的间距（以点为单位）。
`setSpacingBefore(spacingBefore)`	`ListItem`	设置元素之前的间距（以点为单位）。
`setText(text)`	`void`	将列表项的内容设置为文本。
`setTextAlignment(textAlignment)`	`ListItem`	设置文本对齐方式。

详细文档

`addPositionedImage(image)`

从指定的图片 Blob 创建并插入新的 PositionedImage。

参数

名称	类型	说明
`image`	`BlobSource`	图片数据

PositionedImage - 新定位的图片

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`appendHorizontalRule()`

创建并附加新的 HorizontalRule。

HorizontalRule - 新的水平规则

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`appendInlineImage(image)`

从指定的图片 Blob 创建并附加新的 InlineImage。

参数

名称	类型	说明
`image`	`BlobSource`	图片数据

InlineImage - 附加的图片

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`appendInlineImage(image)`

附加指定的 InlineImage。

参数

名称	类型	说明
`image`	`InlineImage`	图片数据

InlineImage - 附加的图片

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`appendPageBreak()`

创建并附加新的 PageBreak。

注意：TableCells 可能不包含 PageBreaks。如果表单元格中包含当前元素，则会抛出异常。

PageBreak - 新的分页符

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`appendPageBreak(pageBreak)`

附加指定的 PageBreak。

注意：TableCells 可能不包含 PageBreaks。如果表单元格中包含当前元素，则会抛出异常。

参数

名称	类型	说明
`pageBreak`	`PageBreak`	要附加的分页符

PageBreak - 附加的分页符

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`appendText(text)`

使用指定的内容创建并附加新的 Text 元素。

参数

名称	类型	说明
`text`	`String`	文字内容

Text - 新的文本元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`appendText(text)`

附加指定的 Text 元素。

参数

名称	类型	说明
`text`	`Text`	要附加的文本元素

Text - 附加的文本元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`clear()`

清除元素的内容。

ListItem - 当前元素

`copy()`

返回当前元素的已分离深层副本。

元素中的所有子元素也会被复制。新元素没有父元素。

ListItem - 新副本。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

在该元素的内容中搜索指定类型的后代。

参数

名称	类型	说明
`elementType`	`ElementType`	要搜索的元素的类型

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

参数

名称	类型	说明
`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

`getAlignment()`

检索 HorizontalAlignment。

HorizontalAlignment - 对齐方式

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

参数

名称	类型	说明
`childIndex`	`Integer`	要检索的子元素的索引

Element - 指定索引处的子元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getChildIndex(child)`

检索指定子元素的子索引。

参数

名称	类型	说明
`child`	`Element`	要为其检索索引的子元素

Integer - 子索引

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getGlyphType()`

检索列表项的 GlyphType。

GlyphType - 字形类型

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getHeading()`

检索 ParagraphHeading。

ParagraphHeading - 标题

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getIndentEnd()`

检索结束缩进（以点为单位）。

Number - 末尾缩进，以点为单位

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getIndentFirstLine()`

检索首行缩进（以点为单位）。

Number - 首行缩进（以点为单位）

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getIndentStart()`

检索起始缩进。

Number - 开头缩进

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getLineSpacing()`

检索行间距（以点为单位）。

Number - 行间距（以点为单位）

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getLinkUrl()`

检索链接网址。

String - 链接网址；如果元素包含此属性的多个值，则返回 null

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getListId()`

检索列表 ID。

String - 列表 ID

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getNestingLevel()`

检索列表项的嵌套级别。

默认情况下，列表项的嵌套级别为零。嵌套级别决定了列表项所使用的字形。

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

`getParent()`

检索元素的父元素。

父元素包含当前元素。

ContainerElement - 父元素。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getPositionedImage(id)`

根据图片的 ID 获取 PositionedImage。

参数

名称	类型	说明
`id`	`String`	图片 ID

PositionedImage - 定位的图片

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getPositionedImages()`

获取锚定到段落中的所有 PositionedImage 对象。

PositionedImage[] - 已定位图片的列表

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getSpacingAfter()`

检索元素后的间距（以点为单位）。

Number - 元素后面的间距（以点为单位）

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`getSpacingBefore()`

检索元素之前的间距（以点为单位）。

Number - 元素之前的间距（以点为单位）

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`insertHorizontalRule(childIndex)`

在指定索引处创建并插入 HorizontalRule。

参数

名称	类型	说明
`childIndex`	`Integer`	用于插入元素的索引

HorizontalRule - 新的水平规则元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`insertInlineImage(childIndex, image)`

从指定图片 Blob 的指定索引处创建并插入新的 InlineImage。

参数

名称	类型	说明
`childIndex`	`Integer`	用于插入元素的索引
`image`	`BlobSource`	图片数据

InlineImage - 插入的内嵌图片元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`insertInlineImage(childIndex, image)`

在指定索引处插入指定的 InlineImage。

参数

名称	类型	说明
`childIndex`	`Integer`	用于插入元素的索引
`image`	`InlineImage`	图片数据

InlineImage - 插入的内嵌图片元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`insertPageBreak(childIndex)`

在指定索引处创建并插入新的 PageBreak。

注意：TableCells 可能不包含 PageBreaks。如果表单元格中包含当前元素，则会抛出异常。

参数

名称	类型	说明
`childIndex`	`Integer`	用于插入元素的索引

PageBreak - 新的分页符

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`insertPageBreak(childIndex, pageBreak)`

在指定索引处插入指定的 PageBreak。

注意：TableCells 可能不包含 PageBreaks。如果表单元格中包含当前元素，则会抛出异常。

参数

名称	类型	说明
`childIndex`	`Integer`	用于插入元素的索引
`pageBreak`	`PageBreak`	要插入的分页符 [分页符]

PageBreak - 插入的分页符

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`insertText(childIndex, text)`

在指定索引处创建并插入新的文本元素。

参数

名称	类型	说明
`childIndex`	`Integer`	用于插入元素的索引
`text`	`String`	文字内容

Text - 新的文本元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`insertText(childIndex, text)`

在指定索引处插入具有指定文本内容的给定 Text 元素。

参数

名称	类型	说明
`childIndex`	`Integer`	用于插入元素的索引
`text`	`Text`	要插入的文本元素

Text - 插入的文本元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`isLeftToRight()`

用于检索从左到右的设置。

Boolean - 从左到右的设置

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`merge()`

将元素与前面的同类型的同级项合并。

只能合并同一 ElementType 的元素。当前元素中包含的任何子元素都会移至前面的同级元素。

当前元素会从文档中移除。

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

ListItem - 合并的元素。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`removeChild(child)`

移除指定的子元素。

参数

名称	类型	说明
`child`	`Element`	要移除的子元素

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

ListItem - 已移除的元素。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`removePositionedImage(id)`

根据图片 ID 移除 PositionedImage。

参数

名称	类型	说明
`id`	`String`

Boolean - 指定的图片是否被移除

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`replaceText(searchPattern, replacement)`

使用正则表达式替换给定文本模式中出现的所有字符。

搜索模式会作为字符串（而非 JavaScript 正则表达式对象）传递。因此，您需要对格式中的所有反斜杠进行转义。

此方法使用 Google 的 RE2 正则表达式库，该库限制了受支持的语法。

提供的正则表达式模式与当前元素中包含的每个文本块都独立匹配。

var body = DocumentApp.getActiveDocument().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

`setAlignment(alignment)`

设置 HorizontalAlignment。

参数

名称	类型	说明
`alignment`	`HorizontalAlignment`	水平对齐

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

参数

名称	类型	说明
`attributes`	`Object`	元素的属性。

ListItem - 当前元素。

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`setGlyphType(glyphType)`

设置列表项的 GlyphType。

参数

名称	类型	说明
`glyphType`	`GlyphType`	字形类型

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`setHeading(heading)`

设置 ParagraphHeading。

参数

名称	类型	说明
`heading`	`ParagraphHeading`	标题

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`setIndentEnd(indentEnd)`

设置结束缩进（以点为单位）。

参数

名称	类型	说明
`indentEnd`	`Number`	末尾缩进（以点为单位）

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`setIndentFirstLine(indentFirstLine)`

设置首行缩进（以点为单位）。

参数

名称	类型	说明
`indentFirstLine`	`Number`	首行缩进（以点为单位）

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`setIndentStart(indentStart)`

设置开始缩进（以点为单位）。

参数

名称	类型	说明
`indentStart`	`Number`	开始缩进（以点为单位）

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`setLeftToRight(leftToRight)`

设置从左至右的设置。

参数

名称	类型	说明
`leftToRight`	`Boolean`	从左到右的设置

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`setLineSpacing(multiplier)`

将行间距设置为数量，用于指明间距的行数。

参数

名称	类型	说明
`multiplier`	`Number`	行数

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`setLinkUrl(url)`

设置链接网址。

参数

名称	类型	说明
`url`	`String`	链接网址

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`setListId(listItem)`

设置列表 ID。

列表 ID 已设置为与指定的 ListItem 相同的值。这两个 ListItems 将被视为同一列表的成员。

参数

名称	类型	说明
`listItem`	`ListItem`	要使用其列表 ID 的列表项

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`setNestingLevel(nestingLevel)`

设置列表项的嵌套级别。

默认情况下，列表项的嵌套级别为零。嵌套级别决定了列表项所使用的字形。

参数

名称	类型	说明
`nestingLevel`	`Integer`	嵌套级别

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`setSpacingAfter(spacingAfter)`

设置元素后的间距（以点为单位）。

参数

名称	类型	说明
`spacingAfter`	`Number`	元素后面的间距（以点为单位）

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`setSpacingBefore(spacingBefore)`

设置元素之前的间距（以点为单位）。

参数

名称	类型	说明
`spacingBefore`	`Number`	元素之前的间距（以点为单位）

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

`setText(text)`

将列表项的内容设置为文本。

注意：系统会清除现有内容。

参数

名称	类型	说明
`text`	`String`	新的文字内容

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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

参数

名称	类型	说明
`textAlignment`	`TextAlignment`	要应用的文本对齐类型

ListItem - 当前元素

授权

使用此方法的脚本需要通过以下一个或多个范围进行授权：

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