Document Service

使用集合让一切井井有条 根据您的偏好保存内容并对其进行分类。
文档

此服务允许脚本创建、访问和修改 Google 文档文件。

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

// Create and open a document.
doc = DocumentApp.create('Document Name');

名称简介
Attribute元素属性的枚举。
Body表示文档正文的元素。
Bookmark表示书签的对象。
ContainerElement可能包含其他元素的通用元素。
Date表示格式化日期的元素
Document一种包含富文本和元素(例如表格和列表)的文档。
DocumentApp文档服务创建并打开可编辑的 Documents
Element一个通用元素。
ElementType所有元素类型的枚举。
Equation表示数学表达式的元素。
EquationFunction一个表示数学 Equation 中的函数的元素。
EquationFunctionArgumentSeparator一个表示数学 Equation 中的函数分隔符的元素。
EquationSymbol一个表示数学 Equation 中的符号的元素。
FontFamily受支持的字体的枚举。
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 对象的构建器。
RangeElementElement 的封装容器,包含可能的开始和结束偏移量。
RichLink表示指向 Google 资源(例如云端硬盘文件或 YouTube 视频)的链接的元素。
Table表示表的元素。
TableCell表示表单元格的元素。
TableOfContents包含目录的元素。
TableRow表示表行的元素。
Text表示富文本区域的元素。
TextAlignment一种文本对齐类型的枚举。
UnsupportedElement代表未知区域或不受脚本影响的区域的元素,例如页码。
VerticalAlignment支持的垂直对齐类型的枚举。

Attribute

属性

属性类型说明
BACKGROUND_COLOREnum元素(段落、表格等)或文档的背景颜色。
BOLDEnum字体粗细设置,适用于富文本。
BORDER_COLOREnum表格元素的边框颜色。
BORDER_WIDTHEnum表格元素的边框宽度(以点为单位)。
CODEEnum等式元素的代码内容。
FONT_FAMILYEnum字体系列设置,适用于富文本。
FONT_SIZEEnum富文本的字体大小设置(以点为单位)。
FOREGROUND_COLOREnum用于富文本的前景颜色设置。
HEADINGEnum适用于段落元素的标题类型(例如 DocumentApp.ParagraphHeading.HEADING1)。
HEIGHTEnum图片元素的高度设置。
HORIZONTAL_ALIGNMENTEnum段落元素(例如 DocumentApp.HorizontalAlignment.CENTER)的水平对齐方式。
INDENT_ENDEnum段落元素的缩进设置(以点为单位)。
INDENT_FIRST_LINEEnum段落元素的首行缩进设置(针对点)。
INDENT_STARTEnum段落元素的起始缩进设置(以点为单位)。
ITALICEnum富文本格式的字体样式设置。
GLYPH_TYPEEnum字形类型,适用于列表项元素。
LEFT_TO_RIGHTEnum文本方向设置,适用于富文本。
LINE_SPACINGEnum段落间距的行倍数设置。
LINK_URLEnum富文本的链接网址。
LIST_IDEnum所包含列表的 ID,用于列表项元素。
MARGIN_BOTTOMEnum段落元素的下外边距设置(以点为单位)。
MARGIN_LEFTEnum段落元素的左边距设置(以点为单位)。
MARGIN_RIGHTEnum段落元素的右边距设置(以点为单位)。
MARGIN_TOPEnum段落元素的上外边距设置(以点为单位)。
NESTING_LEVELEnum项目嵌套级别,适用于列表项元素。
MINIMUM_HEIGHTEnum表格行元素的最小高度设置(以点为单位)。
PADDING_BOTTOMEnum表格单元格元素的底部内边距设置(以点为单位)。
PADDING_LEFTEnum表格单元格元素的左内边距设置(以点为单位)。
PADDING_RIGHTEnum表格单元格元素的右内边距设置(以点为单位)。
PADDING_TOPEnum表格单元格元素的上内边距设置(以点为单位)。
PAGE_HEIGHTEnum文档的页面高度设置(以点为单位)。
PAGE_WIDTHEnum文档的宽度(以点为单位)。
SPACING_AFTEREnum段落元素底部间距设置(以点为单位)。
SPACING_BEFOREEnum段落元素的上间距设置(以点为单位)。
STRIKETHROUGHEnum删除线设置,适用于富文本。
UNDERLINEEnum下划线设置,适用于富文本。
VERTICAL_ALIGNMENTEnum表格单元格元素的垂直对齐设置。
WIDTHEnum表格单元格和图片元素的宽度设置。

Body

方法

方法返回类型简介
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为每个指定的字符串值附加一个包含 TableCell 的新 Table
appendTable(table)Table附加指定的 Table
clear()Body清除元素的内容。
copy()Body返回当前元素的已分离深层副本。
editAsText()Text获取当前元素的 Text 版本,以进行修改。
findElement(elementType)RangeElement在该元素的内容中搜索指定类型的后代。
findElement(elementType, from)RangeElement从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。
findText(searchPattern)RangeElement使用正则表达式在元素的内容中搜索指定的文本模式。
findText(searchPattern, from)RangeElement从指定的搜索结果中开始搜索指定文本格式的元素内容。
getAttributes()Object检索元素的属性。
getChild(childIndex)Element检索指定的子索引处的子元素。
getChildIndex(child)Integer检索指定子元素的子索引。
getHeadingAttributes(paragraphHeading)Object检索提供的 ParagraphHeading 的属性集。
getImages()InlineImage[]检索此部分中的所有 InlineImages
getListItems()ListItem[]检索此部分中的所有 ListItems
getMarginBottom()Number检索下边距,以点为单位。
getMarginLeft()Number检索左边距(以点为单位)。
getMarginRight()Number检索右边距。
getMarginTop()Number检索上外边距。
getNumChildren()Integer检索子项的数量。
getPageHeight()Number检索页面高度(以点为单位)。
getPageWidth()Number检索页面宽度(以点为单位)。
getParagraphs()Paragraph[]检索该部分包含的所有 Paragraphs(包括 ListItems)。
getParent()ContainerElement检索元素的父元素。
getTables()Table[]检索此部分中的所有 Tables
getText()String以文本字符串的形式检索元素的内容。
getTextAlignment()TextAlignment获取文本对齐方式。
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设置文本对齐方式。

