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 对象的构建器。
RangeElement围绕 Element 的封装容器,具有可能的起始偏移量和结束偏移量。
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 的文本和格式。
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向此 RangeBuilder 添加整个 Element
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检索列跨度,即此单元格跨越的表格单元格的列数。
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(paddingRight)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顶部对齐选项。