Document Service
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
文档
此服务允许脚本创建、访问和修改 Google 文档文件。
// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID');
// Create and open a document.
doc = DocumentApp.create('Document Name');
类
属性
| 属性 | 类型 | 说明 |
BACKGROUND_COLOR | Enum | 元素(段落、表格等)或文档的背景颜色。 |
BOLD | Enum | 富文本的字体粗细设置。 |
BORDER_COLOR | Enum | 表格元素的边框颜色。 |
BORDER_WIDTH | Enum | 表格元素的边框宽度(以磅为单位)。 |
CODE | Enum | 公式元素的代码内容。 |
FONT_FAMILY | Enum | 富文本的字体系列设置。 |
FONT_SIZE | Enum | 富文本的字体大小设置(以磅为单位)。 |
FOREGROUND_COLOR | Enum | 富文本的前景色设置。 |
HEADING | Enum | 段落元素(例如 DocumentApp.ParagraphHeading.HEADING1)的标题类型。 |
HEIGHT | Enum | 图片元素的高度设置。 |
HORIZONTAL_ALIGNMENT | Enum | 段落元素(例如 DocumentApp.HorizontalAlignment.CENTER)的水平对齐方式。 |
INDENT_END | Enum | 段落元素的末尾缩进设置(以磅为单位)。 |
INDENT_FIRST_LINE | Enum | 段落元素的首行缩进设置(以磅为单位)。 |
INDENT_START | Enum | 段落元素的起始缩进设置(以点为单位)。 |
ITALIC | Enum | 富文本的字体样式设置。 |
GLYPH_TYPE | Enum | 列表项元素的字形类型。 |
LEFT_TO_RIGHT | Enum | 富文本的文字方向设置。 |
LINE_SPACING | Enum | 段落元素的行间距设置(以倍数表示)。 |
LINK_URL | Enum | 富文本的链接网址。 |
LIST_ID | Enum | 对于列表项元素,是包含列表的 ID。 |
MARGIN_BOTTOM | Enum | 段落元素的下边距设置(以磅为单位)。 |
MARGIN_LEFT | Enum | 段落元素的左边距设置(以磅为单位)。 |
MARGIN_RIGHT | Enum | 段落元素的右边距设置(以磅为单位)。 |
MARGIN_TOP | Enum | 段落元素的上边距设置(以磅为单位)。 |
NESTING_LEVEL | Enum | 列表项元素的项嵌套级别。 |
MINIMUM_HEIGHT | Enum | 表格行元素的最小高度设置(以磅为单位)。 |
PADDING_BOTTOM | Enum | 表格单元格元素的底部内边距设置(以点为单位)。 |
PADDING_LEFT | Enum | 表格单元格元素的左内边距设置(以磅为单位)。 |
PADDING_RIGHT | Enum | 表格单元格元素的右内边距设置(以磅为单位)。 |
PADDING_TOP | Enum | 表格单元格元素的顶部内边距设置(以磅为单位)。 |
PAGE_HEIGHT | Enum | 文档的页面高度设置(以磅为单位)。 |
PAGE_WIDTH | Enum | 文档的页面宽度设置(以磅为单位)。 |
SPACING_AFTER | Enum | 段落元素的底部间距设置(以磅为单位)。 |
SPACING_BEFORE | Enum | 段落元素的顶部间距设置(以磅为单位)。 |
STRIKETHROUGH | Enum | 富文本的删除线设置。 |
UNDERLINE | Enum | 富文本的下划线设置。 |
VERTICAL_ALIGNMENT | Enum | 表格单元格元素的垂直对齐设置。 |
WIDTH | Enum | 宽度设置,适用于表格单元格和图片元素。 |
方法
| 方法 | 返回类型 | 简介 |
appendHorizontalRule() | HorizontalRule | 创建并附加新的 HorizontalRule。 |
appendImage(image) | InlineImage | 根据指定的图片 blob 创建并附加新的 InlineImage。 |
appendImage(image) | InlineImage | 附加给定的 InlineImage。 |
appendListItem(listItem) | ListItem | 附加给定的 ListItem。 |
appendListItem(text) | ListItem | 创建并附加包含指定文本内容的新 ListItem。 |
appendPageBreak() | PageBreak | 创建并附加新的 PageBreak。 |
appendPageBreak(pageBreak) | PageBreak | 附加给定的 PageBreak。 |
appendParagraph(paragraph) | Paragraph | 附加给定的 Paragraph。 |
appendParagraph(text) | Paragraph | 创建并附加包含指定文本内容的新 Paragraph。 |
appendTable() | Table | 创建并附加新的 Table。 |
appendTable(cells) | Table | 附加一个新 Table,其中包含每个指定字符串值的 TableCell。 |
appendTable(table) | Table | 附加给定的 Table。 |
clear() | Body | 清除元素的内容。 |
copy() | Body | 返回当前元素的已分离深层副本。 |
editAsText() | Text | 获取当前元素的 Text 版本以进行修改。 |
findElement(elementType) | RangeElement|null | 在元素的内容中搜索指定类型的后代。 |
findElement(elementType, from) | RangeElement|null | 从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。 |
findText(searchPattern) | RangeElement|null | 使用正则表达式在元素的内容中搜索指定的文本模式。 |
findText(searchPattern, from) | RangeElement|null | 从给定的搜索结果开始,在元素的内容中搜索指定的文本模式。 |
getAttributes() | Object | 检索元素的属性。 |
getChild(childIndex) | Element | 检索指定子索引处的子元素。 |
getChildIndex(child) | Integer | 检索指定子元素的子级索引。 |
getHeadingAttributes(paragraphHeading) | Object | 检索所提供 ParagraphHeading 的属性集。 |
getImages() | InlineImage[]|null | 检索相应部分中包含的所有 InlineImages。 |
getListItems() | ListItem[]|null | 检索相应部分中包含的所有 ListItems。 |
getMarginBottom() | Number|null | 检索下边距(以磅为单位)。 |
getMarginLeft() | Number|null | 检索左边距(以磅为单位)。 |
getMarginRight() | Number|null | 检索右边距。 |
getMarginTop() | Number|null | 检索上边距。 |
getNumChildren() | Integer | 检索子项的数量。 |
getPageHeight() | Number|null | 检索页面高度(以磅为单位)。 |
getPageWidth() | Number|null | 检索页面宽度(以点为单位)。 |
getParagraphs() | Paragraph[]|null | 检索部分中包含的所有 Paragraphs(包括 ListItems)。 |
getParent() | ContainerElement|null | 检索元素的父元素。 |
getTables() | Table[]|null | 检索相应部分中包含的所有 Tables。 |
getText() | String | 以文本字符串形式检索元素的内容。 |
getTextAlignment() | TextAlignment|null | 获取文本对齐方式。 |
getType() | ElementType | 检索元素的 ElementType。 |
insertHorizontalRule(childIndex) | HorizontalRule | 在指定索引处创建并插入新的 HorizontalRule。 |
insertImage(childIndex, image) | InlineImage | 在指定索引处,根据指定的图片 blob 创建并插入 InlineImage。 |
insertImage(childIndex, image) | InlineImage | 在指定索引处插入给定的 InlineImage。 |
insertListItem(childIndex, listItem) | ListItem | 在指定索引处插入给定的 ListItem。 |
insertListItem(childIndex, text) | ListItem | 在指定索引处创建并插入新的 ListItem,其中包含指定的文本内容。 |
insertPageBreak(childIndex) | PageBreak | 在指定索引处创建并插入新的 PageBreak。 |
insertPageBreak(childIndex, pageBreak) | PageBreak | 在指定索引处插入给定的 PageBreak。 |
insertParagraph(childIndex, paragraph) | Paragraph | 在指定索引处插入给定的 Paragraph。 |
insertParagraph(childIndex, text) | Paragraph | 在指定索引处创建并插入新的 Paragraph,其中包含指定的文本内容。 |
insertTable(childIndex) | Table | 在指定索引处创建并插入新的 Table。 |
insertTable(childIndex, cells) | Table | 在指定索引处创建并插入包含指定单元格的新 Table。 |
insertTable(childIndex, table) | Table | 在指定索引处插入给定的 Table。 |
removeChild(child) | Body | 移除指定的子元素。 |
replaceText(searchPattern, replacement) | Element | 使用正则表达式将指定文本模式的所有匹配项替换为指定的替换字符串。 |
setAttributes(attributes) | Body | 设置元素的属性。 |
setHeadingAttributes(paragraphHeading, attributes) | Body | 为提供的 ParagraphHeading 设置属性。 |
setMarginBottom(marginBottom) | Body | 设置下边距(以磅为单位)。 |
setMarginLeft(marginLeft) | Body | 设置左边距(以磅为单位)。 |
setMarginRight(marginRight) | Body | 设置右边距(以磅为单位)。 |
setMarginTop(marginTop) | Body | 设置上边距。 |
setPageHeight(pageHeight) | Body | 设置页面高度(以磅为单位)。 |
setPageWidth(pageWidth) | Body | 设置页面宽度(以磅为单位)。 |
setText(text) | Body | 将内容设置为纯文本。 |
setTextAlignment(textAlignment) | Body | 设置文本对齐方式。 |
方法
| 方法 | 返回类型 | 简介 |
appendHorizontalRule() | HorizontalRule | 创建并附加新的 HorizontalRule。 |
appendImage(image) | InlineImage | 根据指定的图片 blob 创建并附加新的 InlineImage。 |
appendImage(image) | InlineImage | 附加给定的 InlineImage。 |
appendListItem(listItem) | ListItem | 附加给定的 ListItem。 |
appendListItem(text) | ListItem | 创建并附加包含指定文本内容的新 ListItem。 |
appendParagraph(paragraph) | Paragraph | 附加给定的 Paragraph。 |
appendParagraph(text) | Paragraph | 创建并附加包含指定文本内容的新 Paragraph。 |
appendTable() | Table | 创建并附加新的 Table。 |
appendTable(cells) | Table | 附加一个新 Table,其中包含每个指定字符串值的 TableCell。 |
appendTable(table) | Table | 附加给定的 Table。 |
clear() | FooterSection | 清除元素的内容。 |
copy() | FooterSection | 返回当前元素的已分离深层副本。 |
editAsText() | Text | 获取当前元素的 Text 版本以进行修改。 |
findElement(elementType) | RangeElement|null | 在元素的内容中搜索指定类型的后代。 |
findElement(elementType, from) | RangeElement|null | 从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。 |
findText(searchPattern) | RangeElement|null | 使用正则表达式在元素的内容中搜索指定的文本模式。 |
findText(searchPattern, from) | RangeElement|null | 从给定的搜索结果开始,在元素的内容中搜索指定的文本模式。 |
getAttributes() | Object | 检索元素的属性。 |
getChild(childIndex) | Element | 检索指定子索引处的子元素。 |
getChildIndex(child) | Integer | 检索指定子元素的子级索引。 |
getImages() | InlineImage[]|null | 检索相应部分中包含的所有 InlineImages。 |
getListItems() | ListItem[]|null | 检索相应部分中包含的所有 ListItems。 |
getNumChildren() | Integer | 检索子项的数量。 |
getParagraphs() | Paragraph[]|null | 检索部分中包含的所有 Paragraphs(包括 ListItems)。 |
getParent() | ContainerElement|null | 检索元素的父元素。 |
getTables() | Table[]|null | 检索相应部分中包含的所有 Tables。 |
getText() | String | 以文本字符串形式检索元素的内容。 |
getTextAlignment() | TextAlignment|null | 获取文本对齐方式。 |
getType() | ElementType | 检索元素的 ElementType。 |
insertHorizontalRule(childIndex) | HorizontalRule | 在指定索引处创建并插入新的 HorizontalRule。 |
insertImage(childIndex, image) | InlineImage | 在指定索引处,根据指定的图片 blob 创建并插入 InlineImage。 |
insertImage(childIndex, image) | InlineImage | 在指定索引处插入给定的 InlineImage。 |
insertListItem(childIndex, listItem) | ListItem | 在指定索引处插入给定的 ListItem。 |
insertListItem(childIndex, text) | ListItem | 在指定索引处创建并插入新的 ListItem,其中包含指定的文本内容。 |
insertParagraph(childIndex, paragraph) | Paragraph | 在指定索引处插入给定的 Paragraph。 |
insertParagraph(childIndex, text) | Paragraph | 在指定索引处创建并插入新的 Paragraph,其中包含指定的文本内容。 |
insertTable(childIndex) | Table | 在指定索引处创建并插入新的 Table。 |
insertTable(childIndex, cells) | Table | 在指定索引处创建并插入包含指定单元格的新 Table。 |
insertTable(childIndex, table) | Table | 在指定索引处插入给定的 Table。 |
removeChild(child) | FooterSection | 移除指定的子元素。 |
removeFromParent() | FooterSection|null | 从其父级中移除元素。 |
replaceText(searchPattern, replacement) | Element | 使用正则表达式将指定文本模式的所有匹配项替换为指定的替换字符串。 |
setAttributes(attributes) | FooterSection | 设置元素的属性。 |
setText(text) | FooterSection | 将内容设置为纯文本。 |
setTextAlignment(textAlignment) | FooterSection | 设置文本对齐方式。 |
属性
| 属性 | 类型 | 说明 |
BULLET | Enum | 默认项目符号,圆形且已填充。 |
HOLLOW_BULLET | Enum | 空心项目符号。 |
SQUARE_BULLET | Enum | 方形项目符号。 |
NUMBER | Enum | 基于数字的项目符号。 |
LATIN_UPPER | Enum | 拉丁大写字母项目符号。 |
LATIN_LOWER | Enum | 拉丁小写项目符号。 |
ROMAN_UPPER | Enum | 罗马数字,大写项目符号。 |
ROMAN_LOWER | Enum | 罗马数字,小写项目符号。 |
方法
| 方法 | 返回类型 | 简介 |
appendHorizontalRule() | HorizontalRule | 创建并附加新的 HorizontalRule。 |
appendImage(image) | InlineImage | 根据指定的图片 blob 创建并附加新的 InlineImage。 |
appendImage(image) | InlineImage | 附加给定的 InlineImage。 |
appendListItem(listItem) | ListItem | 附加给定的 ListItem。 |
appendListItem(text) | ListItem | 创建并附加包含指定文本内容的新 ListItem。 |
appendParagraph(paragraph) | Paragraph | 附加给定的 Paragraph。 |
appendParagraph(text) | Paragraph | 创建并附加包含指定文本内容的新 Paragraph。 |
appendTable() | Table | 创建并附加新的 Table。 |
appendTable(cells) | Table | 附加一个新 Table,其中包含每个指定字符串值的 TableCell。 |
appendTable(table) | Table | 附加给定的 Table。 |
clear() | HeaderSection | 清除元素的内容。 |
copy() | HeaderSection | 返回当前元素的已分离深层副本。 |
editAsText() | Text | 获取当前元素的 Text 版本以进行修改。 |
findElement(elementType) | RangeElement|null | 在元素的内容中搜索指定类型的后代。 |
findElement(elementType, from) | RangeElement|null | 从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。 |
findText(searchPattern) | RangeElement|null | 使用正则表达式在元素的内容中搜索指定的文本模式。 |
findText(searchPattern, from) | RangeElement|null | 从给定的搜索结果开始,在元素的内容中搜索指定的文本模式。 |
getAttributes() | Object | 检索元素的属性。 |
getChild(childIndex) | Element | 检索指定子索引处的子元素。 |
getChildIndex(child) | Integer | 检索指定子元素的子级索引。 |
getImages() | InlineImage[]|null | 检索相应部分中包含的所有 InlineImages。 |
getListItems() | ListItem[]|null | 检索相应部分中包含的所有 ListItems。 |
getNumChildren() | Integer | 检索子项的数量。 |
getParagraphs() | Paragraph[]|null | 检索部分中包含的所有 Paragraphs(包括 ListItems)。 |
getParent() | ContainerElement|null | 检索元素的父元素。 |
getTables() | Table[]|null | 检索相应部分中包含的所有 Tables。 |
getText() | String | 以文本字符串形式检索元素的内容。 |
getTextAlignment() | TextAlignment|null | 获取文本对齐方式。 |
getType() | ElementType | 检索元素的 ElementType。 |
insertHorizontalRule(childIndex) | HorizontalRule | 在指定索引处创建并插入新的 HorizontalRule。 |
insertImage(childIndex, image) | InlineImage | 在指定索引处,根据指定的图片 blob 创建并插入 InlineImage。 |
insertImage(childIndex, image) | InlineImage | 在指定索引处插入给定的 InlineImage。 |
insertListItem(childIndex, listItem) | ListItem | 在指定索引处插入给定的 ListItem。 |
insertListItem(childIndex, text) | ListItem | 在指定索引处创建并插入新的 ListItem,其中包含指定的文本内容。 |
insertParagraph(childIndex, paragraph) | Paragraph | 在指定索引处插入给定的 Paragraph。 |
insertParagraph(childIndex, text) | Paragraph | 在指定索引处创建并插入新的 Paragraph,其中包含指定的文本内容。 |
insertTable(childIndex) | Table | 在指定索引处创建并插入新的 Table。 |
insertTable(childIndex, cells) | Table | 在指定索引处创建并插入包含指定单元格的新 Table。 |
insertTable(childIndex, table) | Table | 在指定索引处插入给定的 Table。 |
removeChild(child) | HeaderSection | 移除指定的子元素。 |
removeFromParent() | HeaderSection|null | 从其父级中移除元素。 |
replaceText(searchPattern, replacement) | Element | 使用正则表达式将指定文本模式的所有匹配项替换为指定的替换字符串。 |
setAttributes(attributes) | HeaderSection | 设置元素的属性。 |
setText(text) | HeaderSection | 将内容设置为纯文本。 |
setTextAlignment(textAlignment) | HeaderSection | 设置文本对齐方式。 |
属性
| 属性 | 类型 | 说明 |
LEFT | Enum | 左对齐选项。 |
CENTER | Enum | 居中对齐选项。 |
RIGHT | Enum | 右对齐选项。 |
JUSTIFY | Enum | 两端对齐选项。 |
属性
| 属性 | 类型 | 说明 |
NORMAL | Enum | 普通文本的标题选项。 |
HEADING1 | Enum | 最高标题选项。 |
HEADING2 | Enum | 第二个标题选项。 |
HEADING3 | Enum | 第三个标题选项 |
HEADING4 | Enum | 第四个标题选项。 |
HEADING5 | Enum | 第五个标题选项。 |
HEADING6 | Enum | 最低标题选项。 |
TITLE | Enum | 标题标题选项。 |
SUBTITLE | Enum | 副标题标题选项。 |
属性
| 属性 | 类型 | 说明 |
ABOVE_TEXT | Enum | 图片位于文字上方。 |
BREAK_BOTH | Enum | 图片会使左侧和右侧的文字断开。 |
BREAK_LEFT | Enum | 图片会打断左侧的文字。 |
BREAK_RIGHT | Enum | 图片会打断右侧的文字。 |
WRAP_TEXT | Enum | 图片被文字环绕。 |
方法
| 方法 | 返回类型 | 简介 |
appendHorizontalRule() | HorizontalRule | 创建并附加新的 HorizontalRule。 |
appendImage(image) | InlineImage | 根据指定的图片 blob 创建并附加新的 InlineImage。 |
appendImage(image) | InlineImage | 附加给定的 InlineImage。 |
appendListItem(listItem) | ListItem | 附加给定的 ListItem。 |
appendListItem(text) | ListItem | 创建并附加新的 ListItem。 |
appendParagraph(paragraph) | Paragraph | 附加给定的 Paragraph。 |
appendParagraph(text) | Paragraph | 创建并附加新的 Paragraph。 |
appendTable() | Table | 创建并附加新的 Table。 |
appendTable(cells) | Table | 附加一个包含指定单元格的新 Table。 |
appendTable(table) | Table | 附加给定的 Table。 |
clear() | TableCell | 清除元素的内容。 |
copy() | TableCell | 返回当前元素的已分离深层副本。 |
editAsText() | Text | 获取当前元素的 Text 版本以进行修改。 |
findElement(elementType) | RangeElement|null | 在元素的内容中搜索指定类型的后代。 |
findElement(elementType, from) | RangeElement|null | 从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。 |
findText(searchPattern) | RangeElement|null | 使用正则表达式在元素的内容中搜索指定的文本模式。 |
findText(searchPattern, from) | RangeElement|null | 从给定的搜索结果开始,在元素的内容中搜索指定的文本模式。 |
getAttributes() | Object | 检索元素的属性。 |
getBackgroundColor() | String|null | 检索背景颜色。 |
getChild(childIndex) | Element | 检索指定子索引处的子元素。 |
getChildIndex(child) | Integer | 检索指定子元素的子级索引。 |
getColSpan() | Integer | 检索列跨度,即此单元格跨越的表格单元格列数。 |
getLinkUrl() | String|null | 检索链接网址。 |
getNextSibling() | Element|null | 检索元素的下一个同级元素。 |
getNumChildren() | Integer | 检索子项的数量。 |
getPaddingBottom() | Number|null | 检索底部内边距(以点为单位)。 |
getPaddingLeft() | Number|null | 检索左侧内边距(以点为单位)。 |
getPaddingRight() | Number|null | 检索右侧内边距(以点为单位)。 |
getPaddingTop() | Number|null | 检索顶部内边距(以点为单位)。 |
getParent() | ContainerElement|null | 检索元素的父元素。 |
getParentRow() | TableRow|null | 检索包含当前 TableCell 的 TableRow。 |
getParentTable() | Table|null | 检索包含当前 TableCell 的 Table。 |
getPreviousSibling() | Element|null | 检索元素的前一个同级元素。 |
getRowSpan() | Integer | 检索行跨度,即此单元格跨越的表格单元格的行数。 |
getText() | String | 以文本字符串形式检索元素的内容。 |
getTextAlignment() | TextAlignment|null | 获取文本对齐方式。 |
getType() | ElementType | 检索元素的 ElementType。 |
getVerticalAlignment() | VerticalAlignment|null | 检索 VerticalAlignment。 |
getWidth() | Number|null | 检索包含相应单元格的列的宽度(以磅为单位)。 |
insertHorizontalRule(childIndex) | HorizontalRule | 在指定索引处创建并插入新的 HorizontalRule。 |
insertImage(childIndex, image) | InlineImage | 在指定索引处,根据指定的图片 blob 创建并插入 InlineImage。 |
insertImage(childIndex, image) | InlineImage | 在指定索引处插入给定的 InlineImage。 |
insertListItem(childIndex, listItem) | ListItem | 在指定索引处插入给定的 ListItem。 |
insertListItem(childIndex, text) | ListItem | 在指定索引处创建并插入新的 ListItem。 |
insertParagraph(childIndex, paragraph) | Paragraph | 在指定索引处插入给定的 Paragraph。 |
insertParagraph(childIndex, text) | Paragraph | 在指定索引处创建并插入新的 Paragraph。 |
insertTable(childIndex) | Table | 在指定索引处创建并插入新的 Table。 |
insertTable(childIndex, cells) | Table | 在指定索引处创建并插入包含指定单元格的新 Table。 |
insertTable(childIndex, table) | Table | 在指定索引处插入给定的 Table。 |
isAtDocumentEnd() | Boolean | 确定元素是否位于 Document 的末尾。 |
merge() | TableCell|null | 将元素与同一类型的前一个同级元素合并。 |
removeChild(child) | TableCell | 移除指定的子元素。 |
removeFromParent() | TableCell|null | 从其父级中移除元素。 |
replaceText(searchPattern, replacement) | Element | 使用正则表达式将指定文本模式的所有匹配项替换为指定的替换字符串。 |
setAttributes(attributes) | TableCell | 设置元素的属性。 |
setBackgroundColor(color) | TableCell | 设置背景颜色。 |
setLinkUrl(url) | TableCell | 设置链接网址。 |
setPaddingBottom(paddingBottom) | TableCell | 设置底部内边距(以点为单位)。 |
setPaddingLeft(paddingLeft) | TableCell | 设置左侧内边距(以点为单位)。 |
setPaddingRight(paddingRight) | TableCell | 设置右侧内边距(以点为单位)。 |
setPaddingTop(paddingTop) | TableCell | 设置顶部内边距(以点为单位)。 |
setText(text) | TableCell | 将内容设置为纯文本。 |
setTextAlignment(textAlignment) | TableCell | 设置文本对齐方式。 |
setVerticalAlignment(alignment) | TableCell | 设置垂直对齐方式。 |
setWidth(width) | TableCell | 设置包含当前单元格的列的宽度(以磅为单位)。 |
方法
| 方法 | 返回类型 | 简介 |
appendText(text) | Text | 将指定文本添加到此文本区域的末尾。 |
copy() | Text | 返回当前元素的已分离深层副本。 |
deleteText(startOffset, endOffsetInclusive) | Text | 删除一段文字。 |
editAsText() | Text | 获取当前元素的 Text 版本以进行修改。 |
findText(searchPattern) | RangeElement|null | 使用正则表达式在元素的内容中搜索指定的文本模式。 |
findText(searchPattern, from) | RangeElement|null | 从给定的搜索结果开始,在元素的内容中搜索指定的文本模式。 |
getAttributes() | Object | 检索元素的属性。 |
getAttributes(offset) | Object | 检索指定字符偏移量处的属性。 |
getBackgroundColor() | String|null | 检索背景颜色设置。 |
getBackgroundColor(offset) | String|null | 检索指定字符偏移处的背景颜色。 |
getFontFamily() | String|null | 检索字体系列设置。 |
getFontFamily(offset) | String|null | 检索指定字符偏移处的字体系列。 |
getFontSize() | Number|null | 检索字体大小设置。 |
getFontSize(offset) | Number|null | 检索指定字符偏移处的字体大小。 |
getForegroundColor() | String|null | 检索前景色设置。 |
getForegroundColor(offset) | String|null | 检索指定字符偏移量处的前景色。 |
getLinkUrl() | String|null | 检索链接网址。 |
getLinkUrl(offset) | String|null | 检索指定字符偏移量处的链接网址。 |
getNextSibling() | Element|null | 检索元素的下一个同级元素。 |
getParent() | ContainerElement|null | 检索元素的父元素。 |
getPreviousSibling() | Element|null | 检索元素的前一个同级元素。 |
getText() | String | 以文本字符串形式检索元素的内容。 |
getTextAlignment() | TextAlignment|null | 获取文本对齐方式。 |
getTextAlignment(offset) | TextAlignment|null | 获取单个字符的文字对齐方式。 |
getTextAttributeIndices() | Integer[] | 检索与不同文本格式设置运行的开头对应的一组文本索引。 |
getType() | ElementType | 检索元素的 ElementType。 |
insertText(offset, text) | Text | 在给定的字符偏移量处插入指定文本。 |
isAtDocumentEnd() | Boolean | 确定元素是否位于 Document 的末尾。 |
isBold() | Boolean|null | 检索粗体设置。 |
isBold(offset) | Boolean|null | 检索指定字符偏移量处的粗体设置。 |
isItalic() | Boolean|null | 检索斜体设置。 |
isItalic(offset) | Boolean|null | 检索指定字符偏移量处的斜体设置。 |
isStrikethrough() | Boolean|null | 检索删除线设置。 |
isStrikethrough(offset) | Boolean|null | 检索指定字符偏移量处的删除线设置。 |
isUnderline() | Boolean|null | 检索下划线设置。 |
isUnderline(offset) | Boolean|null | 检索指定字符偏移量处的下划线设置。 |
merge() | Text|null | 将元素与同一类型的前一个同级元素合并。 |
removeFromParent() | Text|null | 从其父级中移除元素。 |
replaceText(searchPattern, replacement) | Element | 使用正则表达式将指定文本模式的所有匹配项替换为指定的替换字符串。 |
setAttributes(startOffset, endOffsetInclusive, attributes) | Text | 将指定属性应用于给定的字符范围。 |
setAttributes(attributes) | Text | 设置元素的属性。 |
setBackgroundColor(startOffset, endOffsetInclusive, color) | Text | 为指定字符范围设置背景颜色。 |
setBackgroundColor(color) | Text | 设置背景颜色。 |
setBold(bold) | Text | 设置粗体设置。 |
setBold(startOffset, endOffsetInclusive, bold) | Text | 为指定字符范围设置粗体格式。 |
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName) | Text | 为指定字符范围设置字体系列。 |
setFontFamily(fontFamilyName) | Text | 设置字体系列。 |
setFontSize(startOffset, endOffsetInclusive, size) | Text | 为指定字符范围设置字体大小。 |
setFontSize(size) | Text | 设置字体大小。 |
setForegroundColor(startOffset, endOffsetInclusive, color) | Text | 为指定的字符范围设置前景色。 |
setForegroundColor(color) | Text | 设置前景色。 |
setItalic(italic) | Text | 设置斜体设置。 |
setItalic(startOffset, endOffsetInclusive, italic) | Text | 为指定字符范围设置斜体格式。 |
setLinkUrl(startOffset, endOffsetInclusive, url) | Text | 为指定字符范围设置链接网址。 |
setLinkUrl(url) | Text | 设置链接网址。 |
setStrikethrough(strikethrough) | Text | 设置删除线设置。 |
setStrikethrough(startOffset, endOffsetInclusive, strikethrough) | Text | 为指定字符范围设置删除线。 |
setText(text) | Text | 设置文本内容。 |
setTextAlignment(startOffset, endOffsetInclusive, textAlignment) | Text | 为指定字符范围设置文字对齐方式。 |
setTextAlignment(textAlignment) | Text | 设置文本对齐方式。 |
setUnderline(underline) | Text | 设置下划线设置。 |
setUnderline(startOffset, endOffsetInclusive, underline) | Text | 为指定字符范围设置下划线。 |
属性
| 属性 | 类型 | 说明 |
NORMAL | Enum | 常规文本对齐方式。 |
SUPERSCRIPT | Enum | 上标文字的对齐方式。 |
SUBSCRIPT | Enum | 下标文本对齐方式。 |
属性
| 属性 | 类型 | 说明 |
BOTTOM | Enum | 底部对齐选项。 |
CENTER | Enum | 居中对齐选项。 |
TOP | Enum | 顶部对齐选项。 |
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-12-11。
[null,null,["最后更新时间 (UTC):2025-12-11。"],[],["`DocumentApp` allows managing Google Docs through scripts, enabling the creation (`create`) and opening (`openById`) of documents. Key actions include adding elements like `HorizontalRule`, `InlineImage`, `ListItem`, `Paragraph`, and `Table` using `Body` methods such as `append` and `insert`. Other actions are: retrieving elements, attributes, managing text (setting, replacing), and controlling document layout (margins, size, alignment). The service facilitates managing bookmarks, access permissions, and user interface interactions. Enumerations define document attributes, element types, and formatting styles.\n"]]