Bookmark

方法

方法返回类型简介
getId()String获取 Bookmark 的 ID。
getPosition()Position获取 DocumentBookmarkPosition
remove()void删除 Bookmark

ContainerElement

方法

方法返回类型简介
asBody()BodyBody 的形式返回当前元素。
asEquation()EquationEquation 的形式返回当前元素。
asFooterSection()FooterSectionFooterSection 的形式返回当前元素。
asFootnoteSection()FootnoteSectionFootnoteSection 的形式返回当前元素。
asHeaderSection()HeaderSectionHeaderSection 的形式返回当前元素。
asListItem()ListItemListItem 的形式返回当前元素。
asParagraph()ParagraphParagraph 的形式返回当前元素。
asTable()TableTable 的形式返回当前元素。
asTableCell()TableCellTableCell 的形式返回当前元素。
asTableOfContents()TableOfContentsTableOfContents 的形式返回当前元素。
asTableRow()TableRowTableRow 的形式返回当前元素。
clear()ContainerElement清除元素的内容。
copy()ContainerElement返回当前元素的已分离深层副本。
editAsText()Text获取当前元素的 Text 版本,以进行修改。
findElement(elementType)RangeElement在该元素的内容中搜索指定类型的后代。
findElement(elementType, from)RangeElement从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。
findText(searchPattern)RangeElement使用正则表达式在元素的内容中搜索指定的文本模式。
findText(searchPattern, from)RangeElement从指定的搜索结果中开始搜索指定文本格式的元素内容。
getAttributes()Object检索元素的属性。
getChild(childIndex)Element检索指定的子索引处的子元素。
getChildIndex(child)Integer检索指定子元素的子索引。
getLinkUrl()String检索链接网址。
getNextSibling()Element检索该元素的下一个同级元素。
getNumChildren()Integer检索子项的数量。
getParent()ContainerElement检索元素的父元素。
getPreviousSibling()Element检索该元素的上一个同级元素。
getText()String以文本字符串的形式检索元素的内容。
getTextAlignment()TextAlignment获取文本对齐方式。
getType()ElementType检索元素的 ElementType
isAtDocumentEnd()Boolean确定元素是否位于 Document 末尾。
merge()ContainerElement将元素与前面具有相同类型的同级项合并。
removeFromParent()ContainerElement从父元素中移除元素。
replaceText(searchPattern, replacement)Element使用正则表达式替换给定文本模式中出现的所有字符。
setAttributes(attributes)ContainerElement设置元素的属性。
setLinkUrl(url)ContainerElement设置链接网址。
setTextAlignment(textAlignment)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

方法

方法返回类型简介
addBookmark(position)Bookmark在给定的 Position 上添加一个 Bookmark
addEditor(emailAddress)Document将指定用户添加到 Document 的编辑器列表中。
addEditor(user)Document将指定用户添加到 Document 的编辑器列表中。
addEditors(emailAddresses)Document将指定用户数组添加到 Document 的编辑器列表中。
addFooter()FooterSection添加文档页脚部分(如果不存在)。
addHeader()HeaderSection添加文档标头部分(如果不存在)。
addNamedRange(name, range)NamedRange添加了新的 NamedRange,即具有名称和 ID 以供日后检索的 Range
addViewer(emailAddress)Document将指定用户添加到 Document 的查看者列表中。
addViewer(user)Document将指定用户添加到 Document 的查看者列表中。
addViewers(emailAddresses)Document将指定用户数组添加到 Document 的查看者列表中。
getAs(contentType)Blob将指定的 Document 内容检索为指定类型的 blob。
getBlob()Blob以 blob 形式检索当前 Document 内容。
getBody()Body检索活跃文档的 Body
getBookmark(id)Bookmark获取具有指定 ID 的 Bookmark
getBookmarks()Bookmark[]获取文档中的所有 Bookmark 对象。
getCursor()Position获取有效文档中用户的光标。
getEditors()User[]获取此 Document 的编辑器列表。
getFooter()FooterSection检索文档的页脚部分(如果存在)。
getFootnotes()Footnote[]检索文档正文中的所有 Footnote 元素。
getHeader()HeaderSection检索文档的标题部分(如果存在)。
getId()String检索文档的唯一标识符。
getLanguage()String获取文档的语言代码。
getName()String检索文档的标题。
getNamedRangeById(id)NamedRange获取具有指定 ID 的 NamedRange
getNamedRanges()NamedRange[]获取文档中的所有 NamedRange 对象。
getNamedRanges(name)NamedRange[]获取给定名称中的所有文档中的 NamedRange 对象。
getSelection()Range获取用户在当前文档中所做的选择。
getSupportedLanguageCodes()String[]获取 Google 文档文件支持的所有语言代码。
getUrl()String检索网址以访问当前文档。
getViewers()User[]获取此 Document 的查看者和评论者列表。
newPosition(element, offset)Position创建新的 Position,这是相对于文档中特定位置的引用。
newRange()RangeBuilder创建用于根据文档元素构建 Range 对象的构建器。
removeEditor(emailAddress)DocumentDocument 的编辑器列表中移除指定用户。
removeEditor(user)DocumentDocument 的编辑器列表中移除指定用户。
removeViewer(emailAddress)DocumentDocument 的查看者和评论者列表中删除指定用户。
removeViewer(user)DocumentDocument 的查看者和评论者列表中删除指定用户。
saveAndClose()void保存当前的 Document
setCursor(position)Document在给定 Position 的情况下,在活动文档中设置用户的光标。
setLanguage(languageCode)Document设置文档的语言代码。
setName(name)Document设置文档标题。
setSelection(range)Document根据 Range,设置用户当前活跃文档中的选择。

