此服务允许脚本创建、访问和修改 Google 文档文件。
// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID');
// Create and open a document.
doc = DocumentApp.create('Document Name');
类
名称 | 简介 |
---|---|
Attribute | 元素属性的枚举。 |
Body | Google 文档文档中标签页的内容。 |
Bookmark | 一个表示书签的对象。 |
ContainerElement | 可能包含其他元素的通用元素。 |
Date | 一个元素,表示设置了格式的日期 |
Document | 一个文档,包含一个或多个 Tab 对象,每个对象都包含富文本和
(如表格和列表)。 |
DocumentApp | 文档服务会创建并打开可修改的 Documents 。 |
DocumentTab | 一个文档标签页,包含富文本和各种元素(例如表格和列表)。 |
Element | 通用元素。 |
ElementType | 所有元素类型的枚举。 |
Equation | 表示数学表达式的元素。 |
EquationFunction | 一个元素,表示数学 Equation 中的函数。 |
EquationFunctionArgumentSeparator | 数学 Equation 中表示函数分隔符的元素。 |
EquationSymbol | 一个表示数学 Equation 中符号的元素。 |
| 受支持字体的枚举。 |
FooterSection | 表示页脚部分的元素。 |
Footnote | 表示脚注的元素。 |
FootnoteSection | 表示脚注部分的元素。 |
GlyphType | 支持的字形类型的枚举。 |
HeaderSection | 表示标头部分的元素。 |
HorizontalAlignment | 支持的水平对齐类型的枚举。 |
HorizontalRule | 表示水平规则的元素。 |
InlineDrawing | 表示嵌入绘图的元素。 |
InlineImage | 表示嵌入图片的元素。 |
ListItem | 表示列表项的元素。 |
NamedRange | 具有名称和 ID 以便稍后检索的 Range 。 |
PageBreak | 表示分页符的元素。 |
Paragraph | 表示段落的元素。 |
ParagraphHeading | 标准段落标题的枚举。 |
Person | 表示指向某个人的链接的元素。 |
Position | 对文档标签页中某个位置的引用(相对于特定元素)。 |
PositionedImage | 将图片锚定到 Paragraph 的固定位置。 |
PositionedLayout | 一个枚举,用于指定如何相对于周围内容布置 PositionedImage
文本。 |
Range | 文档中的一系列元素。 |
RangeBuilder | 用于根据文档元素构建 Range 对象的构建器。 |
RangeElement | Element 的封装容器,具有可能的起始偏移量和结束偏移量。 |
RichLink | 表示指向 Google 资源(例如云端硬盘文件或 YouTube 视频)的链接的元素。 |
Tab | Google 文档文档中的标签页。 |
TabType | 所有标签页类型的枚举。 |
Table | 表示表格的元素。 |
TableCell | 表示表格单元格的元素。 |
TableOfContents | 包含目录的元素。 |
TableRow | 表示表格行的元素。 |
Text | 表示富文本区域的元素。 |
TextAlignment | 文本对齐类型的枚举。 |
UnsupportedElement | 表示未知或无法受脚本影响的区域的元素,例如 页码。 |
VerticalAlignment | 支持的垂直对齐类型的枚举。 |
Attribute
属性
属性 | 类型 | 说明 |
---|---|---|
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 | 表格单元格和图片元素的宽度设置。 |
Body
方法
Bookmark
方法
方法 | 返回类型 | 简介 |
---|---|---|
getId() | String | 获取 Bookmark 的 ID。 |
getPosition() | Position | 获取 DocumentTab 中 Bookmark 的 Position 。 |
remove() | void | 删除 Bookmark 。 |
ContainerElement
方法
Date
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | Date | 返回当前元素的分离的深层副本。 |
getAttributes() | Object | 检索元素的属性。 |
getDisplayText() | String | 返回文档中呈现的显示值。 |
getLocale() | String | 返回显示值所使用的日期语言区域。 |
getNextSibling() | Element | 检索该元素的下一个同级元素。 |
getParent() | ContainerElement | 获取该元素的父元素。 |
getPreviousSibling() | Element | 检索该元素的前一个同级元素。 |
getTimestamp() | Date | 返回与日期关联的时间戳。 |
getType() | ElementType | 检索元素的 ElementType 。 |
isAtDocumentEnd() | Boolean | 确定元素是否在 Document 的末尾。 |
merge() | Date | 将元素与前一个相同类型的同级元素合并。 |
removeFromParent() | Date | 将元素从其父元素中移除。 |
setAttributes(attributes) | Date | 设置元素的属性。 |
Document
Document 类中直接访问和修改文本内容的方法会在活动标签页(在绑定到特定文档的脚本中)或第一个标签页(如果活动标签页不可用)上运行。可以更新依赖这些方法的脚本(例如 Document.getBody()
),使标签页支持下列任一方法:
- 使用第一个标签页:
Document.getTabs()[0].asDocumentTab().getBody()
- 使用所有标签页:使用
Document.getTabs()
和Tab.getChildTabs()
遍历标签页树。针对树中的每个标签页,调用Tab.asDocumentTab().getBody()
- 使用所选标签页:
Document.getTabs()[Document.getActiveTab().getId()].asDocumentTab().getBody()
- 注意:如果脚本未使用
Document.setActiveTab(tabId)
设置活跃标签页,则会抛出错误 - 使用特定标签页:
Document.getTab(TAB_ID).asDocumentTab().getBody()
如需详细了解标签页功能,请参阅使用标签页。
方法
DocumentApp
属性
属性 | 类型 | 说明 |
---|---|---|
Attribute | Attribute | Attribute 枚举。 |
ElementType | ElementType | ElementType 枚举。 |
FontFamily |
| 枚举。 |
GlyphType | GlyphType | GlyphType 枚举。 |
HorizontalAlignment | HorizontalAlignment | HorizontalAlignment 枚举。 |
ParagraphHeading | ParagraphHeading | ParagraphHeading 枚举。 |
PositionedLayout | PositionedLayout | PositionedLayout 枚举。 |
TextAlignment | TextAlignment | TextAlignment 枚举。 |
VerticalAlignment | VerticalAlignment | VerticalAlignment 枚举。 |
方法
方法 | 返回类型 | 简介 |
---|---|---|
create(name) | Document | 创建并返回新文档。 |
getActiveDocument() | Document | 返回脚本与容器绑定的文档。 |
getUi() | Ui | 返回文档界面环境的实例,允许脚本添加 菜单、对话框和边栏等功能。 |
openById(id) | Document | 返回具有指定 ID 的文档。 |
openByUrl(url) | Document | 使用指定网址打开并返回文档。 |
DocumentTab
方法
方法 | 返回类型 | 简介 |
---|---|---|
addBookmark(position) | Bookmark | 在指定的 Position 添加 Bookmark 。 |
addFooter() | FooterSection | 添加标签页页脚部分(如果不存在)。 |
addHeader() | HeaderSection | 添加标签页标题部分(如果不存在)。 |
addNamedRange(name, range) | NamedRange | 添加了 NamedRange ,这是具有要使用的名称和 ID 的 Range
以便稍后检索 |
getBody() | Body | 检索标签页的 Body 。 |
getBookmark(id) | Bookmark | 获取具有指定 ID 的 Bookmark 。 |
getBookmarks() | Bookmark[] | 获取标签页中的所有 Bookmark 对象。 |
getFooter() | FooterSection | 检索标签页的页脚部分(如果存在)。 |
getFootnotes() | Footnote[] | 检索标签页正文中的所有 Footnote 元素。 |
getHeader() | HeaderSection | 检索标签页的标题部分(如果存在)。 |
getNamedRangeById(id) | NamedRange | 获取具有指定 ID 的 NamedRange 。 |
getNamedRanges() | NamedRange[] | 获取标签页中的所有 NamedRange 对象。 |
getNamedRanges(name) | NamedRange[] | 获取标签页中具有指定名称的所有 NamedRange 对象。 |
newPosition(element, offset) | Position | 创建一个新的 Position ,这是相对于标签页中某个位置的引用。
特定元素。 |
newRange() | RangeBuilder | 创建一个用于根据标签页元素构建 Range 对象的构建器。 |
Element
方法
ElementType
属性
属性 | 类型 | 说明 |
---|---|---|
BODY_SECTION | Enum | 与 Body 元素对应的类型。 |
COMMENT_SECTION | Enum | 与 元素对应的类型。 |
DATE | Enum | 与 Date 对应的类型。
元素。 |
EQUATION | Enum | 与 Equation 元素对应的类型。 |
EQUATION_FUNCTION | Enum | 与 EquationFunction 元素对应的类型。 |
EQUATION_FUNCTION_ARGUMENT_SEPARATOR | Enum | 与 EquationFunctionArgumentSeparator 对应的类型。
元素。 |
EQUATION_SYMBOL | Enum | 与 EquationSymbol 元素对应的类型。 |
RICH_LINK | Enum | 与 RichLink 元素对应的类型。 |
FOOTER_SECTION | Enum | 与 FooterSection 元素对应的类型。 |
FOOTNOTE | Enum | 与 Footnote 元素对应的类型。 |
FOOTNOTE_SECTION | Enum | 与 FootnoteSection 元素对应的类型。 |
HEADER_SECTION | Enum | 与 HeaderSection 元素对应的类型。 |
HORIZONTAL_RULE | Enum | 与 HorizontalRule 元素对应的类型。 |
INLINE_DRAWING | Enum | 与 InlineDrawing 元素对应的类型。 |
INLINE_IMAGE | Enum | 与 InlineImage 元素对应的类型。 |
LIST_ITEM | Enum | 与 ListItem 元素对应的类型。 |
PAGE_BREAK | Enum | 与 PageBreak 元素对应的类型。 |
PARAGRAPH | Enum | 与 Paragraph 元素对应的类型。 |
PERSON | Enum | 与 Person 元素对应的类型。 |
TABLE | Enum | 与 Table 元素对应的类型。 |
TABLE_CELL | Enum | 与 TableCell 元素对应的类型。 |
TABLE_OF_CONTENTS | Enum | 与 TableOfContents 元素对应的类型。 |
TABLE_ROW | Enum | 与 TableRow 元素对应的类型。 |
TEXT | Enum | 与 Text 对应的类型。
元素。 |
UNSUPPORTED | Enum | 与 UnsupportedElement 对应的类型。 |
Equation
方法
EquationFunction
方法
EquationFunctionArgumentSeparator
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | EquationFunctionArgumentSeparator | 返回当前元素的分离的深层副本。 |
getAttributes() | Object | 检索元素的属性。 |
getNextSibling() | Element | 检索该元素的下一个同级元素。 |
getParent() | ContainerElement | 获取该元素的父元素。 |
getPreviousSibling() | Element | 检索该元素的前一个同级元素。 |
getType() | ElementType | 检索元素的 ElementType 。 |
isAtDocumentEnd() | Boolean | 确定元素是否在 Document 的末尾。 |
merge() | EquationFunctionArgumentSeparator | 将元素与前一个相同类型的同级元素合并。 |
removeFromParent() | EquationFunctionArgumentSeparator | 将元素从其父元素中移除。 |
setAttributes(attributes) | EquationFunctionArgumentSeparator | 设置元素的属性。 |
EquationSymbol
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | EquationSymbol | 返回当前元素的分离的深层副本。 |
getAttributes() | Object | 检索元素的属性。 |
getCode() | String | 检索与等式符号对应的代码。 |
getNextSibling() | Element | 检索该元素的下一个同级元素。 |
getParent() | ContainerElement | 获取该元素的父元素。 |
getPreviousSibling() | Element | 检索该元素的前一个同级元素。 |
getType() | ElementType | 检索元素的 ElementType 。 |
isAtDocumentEnd() | Boolean | 确定元素是否在 Document 的末尾。 |
merge() | EquationSymbol | 将元素与前一个相同类型的同级元素合并。 |
removeFromParent() | EquationSymbol | 将元素从其父元素中移除。 |
setAttributes(attributes) | EquationSymbol | 设置元素的属性。 |
FontFamily
FooterSection
方法
Footnote
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | Footnote | 返回当前元素的分离的深层副本。 |
getAttributes() | Object | 检索元素的属性。 |
getFootnoteContents() | FootnoteSection | 检索脚注元素的内容。 |
getNextSibling() | Element | 检索该元素的下一个同级元素。 |
getParent() | ContainerElement | 获取该元素的父元素。 |
getPreviousSibling() | Element | 检索该元素的前一个同级元素。 |
getType() | ElementType | 检索元素的 ElementType 。 |
isAtDocumentEnd() | Boolean | 确定元素是否在 Document 的末尾。 |
removeFromParent() | Footnote | 将元素从其父元素中移除。 |
setAttributes(attributes) | Footnote | 设置元素的属性。 |
FootnoteSection
方法
GlyphType
属性
属性 | 类型 | 说明 |
---|---|---|
BULLET | Enum | 默认项目符号,采用圆形,填充样式。 |
HOLLOW_BULLET | Enum | 空心项目符号。 |
SQUARE_BULLET | Enum | 一个方块项目符号。 |
NUMBER | Enum | 基于数字的项目符号。 |
LATIN_UPPER | Enum | 一个大写拉丁字母项目符号。 |
LATIN_LOWER | Enum | 一个小写拉丁字母项目符号。 |
ROMAN_UPPER | Enum | 大写的罗马数字项目符号。 |
ROMAN_LOWER | Enum | 罗马数字小写项目符号。 |
HeaderSection
方法
HorizontalAlignment
属性
属性 | 类型 | 说明 |
---|---|---|
LEFT | Enum | 左对齐选项。 |
CENTER | Enum | 居中对齐选项。 |
RIGHT | Enum | 右对齐选项。 |
JUSTIFY | Enum | 两端对齐选项。 |
HorizontalRule
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | HorizontalRule | 返回当前元素的分离的深层副本。 |
getAttributes() | Object | 检索元素的属性。 |
getNextSibling() | Element | 检索该元素的下一个同级元素。 |
getParent() | ContainerElement | 获取该元素的父元素。 |
getPreviousSibling() | Element | 检索该元素的前一个同级元素。 |
getType() | ElementType | 检索元素的 ElementType 。 |
isAtDocumentEnd() | Boolean | 确定元素是否在 Document 的末尾。 |
removeFromParent() | HorizontalRule | 将元素从其父元素中移除。 |
setAttributes(attributes) | HorizontalRule | 设置元素的属性。 |
InlineDrawing
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | InlineDrawing | 返回当前元素的分离的深层副本。 |
getAltDescription() | String | 返回绘图的替代说明。 |
getAltTitle() | String | 返回绘图的备用标题。 |
getAttributes() | Object | 检索元素的属性。 |
getNextSibling() | Element | 检索该元素的下一个同级元素。 |
getParent() | ContainerElement | 获取该元素的父元素。 |
getPreviousSibling() | Element | 检索该元素的前一个同级元素。 |
getType() | ElementType | 检索元素的 ElementType 。 |
isAtDocumentEnd() | Boolean | 确定元素是否在 Document 的末尾。 |
merge() | InlineDrawing | 将元素与前一个相同类型的同级元素合并。 |
removeFromParent() | InlineDrawing | 将元素从其父元素中移除。 |
setAltDescription(description) | InlineDrawing | 设置绘图的替代说明。 |
setAltTitle(title) | InlineDrawing | 设置绘图的替代标题。 |
setAttributes(attributes) | InlineDrawing | 设置元素的属性。 |
InlineImage
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | InlineImage | 返回当前元素的分离的深层副本。 |
getAltDescription() | String | 返回图片的替代说明。 |
getAltTitle() | String | 返回图片的替代标题。 |
getAs(contentType) | Blob | 将此对象中的数据作为转换为指定内容类型的 blob 返回。 |
getAttributes() | Object | 检索元素的属性。 |
getBlob() | Blob | 将此对象中的数据作为 blob 返回。 |
getHeight() | Integer | 检索图片的高度(以像素为单位)。 |
getLinkUrl() | String | 检索链接网址。 |
getNextSibling() | Element | 检索该元素的下一个同级元素。 |
getParent() | ContainerElement | 获取该元素的父元素。 |
getPreviousSibling() | Element | 检索该元素的前一个同级元素。 |
getType() | ElementType | 检索元素的 ElementType 。 |
getWidth() | Integer | 检索图片的宽度(以像素为单位)。 |
isAtDocumentEnd() | Boolean | 确定元素是否在 Document 的末尾。 |
merge() | InlineImage | 将元素与前一个相同类型的同级元素合并。 |
removeFromParent() | InlineImage | 将元素从其父元素中移除。 |
setAltDescription(description) | InlineImage | 设置图片的替代说明。 |
setAltTitle(title) | InlineImage | 设置图片的替代标题。 |
setAttributes(attributes) | InlineImage | 设置元素的属性。 |
setHeight(height) | InlineImage | 设置图片的高度(以像素为单位)。 |
setLinkUrl(url) | InlineImage | 设置链接网址。 |
setWidth(width) | InlineImage | 设置图片的宽度(以像素为单位)。 |
ListItem
方法
NamedRange
方法
方法 | 返回类型 | 简介 |
---|---|---|
getId() | String | 获取此 NamedRange 的 ID。 |
getName() | String | 获取此 NamedRange 的名称。 |
getRange() | Range | 获取与此 NamedRange 关联的元素范围。 |
remove() | void | 从标签页中移除此 NamedRange 。 |
PageBreak
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | PageBreak | 返回当前元素的分离的深层副本。 |
getAttributes() | Object | 检索元素的属性。 |
getNextSibling() | Element | 检索该元素的下一个同级元素。 |
getParent() | ContainerElement | 获取该元素的父元素。 |
getPreviousSibling() | Element | 检索该元素的前一个同级元素。 |
getType() | ElementType | 检索元素的 ElementType 。 |
isAtDocumentEnd() | Boolean | 确定元素是否在 Document 的末尾。 |
removeFromParent() | PageBreak | 将元素从其父元素中移除。 |
setAttributes(attributes) | PageBreak | 设置元素的属性。 |
Paragraph
方法
ParagraphHeading
属性
属性 | 类型 | 说明 |
---|---|---|
NORMAL | Enum | 普通文本的标题选项。 |
HEADING1 | Enum | 最高标题选项。 |
HEADING2 | Enum | 第二个标题选项。 |
HEADING3 | Enum | 第三个标题选项 |
HEADING4 | Enum | 第四个标题选项。 |
HEADING5 | Enum | 第五个标题选项。 |
HEADING6 | Enum | 最低标题选项。 |
TITLE | Enum | 标题选项。 |
SUBTITLE | Enum | 副标题标题选项。 |
Person
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | Person | 返回当前元素的分离的深层副本。 |
getAttributes() | Object | 检索元素的属性。 |
getEmail() | String | 返回用户的电子邮件地址。 |
getName() | String | 返回此人的显示名称(如果已设置)。 |
getNextSibling() | Element | 检索该元素的下一个同级元素。 |
getParent() | ContainerElement | 获取该元素的父元素。 |
getPreviousSibling() | Element | 检索该元素的前一个同级元素。 |
getType() | ElementType | 检索元素的 ElementType 。 |
isAtDocumentEnd() | Boolean | 确定元素是否在 Document 的末尾。 |
merge() | Person | 将元素与前一个相同类型的同级元素合并。 |
removeFromParent() | Person | 将元素从其父元素中移除。 |
setAttributes(attributes) | Person | 设置元素的属性。 |
Position
方法
方法 | 返回类型 | 简介 |
---|---|---|
getElement() | Element | 获取包含此 Position 的元素。 |
getOffset() | Integer | 获取此 Position 在包含它的元素中的相对位置。 |
getSurroundingText() | Text | 创建一个人造 Text 元素,用于表示
包含 Position 的 Paragraph 或 ListItem (直接或通过子元素链)。 |
getSurroundingTextOffset() | Integer | 获取此 Position 在 getSurroundingText() 返回的 Text 元素中的偏移量。 |
insertBookmark() | Bookmark | 在此 Position 处创建并插入新的 Bookmark 。 |
insertInlineImage(image) | InlineImage | 基于指定图片在此 Position 处创建并插入新的 InlineImage
blob。 |
insertText(text) | Text | 在此 Position 处插入指定的文本。 |
PositionedImage
方法
方法 | 返回类型 | 简介 |
---|---|---|
getAs(contentType) | Blob | 将此对象中的数据作为转换为指定内容类型的 blob 返回。 |
getBlob() | Blob | 将此对象中的数据作为 blob 返回。 |
getHeight() | Integer | 检索图片的高度(以像素为单位)。 |
getId() | String | 获取图片的 ID。 |
getLayout() | PositionedLayout | 获取表示图片布局方式的枚举值。 |
getLeftOffset() | Number | 获取图片相对于段落左侧的偏移量(以点为单位)。 |
getParagraph() | Paragraph | 获取图片锚定到的 Paragraph 。 |
getTopOffset() | Number | 获取图片相对于段落顶部的偏移量(以点为单位)。 |
getWidth() | Integer | 检索图片的宽度(以像素为单位)。 |
setHeight(height) | PositionedImage | 设置图片的高度(以像素为单位)。 |
setLayout(layout) | PositionedImage | 设置图片布局的定义。 |
setLeftOffset(offset) | PositionedImage | 设置图片相对于段落左侧的偏移量(以点为单位)。 |
setTopOffset(offset) | PositionedImage | 设置图片相对于段落顶部的偏移量(以点为单位)。 |
setWidth(width) | PositionedImage | 设置图片的宽度(以像素为单位)。 |
PositionedLayout
属性
属性 | 类型 | 说明 |
---|---|---|
ABOVE_TEXT | Enum | 图片位于文本上方。 |
BREAK_BOTH | Enum | 图片破坏了左侧和右侧的文本。 |
BREAK_LEFT | Enum | 图片会破坏左侧的文本。 |
BREAK_RIGHT | Enum | 图片破坏了右侧的文本。 |
WRAP_TEXT | Enum | 图片被文字环绕。 |
Range
方法
方法 | 返回类型 | 简介 |
---|---|---|
getRangeElements() | RangeElement[] | 获取此 Range 中的所有元素,包括任何部分 Text 元素(例如,
(选择仅包含部分 Text 元素)。 |
RangeBuilder
方法
方法 | 返回类型 | 简介 |
---|---|---|
addElement(element) | RangeBuilder | 向此 RangeBuilder 添加整个 Element 。 |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | 将部分 Text 元素添加到此 RangeBuilder 。 |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | 将两个整个元素及其之间的所有元素添加到此 RangeBuilder 。 |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | 将两个部分 Text 元素以及它们之间的所有元素添加到 RangeBuilder 。 |
addRange(range) | RangeBuilder | 将另一个 Range 的内容添加到此 RangeBuilder 。 |
build() | Range | 根据应用于构建器的设置构造 Range 。 |
getRangeElements() | RangeElement[] | 获取此 Range 中的所有元素,包括任何部分 Text 元素(例如,
(选择仅包含部分 Text 元素)。 |
RangeElement
方法
方法 | 返回类型 | 简介 |
---|---|---|
getElement() | Element | 获取与此 RangeElement 对应的 Element 。 |
getEndOffsetInclusive() | Integer | 获取范围元素内部分范围的结束位置。 |
getStartOffset() | Integer | 获取范围元素中部分范围的起始位置。 |
isPartial() | Boolean | 确定此范围元素是涵盖整个元素还是涵盖 元素的字符。 |
RichLink
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | RichLink | 返回当前元素的分离的深层副本。 |
getAttributes() | Object | 检索元素的属性。 |
getMimeType() | String | 返回 MIME 类型
链接(如果内容是指向云端硬盘文件的链接,并且null
否则。 |
getNextSibling() | Element | 检索该元素的下一个同级元素。 |
getParent() | ContainerElement | 获取该元素的父元素。 |
getPreviousSibling() | Element | 检索该元素的前一个同级元素。 |
getTitle() | String | 返回链接的显示标题。 |
getType() | ElementType | 检索元素的 ElementType 。 |
getUrl() | String | 返回资源的网址。 |
isAtDocumentEnd() | Boolean | 确定元素是否在 Document 的末尾。 |
merge() | RichLink | 将元素与前一个相同类型的同级元素合并。 |
removeFromParent() | RichLink | 将元素从其父元素中移除。 |
setAttributes(attributes) | RichLink | 设置元素的属性。 |
Tab
方法
方法 | 返回类型 | 简介 |
---|---|---|
asDocumentTab() | DocumentTab | 以 DocumentTab 的形式检索标签页内容。 |
getChildTabs() | Tab[] | 检索此标签页中嵌套的子标签页。 |
getId() | String | 检索标签页的 ID。 |
getIndex() | Integer | 检索父标签页内标签页的索引(从 0 开始)。 |
getTitle() | String | 检索标签页的标题。 |
getType() | TabType | 检索标签页的类型。 |
TabType
属性
属性 | 类型 | 说明 |
---|---|---|
DOCUMENT_TAB | Enum | 与 DocumentTab 对应的类型。 |
Table
方法
TableCell
方法
TableOfContents
方法
TableRow
方法
Text
方法
TextAlignment
属性
属性 | 类型 | 说明 |
---|---|---|
NORMAL | Enum | 正常的文字对齐方式。 |
SUPERSCRIPT | Enum | 上标文本对齐方式。 |
SUBSCRIPT | Enum | 下标文本对齐方式。 |
UnsupportedElement
方法
方法 | 返回类型 | 简介 |
---|---|---|
copy() | UnsupportedElement | 返回当前元素的分离的深层副本。 |
getAttributes() | Object | 检索元素的属性。 |
getNextSibling() | Element | 检索该元素的下一个同级元素。 |
getParent() | ContainerElement | 获取该元素的父元素。 |
getPreviousSibling() | Element | 检索该元素的前一个同级元素。 |
getType() | ElementType | 检索元素的 ElementType 。 |
isAtDocumentEnd() | Boolean | 确定元素是否在 Document 的末尾。 |
merge() | UnsupportedElement | 将元素与前一个相同类型的同级元素合并。 |
removeFromParent() | UnsupportedElement | 将元素从其父元素中移除。 |
setAttributes(attributes) | UnsupportedElement | 设置元素的属性。 |
VerticalAlignment
属性
属性 | 类型 | 说明 |
---|---|---|
BOTTOM | Enum | 底部对齐选项。 |
CENTER | Enum | 居中对齐选项。 |
TOP | Enum | 顶部对齐选项。 |