此页面由 Cloud Translation API 翻译。

Class ListItem

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

ListItems 不得包含换行符。换行符（“\n”）会转换为换行符（“\r”）。

具有相同列表 ID 的 ListItems 属于同一列表，并相应地编号。给定列表的 ListItems 不必在标签页中相邻，甚至不必具有相同的父元素。属于同一列表的两个项可以出现在标签页中的任意位置，同时保持连续编号，如以下示例所示：

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a new list item to the body.
const 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.
const 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。

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

PageBreak - 新的分页符元素

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`appendPageBreak(pageBreak)`

附加给定的 PageBreak。

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

参数

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

完全包含在被删除文本范围内的子元素会从该元素中移除。

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 - 当前元素的文本版本

`findElement(elementType)`

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

参数

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

RangeElement - 搜索结果，用于指示搜索元素的位置。

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`findElement(elementType, from)`

从指定的 RangeElement 开始，在元素的内容中搜索指定类型的后代。

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

参数

名称	类型	说明
`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 枚举中的项。

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

`getChild(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.');
}

参数

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

检索子项的数量。

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

`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() 确定给定元素的确切类型。

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

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。

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

参数

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

PageBreak - 新的分页符元素

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`insertPageBreak(childIndex, pageBreak)`

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

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

参数

名称	类型	说明
`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 的元素才能合并。当前元素包含的所有子元素都会移至前面的同级元素。

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

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const 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.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const 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()`

从其父元素中移除元素。

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

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 正则表达式库，这会限制支持的语法。

系统会将提供的正则表达式模式与当前元素中包含的每个文本块进行单独匹配。

const 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

`setAlignment(alignment)`

设置 HorizontalAlignment。

参数

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

ListItem - 当前元素

授权

使用此方法的脚本需要获得以下一个或多个范围的授权：

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

`setAttributes(attributes)`

设置元素的属性。

指定的 attributes 参数必须是对象，其中每个属性名称都是 DocumentApp.Attribute 枚举中的项，每个属性值都是要应用的新值。

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`	元素的属性。

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 in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.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