DocumentApp

属性

属性类型说明
AttributeAttributeAttribute 枚举。
ElementTypeElementTypeElementType 枚举。
FontFamilyFontFamilyFontFamily 枚举。
GlyphTypeGlyphTypeGlyphType 枚举。
HorizontalAlignmentHorizontalAlignmentHorizontalAlignment 枚举。
ParagraphHeadingParagraphHeadingParagraphHeading 枚举。
PositionedLayoutPositionedLayoutPositionedLayout 枚举。
TextAlignmentTextAlignmentTextAlignment 枚举。
VerticalAlignmentVerticalAlignmentVerticalAlignment 枚举。

方法

方法返回类型简介
create(name)Document创建并返回一个新文档。
getActiveDocument()Document返回脚本容器绑定的目标文档。
getUi()Ui返回文档界面环境的实例,允许脚本添加菜单、对话框和边栏等功能。
openById(id)Document返回具有指定 ID 的文档。
openByUrl(url)Document打开并返回包含指定网址的文档。

Element

方法

方法返回类型简介
asBody()BodyBody 的形式返回当前元素。
asDate()DateDate 的形式返回当前元素。
asEquation()EquationEquation 的形式返回当前元素。
asEquationFunction()EquationFunctionEquationFunction 的形式返回当前元素。
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorEquationFunctionArgumentSeparator 的形式返回当前元素。
asEquationSymbol()EquationSymbolEquationSymbol 的形式返回当前元素。
asFooterSection()FooterSectionFooterSection 的形式返回当前元素。
asFootnote()FootnoteFootnote 的形式返回当前元素。
asFootnoteSection()FootnoteSectionFootnoteSection 的形式返回当前元素。
asHeaderSection()HeaderSectionHeaderSection 的形式返回当前元素。
asHorizontalRule()HorizontalRuleHorizontalRule 的形式返回当前元素。
asInlineDrawing()InlineDrawingInlineDrawing 的形式返回当前元素。
asInlineImage()InlineImageInlineImage 的形式返回当前元素。
asListItem()ListItemListItem 的形式返回当前元素。
asPageBreak()PageBreakPageBreak 的形式返回当前元素。
asParagraph()ParagraphParagraph 的形式返回当前元素。
asPerson()PersonPerson 的形式返回当前元素。
asRichLink()RichLinkRichLink 的形式返回当前元素,例如 Google 表格文件的链接。
asTable()TableTable 的形式返回当前元素。
asTableCell()TableCellTableCell 的形式返回当前元素。
asTableOfContents()TableOfContentsTableOfContents 的形式返回当前元素。
asTableRow()TableRowTableRow 的形式返回当前元素。
asText()TextText 的形式返回当前元素。
copy()Element返回当前元素的已分离深层副本。
getAttributes()Object检索元素的属性。
getNextSibling()Element检索该元素的下一个同级元素。
getParent()ContainerElement检索元素的父元素。
getPreviousSibling()Element检索该元素的上一个同级元素。
getType()ElementType检索元素的 ElementType
isAtDocumentEnd()Boolean确定元素是否位于 Document 末尾。
merge()Element将元素与前面具有相同类型的同级项合并。
removeFromParent()Element从父元素中移除元素。
setAttributes(attributes)Element设置元素的属性。

ElementType

属性

属性类型说明
BODY_SECTIONEnumBody 元素对应的类型。
COMMENT_SECTIONEnumCommentSection 元素对应的类型。
DATEEnumDate 元素对应的类型。
DOCUMENTEnum与文档根目录对应的类型。
EQUATIONEnumEquation 元素对应的类型。
EQUATION_FUNCTIONEnumEquationFunction 元素对应的类型。
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumEquationFunctionArgumentSeparator 元素对应的类型。
EQUATION_SYMBOLEnumEquationSymbol 元素对应的类型。
RICH_LINKEnumRichLink 元素对应的类型。
FOOTER_SECTIONEnumFooterSection 元素对应的类型。
FOOTNOTEEnumFootnote 元素对应的类型。
FOOTNOTE_SECTIONEnumFootnoteSection 元素对应的类型。
HEADER_SECTIONEnumHeaderSection 元素对应的类型。
HORIZONTAL_RULEEnumHorizontalRule 元素对应的类型。
INLINE_DRAWINGEnumInlineDrawing 元素对应的类型。
INLINE_IMAGEEnumInlineImage 元素对应的类型。
LIST_ITEMEnumListItem 元素对应的类型。
PAGE_BREAKEnumPageBreak 元素对应的类型。
PARAGRAPHEnumParagraph 元素对应的类型。
PERSONEnumPerson 元素对应的类型。
TABLEEnumTable 元素对应的类型。
TABLE_CELLEnumTableCell 元素对应的类型。
TABLE_OF_CONTENTSEnumTableOfContents 元素对应的类型。
TABLE_ROWEnumTableRow 元素对应的类型。
TEXTEnumText 元素对应的类型。
UNSUPPORTEDEnumUnsupportedElement 对应的类型。

Equation

方法

方法返回类型简介
clear()Equation清除元素的内容。
copy()Equation返回当前元素的已分离深层副本。
editAsText()Text获取当前元素的 Text 版本,以进行修改。
findElement(elementType)RangeElement在该元素的内容中搜索指定类型的后代。
findElement(elementType, from)RangeElement从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。
findText(searchPattern)RangeElement使用正则表达式在元素的内容中搜索指定的文本模式。
findText(searchPattern, from)RangeElement从指定的搜索结果中开始搜索指定文本格式的元素内容。
getAttributes()Object检索元素的属性。
getChild(childIndex)Element检索指定的子索引处的子元素。
getChildIndex(child)Integer检索指定子元素的子索引。
getLinkUrl()String检索链接网址。
getNextSibling()Element检索该元素的下一个同级元素。
getNumChildren()Integer检索子项的数量。
getParent()ContainerElement检索元素的父元素。
getPreviousSibling()Element检索该元素的上一个同级元素。
getText()String以文本字符串的形式检索元素的内容。
getTextAlignment()TextAlignment获取文本对齐方式。
getType()ElementType检索元素的 ElementType
isAtDocumentEnd()Boolean确定元素是否位于 Document 末尾。
merge()Equation将元素与前面具有相同类型的同级项合并。
removeFromParent()Equation从父元素中移除元素。
replaceText(searchPattern, replacement)Element使用正则表达式替换给定文本模式中出现的所有字符。
setAttributes(attributes)Equation设置元素的属性。
setLinkUrl(url)Equation设置链接网址。
setTextAlignment(textAlignment)Equation设置文本对齐方式。

EquationFunction

方法

方法返回类型简介
clear()EquationFunction清除元素的内容。
copy()EquationFunction返回当前元素的已分离深层副本。
editAsText()Text获取当前元素的 Text 版本,以进行修改。
findElement(elementType)RangeElement在该元素的内容中搜索指定类型的后代。
findElement(elementType, from)RangeElement从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。
findText(searchPattern)RangeElement使用正则表达式在元素的内容中搜索指定的文本模式。
findText(searchPattern, from)RangeElement从指定的搜索结果中开始搜索指定文本格式的元素内容。
getAttributes()Object检索元素的属性。
getChild(childIndex)Element检索指定的子索引处的子元素。
getChildIndex(child)Integer检索指定子元素的子索引。
getCode()String检索等式函数对应的代码。
getLinkUrl()String检索链接网址。
getNextSibling()Element检索该元素的下一个同级元素。
getNumChildren()Integer检索子项的数量。
getParent()ContainerElement检索元素的父元素。
getPreviousSibling()Element检索该元素的上一个同级元素。
getText()String以文本字符串的形式检索元素的内容。
getTextAlignment()TextAlignment获取文本对齐方式。
getType()ElementType检索元素的 ElementType
isAtDocumentEnd()Boolean确定元素是否位于 Document 末尾。
merge()EquationFunction将元素与前面具有相同类型的同级项合并。
removeFromParent()EquationFunction从父元素中移除元素。
replaceText(searchPattern, replacement)Element使用正则表达式替换给定文本模式中出现的所有字符。
setAttributes(attributes)EquationFunction设置元素的属性。
setLinkUrl(url)EquationFunction设置链接网址。
setTextAlignment(textAlignment)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

方法

方法返回类型简介
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为每个指定的字符串值附加一个包含 TableCell 的新 Table
appendTable(table)Table附加指定的 Table
clear()FooterSection清除元素的内容。
copy()FooterSection返回当前元素的已分离深层副本。
editAsText()Text获取当前元素的 Text 版本,以进行修改。
findElement(elementType)RangeElement在该元素的内容中搜索指定类型的后代。
findElement(elementType, from)RangeElement从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。
findText(searchPattern)RangeElement使用正则表达式在元素的内容中搜索指定的文本模式。
findText(searchPattern, from)RangeElement从指定的搜索结果中开始搜索指定文本格式的元素内容。
getAttributes()Object检索元素的属性。
getChild(childIndex)Element检索指定的子索引处的子元素。
getChildIndex(child)Integer检索指定子元素的子索引。
getImages()InlineImage[]检索此部分中的所有 InlineImages
getListItems()ListItem[]检索此部分中的所有 ListItems
getNumChildren()Integer检索子项的数量。
getParagraphs()Paragraph[]检索该部分包含的所有 Paragraphs(包括 ListItems)。
getParent()ContainerElement检索元素的父元素。
getTables()Table[]检索此部分中的所有 Tables
getText()String以文本字符串的形式检索元素的内容。
getTextAlignment()TextAlignment获取文本对齐方式。
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从父元素中移除元素。
replaceText(searchPattern, replacement)Element使用正则表达式替换给定文本模式中出现的所有字符。
setAttributes(attributes)FooterSection设置元素的属性。
setText(text)FooterSection将内容设置为纯文本。
setTextAlignment(textAlignment)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

方法

方法返回类型简介
appendParagraph(paragraph)Paragraph附加指定的 Paragraph
appendParagraph(text)Paragraph创建并附加包含指定文本内容的新 Paragraph
clear()FootnoteSection清除元素的内容。
copy()FootnoteSection返回当前元素的已分离深层副本。
editAsText()Text获取当前元素的 Text 版本,以进行修改。
findElement(elementType)RangeElement在该元素的内容中搜索指定类型的后代。
findElement(elementType, from)RangeElement从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。
findText(searchPattern)RangeElement使用正则表达式在元素的内容中搜索指定的文本模式。
findText(searchPattern, from)RangeElement从指定的搜索结果中开始搜索指定文本格式的元素内容。
getAttributes()Object检索元素的属性。
getChild(childIndex)Element检索指定的子索引处的子元素。
getChildIndex(child)Integer检索指定子元素的子索引。
getNextSibling()Element检索该元素的下一个同级元素。
getNumChildren()Integer检索子项的数量。
getParagraphs()Paragraph[]检索该部分包含的所有 Paragraphs(包括 ListItems)。
getParent()ContainerElement检索元素的父元素。
getPreviousSibling()Element检索该元素的上一个同级元素。
getText()String以文本字符串的形式检索元素的内容。
getTextAlignment()TextAlignment获取文本对齐方式。
getType()ElementType检索元素的 ElementType
insertParagraph(childIndex, paragraph)Paragraph在指定索引处插入指定的 Paragraph
insertParagraph(childIndex, text)Paragraph在指定索引处创建并插入包含指定文本内容的新 Paragraph
removeChild(child)FootnoteSection移除指定的子元素。
removeFromParent()FootnoteSection从父元素中移除元素。
replaceText(searchPattern, replacement)Element使用正则表达式替换给定文本模式中出现的所有字符。
setAttributes(attributes)FootnoteSection设置元素的属性。
setText(text)FootnoteSection将内容设置为纯文本。
setTextAlignment(textAlignment)FootnoteSection设置文本对齐方式。

GlyphType

属性

属性类型说明
BULLETEnum默认项目符号,圆形和填充。
HOLLOW_BULLETEnum空心项目符号。
SQUARE_BULLETEnum方形项目符号。
NUMBEREnum数字编号项目符号。
LATIN_UPPEREnum大写拉丁文项目符号。
LATIN_LOWEREnum小写拉丁项目符号。
ROMAN_UPPEREnum大写数字编号项目符号。
ROMAN_LOWEREnum小写罗马数字项目符号。

HeaderSection

方法

方法返回类型简介
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为每个指定的字符串值附加一个包含 TableCell 的新 Table
appendTable(table)Table附加指定的 Table
clear()HeaderSection清除元素的内容。
copy()HeaderSection返回当前元素的已分离深层副本。
editAsText()Text获取当前元素的 Text 版本,以进行修改。
findElement(elementType)RangeElement在该元素的内容中搜索指定类型的后代。
findElement(elementType, from)RangeElement从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。
findText(searchPattern)RangeElement使用正则表达式在元素的内容中搜索指定的文本模式。
findText(searchPattern, from)RangeElement从指定的搜索结果中开始搜索指定文本格式的元素内容。
getAttributes()Object检索元素的属性。
getChild(childIndex)Element检索指定的子索引处的子元素。
getChildIndex(child)Integer检索指定子元素的子索引。
getImages()InlineImage[]检索此部分中的所有 InlineImages
getListItems()ListItem[]检索此部分中的所有 ListItems
getNumChildren()Integer检索子项的数量。
getParagraphs()Paragraph[]检索该部分包含的所有 Paragraphs(包括 ListItems)。
getParent()ContainerElement检索元素的父元素。
getTables()Table[]检索此部分中的所有 Tables
getText()String以文本字符串的形式检索元素的内容。
getTextAlignment()TextAlignment获取文本对齐方式。
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从父元素中移除元素。
replaceText(searchPattern, replacement)Element使用正则表达式替换给定文本模式中出现的所有字符。
setAttributes(attributes)HeaderSection设置元素的属性。
setText(text)HeaderSection将内容设置为纯文本。
setTextAlignment(textAlignment)HeaderSection设置文本对齐方式。

HorizontalAlignment

属性

属性类型说明
LEFTEnum左对齐选项。
CENTEREnum居中对齐选项。
RIGHTEnum右对齐选项。
JUSTIFYEnumJustify-Alignment 选项。

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

方法

方法返回类型简介
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设置文本对齐方式。

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

方法

方法返回类型简介
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()Paragraph清除元素的内容。
copy()Paragraph返回当前元素的已分离深层副本。
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检索指定子元素的子索引。
getHeading()ParagraphHeading检索 ParagraphHeading
getIndentEnd()Number检索结束缩进(以点为单位)。
getIndentFirstLine()Number检索首行缩进(以点为单位)。
getIndentStart()Number检索起始缩进。
getLineSpacing()Number检索行间距(以点为单位)。
getLinkUrl()String检索链接网址。
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()Paragraph将元素与前面具有相同类型的同级项合并。
removeChild(child)Paragraph移除指定的子元素。
removeFromParent()Paragraph从父元素中移除元素。
removePositionedImage(id)Boolean根据图片 ID 移除 PositionedImage
replaceText(searchPattern, replacement)Element使用正则表达式替换给定文本模式中出现的所有字符。
setAlignment(alignment)Paragraph设置 HorizontalAlignment
setAttributes(attributes)Paragraph设置元素的属性。
setHeading(heading)Paragraph设置 ParagraphHeading
setIndentEnd(indentEnd)Paragraph设置结束缩进(以点为单位)。
setIndentFirstLine(indentFirstLine)Paragraph设置首行缩进(以点为单位)。
setIndentStart(indentStart)Paragraph设置开始缩进(以点为单位)。
setLeftToRight(leftToRight)Paragraph设置从左至右的设置。
setLineSpacing(multiplier)Paragraph将行间距设置为数量,用于指明间距的行数。
setLinkUrl(url)Paragraph设置链接网址。
setSpacingAfter(spacingAfter)Paragraph设置元素后的间距(以点为单位)。
setSpacingBefore(spacingBefore)Paragraph设置元素之前的间距(以点为单位)。
setText(text)void将段落内容设置为文本。
setTextAlignment(textAlignment)Paragraph设置文本对齐方式。

ParagraphHeading

属性

属性类型说明
NORMALEnum普通文本的标题选项。
HEADING1Enum最高的标题选项。
HEADING2Enum第二个标题选项。
HEADING3Enum第三个标题选项
HEADING4Enum第四个标题选项。
HEADING5Enum第五个标题选项。
HEADING6Enum最低的标题选项。
TITLEEnum标题选项。
SUBTITLEEnum副标题选项。

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 或通过链式子元素创建包含 PositionParagraphListItem 的文本和格式的人为 Text 元素。
getSurroundingTextOffset()Integer获取 getSurroundingText() 返回的 Text 元素中此 Position 的偏移量。
insertBookmark()Bookmark在这个 Position 上创建并插入一个新的 Bookmark
insertInlineImage(image)InlineImage从指定映像 blob 在这个 Position 上创建并插入新的 InlineImage
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_TEXTEnum图片位于文本上方。
BREAK_BOTHEnum图片会破坏左侧和右侧的文字。
BREAK_LEFTEnum图片会破坏左侧的文字。
BREAK_RIGHTEnum图片破坏了右侧的文字。
WRAP_TEXTEnum图片是用文字环绕的。

Range

方法

方法返回类型简介
getRangeElements()RangeElement[]获取此 Range 中的所有元素,包括任何部分 Text 元素(例如,如果所选范围仅包含 Text 元素的一部分)。

RangeBuilder

方法

方法返回类型简介
addElement(element)RangeBuilder将整个 Element 添加到此 RangeBuilder
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilder向此 RangeBuilder 添加部分 Text 元素。
addElementsBetween(startElement, endElementInclusive)RangeBuilder向此 RangeBuilder 添加两个完整元素以及它们之间的所有元素。
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderRangeBuilder 添加两个部分 Text 元素以及它们之间的所有元素。
addRange(range)RangeBuilder将另一个 Range 的内容添加到此 RangeBuilder
build()Range通过应用于构建器的设置构造 Range
getRangeElements()RangeElement[]获取此 Range 中的所有元素,包括任何部分 Text 元素(例如,如果所选范围仅包含 Text 元素的一部分)。

RangeElement

方法

方法返回类型简介
getElement()Element获取与此 RangeElement 对应的 Element
getEndOffsetInclusive()Integer获取范围中部分范围结束的位置。
getStartOffset()Integer获取部分元素在范围元素中的起始位置。
isPartial()Boolean确定该范围元素是覆盖整个元素还是部分选择其中的字符。

方法

方法返回类型简介
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设置元素的属性。

Table

方法

方法返回类型简介
appendTableRow()TableRow创建并附加新的 TableRow
appendTableRow(tableRow)TableRow附加指定的 TableRow
clear()Table清除元素的内容。
copy()Table返回当前元素的已分离深层副本。
editAsText()Text获取当前元素的 Text 版本,以进行修改。
findElement(elementType)RangeElement在该元素的内容中搜索指定类型的后代。
findElement(elementType, from)RangeElement从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。
findText(searchPattern)RangeElement使用正则表达式在元素的内容中搜索指定的文本模式。
findText(searchPattern, from)RangeElement从指定的搜索结果中开始搜索指定文本格式的元素内容。
getAttributes()Object检索元素的属性。
getBorderColor()String检索边框颜色。
getBorderWidth()Number用于检索边界宽度(以点为单位)。
getCell(rowIndex, cellIndex)TableCell检索指定行和单元格索引处的 TableCell
getChild(childIndex)Element检索指定的子索引处的子元素。
getChildIndex(child)Integer检索指定子元素的子索引。
getColumnWidth(columnIndex)Number检索指定的表格列的宽度(以点为单位)。
getLinkUrl()String检索链接网址。
getNextSibling()Element检索该元素的下一个同级元素。
getNumChildren()Integer检索子项的数量。
getNumRows()Integer检索 TableRows 数量。
getParent()ContainerElement检索元素的父元素。
getPreviousSibling()Element检索该元素的上一个同级元素。
getRow(rowIndex)TableRow检索指定行索引处的 TableRow
getText()String以文本字符串的形式检索元素的内容。
getTextAlignment()TextAlignment获取文本对齐方式。
getType()ElementType检索元素的 ElementType
insertTableRow(childIndex)TableRow在指定索引处创建并插入新的 TableRow
insertTableRow(childIndex, tableRow)TableRow在指定索引处插入指定的 TableRow
isAtDocumentEnd()Boolean确定元素是否位于 Document 末尾。
removeChild(child)Table移除指定的子元素。
removeFromParent()Table从父元素中移除元素。
removeRow(rowIndex)TableRow移除指定行索引处的 TableRow
replaceText(searchPattern, replacement)Element使用正则表达式替换给定文本模式中出现的所有字符。
setAttributes(attributes)Table设置元素的属性。
setBorderColor(color)Table设置边框颜色。
setBorderWidth(width)Table设置边框宽度(以点为单位)。
setColumnWidth(columnIndex, width)Table设置指定列的宽度(以点为单位)。
setLinkUrl(url)Table设置链接网址。
setTextAlignment(textAlignment)Table设置文本对齐方式。

TableCell

方法

方法返回类型简介
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在该元素的内容中搜索指定类型的后代。
findElement(elementType, from)RangeElement从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。
findText(searchPattern)RangeElement使用正则表达式在元素的内容中搜索指定的文本模式。
findText(searchPattern, from)RangeElement从指定的搜索结果中开始搜索指定文本格式的元素内容。
getAttributes()Object检索元素的属性。
getBackgroundColor()String检索背景颜色。
getChild(childIndex)Element检索指定的子索引处的子元素。
getChildIndex(child)Integer检索指定子元素的子索引。
getColSpan()Integer检索列 span,即此单元格跨越的表格单元格的列数。
getLinkUrl()String检索链接网址。
getNextSibling()Element检索该元素的下一个同级元素。
getNumChildren()Integer检索子项的数量。
getPaddingBottom()Number检索点的下内边距。
getPaddingLeft()Number检索左内边距(以点为单位)。
getPaddingRight()Number以点为单位检索正确的内边距。
getPaddingTop()Number用于检索顶部内边距(以点为单位)。
getParent()ContainerElement检索元素的父元素。
getParentRow()TableRow检索包含当前 TableCellTableRow
getParentTable()Table检索包含当前 TableCellTable
getPreviousSibling()Element检索该元素的上一个同级元素。
getRowSpan()Integer检索行跨度,即此单元格跨越的表格行数。
getText()String以文本字符串的形式检索元素的内容。
getTextAlignment()TextAlignment获取文本对齐方式。
getType()ElementType检索元素的 ElementType
getVerticalAlignment()VerticalAlignment检索 VerticalAlignment
getWidth()Number检索包含单元格的列的宽度(以点为单位)。
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将元素与前面具有相同类型的同级项合并。
removeChild(child)TableCell移除指定的子元素。
removeFromParent()TableCell从父元素中移除元素。
replaceText(searchPattern, replacement)Element使用正则表达式替换给定文本模式中出现的所有字符。
setAttributes(attributes)TableCell设置元素的属性。
setBackgroundColor(color)TableCell设置背景颜色。
setLinkUrl(url)TableCell设置链接网址。
setPaddingBottom(paddingBottom)TableCell设置下内边距(以点为单位)。
setPaddingLeft(paddingLeft)TableCell设置左内边距(以点为单位)。
setPaddingRight(paddingTop)TableCell设置适当的内边距(以点为单位)。
setPaddingTop(paddingTop)TableCell设置上内边距(以点为单位)。
setText(text)TableCell将内容设置为纯文本。
setTextAlignment(textAlignment)TableCell设置文本对齐方式。
setVerticalAlignment(alignment)TableCell设置垂直对齐方式。
setWidth(width)TableCell设置包含当前单元格的列宽(以点为单位)。

TableOfContents

方法

方法返回类型简介
clear()TableOfContents清除元素的内容。
copy()TableOfContents返回当前元素的已分离深层副本。
editAsText()Text获取当前元素的 Text 版本,以进行修改。
findElement(elementType)RangeElement在该元素的内容中搜索指定类型的后代。
findElement(elementType, from)RangeElement从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。
findText(searchPattern)RangeElement使用正则表达式在元素的内容中搜索指定的文本模式。
findText(searchPattern, from)RangeElement从指定的搜索结果中开始搜索指定文本格式的元素内容。
getAttributes()Object检索元素的属性。
getChild(childIndex)Element检索指定的子索引处的子元素。
getChildIndex(child)Integer检索指定子元素的子索引。
getLinkUrl()String检索链接网址。
getNextSibling()Element检索该元素的下一个同级元素。
getNumChildren()Integer检索子项的数量。
getParent()ContainerElement检索元素的父元素。
getPreviousSibling()Element检索该元素的上一个同级元素。
getText()String以文本字符串的形式检索元素的内容。
getTextAlignment()TextAlignment获取文本对齐方式。
getType()ElementType检索元素的 ElementType
isAtDocumentEnd()Boolean确定元素是否位于 Document 末尾。
removeFromParent()TableOfContents从父元素中移除元素。
replaceText(searchPattern, replacement)Element使用正则表达式替换给定文本模式中出现的所有字符。
setAttributes(attributes)TableOfContents设置元素的属性。
setLinkUrl(url)TableOfContents设置链接网址。
setTextAlignment(textAlignment)TableOfContents设置文本对齐方式。

TableRow

方法

方法返回类型简介
appendTableCell()TableCell创建并附加新的 TableCell
appendTableCell(textContents)TableCell附加包含指定文本的给定 TableCell
appendTableCell(tableCell)TableCell附加指定的 TableCell
clear()TableRow清除元素的内容。
copy()TableRow返回当前元素的已分离深层副本。
editAsText()Text获取当前元素的 Text 版本,以进行修改。
findElement(elementType)RangeElement在该元素的内容中搜索指定类型的后代。
findElement(elementType, from)RangeElement从指定的 RangeElement 开始,在元素的内容中搜索指定类型的后代。
findText(searchPattern)RangeElement使用正则表达式在元素的内容中搜索指定的文本模式。
findText(searchPattern, from)RangeElement从指定的搜索结果中开始搜索指定文本格式的元素内容。
getAttributes()Object检索元素的属性。
getCell(cellIndex)TableCell检索指定的单元索引处的 TableCell
getChild(childIndex)Element检索指定的子索引处的子元素。
getChildIndex(child)Integer检索指定子元素的子索引。
getLinkUrl()String检索链接网址。
getMinimumHeight()Number检索最小高度(以点为单位)。
getNextSibling()Element检索该元素的下一个同级元素。
getNumCells()Integer检索行中单元格的数量。
getNumChildren()Integer检索子项的数量。
getParent()ContainerElement检索元素的父元素。
getParentTable()Table检索包含当前行的 Table
getPreviousSibling()Element检索该元素的上一个同级元素。
getText()String以文本字符串的形式检索元素的内容。
getTextAlignment()TextAlignment获取文本对齐方式。
getType()ElementType检索元素的 ElementType
insertTableCell(childIndex)TableCell在指定索引处创建并插入新的 TableCell
insertTableCell(childIndex, textContents)TableCell在指定索引处插入给定 TableCell,其中包含给定文本。
insertTableCell(childIndex, tableCell)TableCell在指定索引处插入指定的 TableCell
isAtDocumentEnd()Boolean确定元素是否位于 Document 末尾。
merge()TableRow将元素与前面具有相同类型的同级项合并。
removeCell(cellIndex)TableCell移除指定单元格索引处的 TableCell
removeChild(child)TableRow移除指定的子元素。
removeFromParent()TableRow从父元素中移除元素。
replaceText(searchPattern, replacement)Element使用正则表达式替换给定文本模式中出现的所有字符。
setAttributes(attributes)TableRow设置元素的属性。
setLinkUrl(url)TableRow设置链接网址。
setMinimumHeight(minHeight)TableRow设置最小高度(以点为单位)。
setTextAlignment(textAlignment)TableRow设置文本对齐方式。

Text

方法

方法返回类型简介
appendText(text)Text将指定文本添加到此文本区域的末尾。
copy()Text返回当前元素的已分离深层副本。
deleteText(startOffset, endOffsetInclusive)Text删除一系列文本。
editAsText()Text获取当前元素的 Text 版本,以进行修改。
findText(searchPattern)RangeElement使用正则表达式在元素的内容中搜索指定的文本模式。
findText(searchPattern, from)RangeElement从指定的搜索结果中开始搜索指定文本格式的元素内容。
getAttributes()Object检索元素的属性。
getAttributes(offset)Object检索位于指定字符偏移量处的属性。
getBackgroundColor()String检索背景颜色设置。
getBackgroundColor(offset)String检索指定的字符偏移量处的背景颜色。
getFontFamily()String检索字体系列设置。
getFontFamily(offset)String在指定字符偏移量处检索字体系列。
getFontSize()Number用于检索字体大小设置。
getFontSize(offset)Number检索在指定的字符偏移量处获得的字体大小。
getForegroundColor()String检索前景颜色设置。
getForegroundColor(offset)String检索指定的字符偏移量处的前景颜色。
getLinkUrl()String检索链接网址。
getLinkUrl(offset)String检索位于指定字符偏移量处的链接网址。
getNextSibling()Element检索该元素的下一个同级元素。
getParent()ContainerElement检索元素的父元素。
getPreviousSibling()Element检索该元素的上一个同级元素。
getText()String以文本字符串的形式检索元素的内容。
getTextAlignment()TextAlignment获取文本对齐方式。
getTextAlignment(offset)TextAlignment获取单个字符的文本对齐方式。
getTextAttributeIndices()Integer[]检索与不同文本格式运行开始相对应的一组文本索引。
getType()ElementType检索元素的 ElementType
insertText(offset, text)Text在指定字符偏移量处插入指定文本。
isAtDocumentEnd()Boolean确定元素是否位于 Document 末尾。
isBold()Boolean检索粗体设置。
isBold(offset)Boolean检索指定的字符偏移量处的粗体设置。
isItalic()Boolean用于检索斜体设置。
isItalic(offset)Boolean在指定字符偏移量处检索斜体设置。
isStrikethrough()Boolean检索删除线设置。
isStrikethrough(offset)Boolean在指定字符偏移量处检索删除线设置。
isUnderline()Boolean检索下划线设置。
isUnderline(offset)Boolean在指定字符偏移量处检索下划线设置。
merge()Text将元素与前面具有相同类型的同级项合并。
removeFromParent()Text从父元素中移除元素。
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为指定的字符范围设置下划线设置。

TextAlignment

属性

属性类型说明
NORMALEnum正常文本对齐。
SUPERSCRIPTEnum上标文本对齐。
SUBSCRIPTEnum下标文本对齐。

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

属性

属性类型说明
BOTTOMEnum底部对齐选项。
CENTEREnum居中对齐选项。
TOPEnum顶部对齐选项。