Document Service

文件

這項服務可讓指令碼建立、存取及修改 Google 文件檔案。

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

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

類別

名稱簡短說明
Attribute元素屬性的列舉。
BodyGoogle 文件中分頁的內容。
Bookmark代表書籤的物件。
ContainerElement可包含其他元素的通用元素。
Date代表格式化日期的元素
Document文件,內含一或多個 Tab 物件,每個物件都包含 RTF 和表格、清單等元素。
DocumentApp文件服務會建立並開啟 Documents,供您編輯。
DocumentTab文件分頁,內含多媒體文字和表格、清單等元素。
Element一般元素。
ElementType所有元素類型的列舉。
Equation代表數學運算式的元素。
EquationFunction代表數學 Equation 中函式的元素。
EquationFunctionArgumentSeparator代表數學 Equation 中函式分隔符的元素。
EquationSymbol代表數學 Equation 中符號的元素。
FontFamily支援的字型列舉。
FooterSection代表頁尾部分的元素。
Footnote代表註腳的元素。
FootnoteSection代表附註部分的元素。
GlyphType支援的字元類型列舉。
HeaderSection代表標頭區段的元素。
HorizontalAlignment支援的水平對齊類型列舉。
HorizontalRule代表水平規則的元素。
InlineDrawing代表內嵌繪圖的元素。
InlineImage代表內嵌圖片的元素。
ListItem代表清單項目的元素。
NamedRangeRange,具有名稱和 ID,方便日後擷取。
PageBreak代表分頁符的元素。
Paragraph代表段落的元素。
ParagraphHeading標準段落標題的列舉。
Person代表個人連結的元素。
Position文件分頁中相對於特定元素的參照位置。
PositionedImage錨定至 Paragraph 的固定位置圖片。
PositionedLayout列舉,指定如何相對於周圍文字配置 PositionedImage
Range文件中的一系列元素。
RangeBuilder建構工具,用於從文件元素建構 Range 物件。
RangeElementElement 的包裝函式,可能會有開始和結束偏移。
RichLink代表 Google 資源連結的元素,例如雲端硬碟檔案或 YouTube 影片。
TabGoogle 文件中的分頁。
TabType所有分頁類型的列舉。
Table代表表格的元素。
TableCell代表表格儲存格的元素。
TableOfContents包含目錄的元素。
TableRow代表表格列的元素。
Text代表 RTF 區域的元素。
TextAlignment文字對齊方式的列舉。
UnsupportedElement代表不明區域或無法受指令碼影響的元素,例如頁碼。
VerticalAlignment支援的垂直對齊類型列舉。

Attribute

屬性

屬性類型說明
BACKGROUND_COLOREnum元素 (段落、表格等) 或文件的背景顏色。
BOLDEnumRTF 格式的字型粗細設定。
BORDER_COLOREnum表格元素的邊框顏色。
BORDER_WIDTHEnum表格元素的框線寬度,單位為點。
CODEEnum方程式元素的程式碼內容。
FONT_FAMILYEnum設定字型系列 (適用於 RTF 文字)。
FONT_SIZEEnumRTF 格式的字型大小設定 (以點為單位)。
FOREGROUND_COLOREnumRTF 格式文字的前景顏色設定。
HEADINGEnum段落元素的標題類型 (例如 DocumentApp.ParagraphHeading.HEADING1)。
HEIGHTEnum圖片元素的高度設定。
HORIZONTAL_ALIGNMENTEnum段落元素 (例如 DocumentApp.HorizontalAlignment.CENTER) 的水平對齊方式。
INDENT_ENDEnum段落元素結尾縮排的設定 (以點為單位)。
INDENT_FIRST_LINEEnum段落元素的首行縮排設定 (以點為單位)。
INDENT_STARTEnum段落元素的起始縮排設定 (以點為單位)。
ITALICEnumRTF 格式的字型樣式設定。
GLYPH_TYPEEnum清單項目元素的字形類型。
LEFT_TO_RIGHTEnumRTF 格式的文字方向設定。
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段落元素頂端間距設定 (以點為單位)。
STRIKETHROUGHEnumRTF 格式的刪除線設定。
UNDERLINEEnumRTF 格式的底線設定。
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為每個指定的字串值附加新的 Table (內含 TableCell)。
appendTable(table)Table附加指定的 Table
clear()Body清除元素內容。
copy()Body傳回目前元素的深層副本,且該副本已分離。
editAsText()Text取得目前元素的 Text 版本,以供編輯。
findElement(elementType)RangeElement|null搜尋元素內容,找出指定型別的後代。
findElement(elementType, from)RangeElement|null從指定 RangeElement 開始,在元素內容中搜尋指定型別的後代。
findText(searchPattern)RangeElement|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAttributes()Object擷取元素的屬性。
getChild(childIndex)Element擷取指定子項索引處的子項元素。
getChildIndex(child)Integer擷取指定子項元素的子項索引。
getHeadingAttributes(paragraphHeading)Object擷取所提供 ParagraphHeading 的屬性集。
getImages()InlineImage[]|null擷取該節中包含的所有 InlineImages
getListItems()ListItem[]|null擷取該節中包含的所有 ListItems
getMarginBottom()Number|null以點為單位擷取下邊界。
getMarginLeft()Number|null以點為單位擷取左邊界。
getMarginRight()Number|null擷取右邊界。
getMarginTop()Number|null擷取上邊界。
getNumChildren()Integer擷取子項數量。
getPageHeight()Number|null以點為單位擷取頁面高度。
getPageWidth()Number|null以點為單位擷取頁面寬度。
getParagraphs()Paragraph[]|null擷取區段中包含的所有 Paragraphs (包括 ListItems)。
getParent()ContainerElement|null擷取元素的父項元素。
getTables()Table[]|null擷取該節中包含的所有 Tables
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
insertHorizontalRule(childIndex)HorizontalRule在指定索引處建立並插入新的 HorizontalRule
insertImage(childIndex, image)InlineImage在指定索引處,從指定圖片 Blob 建立並插入 InlineImage
insertImage(childIndex, image)InlineImage在指定索引處插入指定 InlineImage
insertListItem(childIndex, listItem)ListItem在指定索引處插入指定 ListItem
insertListItem(childIndex, text)ListItem在指定索引建立並插入新的 ListItem,其中包含指定的文字內容。
insertPageBreak(childIndex)PageBreak在指定索引處建立並插入新的 PageBreak
insertPageBreak(childIndex, pageBreak)PageBreak在指定索引處插入指定 PageBreak
insertParagraph(childIndex, paragraph)Paragraph在指定索引處插入指定 Paragraph
insertParagraph(childIndex, text)Paragraph在指定索引建立並插入新的 Paragraph,其中包含指定的文字內容。
insertTable(childIndex)Table在指定索引處建立並插入新的 Table
insertTable(childIndex, cells)Table建立並插入新的 Table,其中包含指定索引處的指定儲存格。
insertTable(childIndex, table)Table在指定索引處插入指定 Table
removeChild(child)Body移除指定的子項元素。
replaceText(searchPattern, replacement)Element使用規則運算式,將指定文字模式的所有例項替換為指定替代字串。
setAttributes(attributes)Body設定元素的屬性。
setHeadingAttributes(paragraphHeading, attributes)Body為提供的 ParagraphHeading 設定屬性。
setMarginBottom(marginBottom)Body以點為單位設定下邊界。
setMarginLeft(marginLeft)Body以點為單位設定左邊界。
setMarginRight(marginRight)Body以點為單位設定右邊界。
setMarginTop(marginTop)Body設定上邊界。
setPageHeight(pageHeight)Body以點為單位設定頁面高度。
setPageWidth(pageWidth)Body以點為單位設定頁面寬度。
setText(text)Body將內容設為純文字。
setTextAlignment(textAlignment)Body設定文字對齊方式。

Bookmark

方法

方法傳回類型簡短說明
getId()String取得 Bookmark 的 ID。
getPosition()Position取得 DocumentTabBookmarkBookmarkPosition
remove()void刪除 Bookmark

ContainerElement

方法

方法傳回類型簡短說明
asBody()Body將目前元素傳回為 Body
asEquation()EquationEquation 形式傳回目前元素。
asFooterSection()FooterSection將目前元素傳回為 FooterSection
asFootnoteSection()FootnoteSection將目前元素傳回為 FootnoteSection
asHeaderSection()HeaderSection將目前元素傳回為 HeaderSection
asListItem()ListItem將目前元素傳回為 ListItem
asParagraph()Paragraph將目前元素傳回為 Paragraph
asTable()Table將目前元素傳回為 Table
asTableCell()TableCell將目前元素傳回為 TableCell
asTableOfContents()TableOfContents將目前元素傳回為 TableOfContents
asTableRow()TableRow將目前元素傳回為 TableRow
clear()ContainerElement清除元素內容。
copy()ContainerElement傳回目前元素的深層副本,且該副本已分離。
editAsText()Text取得目前元素的 Text 版本,以供編輯。
findElement(elementType)RangeElement|null搜尋元素內容,找出指定型別的後代。
findElement(elementType, from)RangeElement|null從指定 RangeElement 開始,在元素內容中搜尋指定型別的後代。
findText(searchPattern)RangeElement|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAttributes()Object擷取元素的屬性。
getChild(childIndex)Element擷取指定子項索引處的子項元素。
getChildIndex(child)Integer擷取指定子項元素的子項索引。
getLinkUrl()String|null擷取連結網址。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getNumChildren()Integer擷取子項數量。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()ContainerElement|null將元素與相同類型的前一個同層級元素合併。
removeFromParent()ContainerElement|null從父項移除元素。
replaceText(searchPattern, replacement)Element使用規則運算式,將指定文字模式的所有例項替換為指定替代字串。
setAttributes(attributes)ContainerElement設定元素的屬性。
setLinkUrl(url)ContainerElement設定連結網址。
setTextAlignment(textAlignment)ContainerElement設定文字對齊方式。

Date

方法

方法傳回類型簡短說明
copy()Date傳回目前元素的深層副本,且該副本已分離。
getAttributes()Object擷取元素的屬性。
getDisplayText()String傳回文件中顯示的值。
getLocale()String傳回顯示值所用的日期語言代碼。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getTimestamp()Date傳回與日期相關聯的時間戳記。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()Date|null將元素與相同類型的前一個同層級元素合併。
removeFromParent()Date|null從父項移除元素。
setAttributes(attributes)Date設定元素的屬性。

Document

方法

方法傳回類型簡短說明
addBookmark(position)Bookmark在第一個分頁中加入 PositionBookmark,如果是繫結至文件的指令碼,則會加入至目前的分頁。
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 的檢視者清單。
getActiveTab()Tab取得文件中目前使用者的有效 Tab
getAs(contentType)Blob以指定型別的 Blob 形式擷取目前的 Document 內容。
getBlob()Blob以 Blob 形式擷取目前的 Document 內容。
getBody()Body擷取第一個分頁的 Body,或是繫結至文件的指令碼目前分頁的 DocumentBodySection
getBookmark(id)Bookmark|null在第一個分頁中取得具有指定 ID 的 Bookmark,或在繫結至文件的指令碼中取得目前的分頁。
getBookmarks()Bookmark[]取得第一個分頁中的所有 Bookmark 物件,或取得繫結至文件的指令碼目前的分頁。
getCursor()Position|null取得使用者的游標在作用中分頁中的位置。
getEditors()User[]取得這個 Document 的編輯者清單。
getFooter()FooterSection|null擷取第一個分頁的頁尾區段,或擷取繫結至文件的指令碼目前分頁的頁尾區段。
getFootnotes()Footnote[]|null擷取第一個分頁主體中的所有 Footnote 元素,或是擷取與文件繫結的指令碼所屬有效分頁主體中的所有 Footnote 元素。
getHeader()HeaderSection|null擷取第一個分頁的標題區段,或是繫結至文件的指令碼目前分頁的標題區段。
getId()String擷取文件的專屬 ID。
getLanguage()String取得文件的語言代碼。
getName()String擷取文件標題。
getNamedRangeById(id)NamedRange|null在第一個分頁中取得具有指定 ID 的 NamedRange,或在繫結至文件的指令碼中取得目前的分頁。
getNamedRanges()NamedRange[]取得第一個分頁中的所有 NamedRange 物件,或取得繫結至文件的指令碼目前的分頁。
getNamedRanges(name)NamedRange[]在第一個分頁中取得所有具有指定名稱的 NamedRange 物件,或是取得與文件繫結的指令碼所屬的有效分頁。
getSelection()Range|null取得現用分頁中使用者選取的內容。
getSupportedLanguageCodes()String[]取得 Google 文件檔案支援的所有語言代碼。
getTab(tabId)Tab取得具有指定 ID 的 Tab
getTabs()Tab[]取得文件中所有未巢狀化的 Tab
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
setActiveTab(tabId)void將目前文件中使用者選取的 Tab 設為具有指定 ID 的分頁。
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開啟並傳回具有指定網址的文件。

DocumentTab

方法

方法傳回類型簡短說明
addBookmark(position)Bookmark在指定 Position 新增 Bookmark
addFooter()FooterSection如果沒有分頁註腳區段,則新增該區段。
addHeader()HeaderSection如果沒有分頁標題區段,則新增該區段。
addNamedRange(name, range)NamedRange新增 NamedRange,也就是具有名稱和 ID 的 Range,供日後擷取。
getBody()Body擷取分頁的 Body
getBookmark(id)Bookmark|null取得具有指定 ID 的 Bookmark
getBookmarks()Bookmark[]取得分頁中的所有 Bookmark 物件。
getFooter()FooterSection|null擷取分頁的頁尾部分 (如有)。
getFootnotes()Footnote[]|null擷取分頁主體中的所有 Footnote 元素。
getHeader()HeaderSection|null擷取分頁的標題區段 (如有)。
getNamedRangeById(id)NamedRange|null取得具有指定 ID 的 NamedRange
getNamedRanges()NamedRange[]取得分頁中的所有 NamedRange 物件。
getNamedRanges(name)NamedRange[]取得具有指定名稱的分頁中的所有 NamedRange 物件。
newPosition(element, offset)Position建立新的 Position,這是指分頁中相對於特定元素的位置。
newRange()RangeBuilder建立建構工具,用於從分頁元素建構 Range 物件。

Element

方法

方法傳回類型簡短說明
asBody()Body將目前元素傳回為 Body
asDate()Date將目前元素傳回為 Date
asEquation()EquationEquation 形式傳回目前元素。
asEquationFunction()EquationFunction將目前元素傳回為 EquationFunction
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparator將目前元素傳回為 EquationFunctionArgumentSeparator
asEquationSymbol()EquationSymbol將目前元素傳回為 EquationSymbol
asFooterSection()FooterSection將目前元素傳回為 FooterSection
asFootnote()Footnote將目前元素傳回為 Footnote
asFootnoteSection()FootnoteSection將目前元素傳回為 FootnoteSection
asHeaderSection()HeaderSection將目前元素傳回為 HeaderSection
asHorizontalRule()HorizontalRule將目前元素傳回為 HorizontalRule
asInlineDrawing()InlineDrawing將目前元素傳回為 InlineDrawing
asInlineImage()InlineImage將目前元素傳回為 InlineImage
asListItem()ListItem將目前元素傳回為 ListItem
asPageBreak()PageBreak將目前元素傳回為 PageBreak
asParagraph()Paragraph將目前元素傳回為 Paragraph
asPerson()Person將目前元素傳回為 Person
asRichLink()RichLink傳回目前的元素,例如 Google 試算表檔案的連結。RichLink
asTable()Table將目前元素傳回為 Table
asTableCell()TableCell將目前元素傳回為 TableCell
asTableOfContents()TableOfContents將目前元素傳回為 TableOfContents
asTableRow()TableRow將目前元素傳回為 TableRow
asText()Text將目前元素傳回為 Text
copy()Element傳回目前元素的深層副本,且該副本已分離。
getAttributes()Object擷取元素的屬性。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()Element|null將元素與相同類型的前一個同層級元素合併。
removeFromParent()Element|null從父項移除元素。
setAttributes(attributes)Element設定元素的屬性。

ElementType

屬性

屬性類型說明
BODY_SECTIONEnumBody 元素對應的型別。
COMMENT_SECTIONEnumCommentSection 元素對應的型別。
DATEEnumDate 元素對應的型別。
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 元素對應的型別。
UNSUPPORTEDEnum對應 UnsupportedElement 的型別。

Equation

方法

方法傳回類型簡短說明
clear()Equation清除元素內容。
copy()Equation傳回目前元素的深層副本,且該副本已分離。
editAsText()Text取得目前元素的 Text 版本,以供編輯。
findElement(elementType)RangeElement|null搜尋元素內容,找出指定型別的後代。
findElement(elementType, from)RangeElement|null從指定 RangeElement 開始,在元素內容中搜尋指定型別的後代。
findText(searchPattern)RangeElement|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAttributes()Object擷取元素的屬性。
getChild(childIndex)Element擷取指定子項索引處的子項元素。
getChildIndex(child)Integer擷取指定子項元素的子項索引。
getLinkUrl()String|null擷取連結網址。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getNumChildren()Integer擷取子項數量。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()Equation|null將元素與相同類型的前一個同層級元素合併。
removeFromParent()Equation|null從父項移除元素。
replaceText(searchPattern, replacement)Element使用規則運算式,將指定文字模式的所有例項替換為指定替代字串。
setAttributes(attributes)Equation設定元素的屬性。
setLinkUrl(url)Equation設定連結網址。
setTextAlignment(textAlignment)Equation設定文字對齊方式。

EquationFunction

方法

方法傳回類型簡短說明
clear()EquationFunction清除元素內容。
copy()EquationFunction傳回目前元素的深層副本,且該副本已分離。
editAsText()Text取得目前元素的 Text 版本,以供編輯。
findElement(elementType)RangeElement|null搜尋元素內容,找出指定型別的後代。
findElement(elementType, from)RangeElement|null從指定 RangeElement 開始,在元素內容中搜尋指定型別的後代。
findText(searchPattern)RangeElement|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAttributes()Object擷取元素的屬性。
getChild(childIndex)Element擷取指定子項索引處的子項元素。
getChildIndex(child)Integer擷取指定子項元素的子項索引。
getCode()String擷取與方程式函式對應的程式碼。
getLinkUrl()String|null擷取連結網址。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getNumChildren()Integer擷取子項數量。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()EquationFunction|null將元素與相同類型的前一個同層級元素合併。
removeFromParent()EquationFunction|null從父項移除元素。
replaceText(searchPattern, replacement)Element使用規則運算式,將指定文字模式的所有例項替換為指定替代字串。
setAttributes(attributes)EquationFunction設定元素的屬性。
setLinkUrl(url)EquationFunction設定連結網址。
setTextAlignment(textAlignment)EquationFunction設定文字對齊方式。

EquationFunctionArgumentSeparator

方法

方法傳回類型簡短說明
copy()EquationFunctionArgumentSeparator傳回目前元素的深層副本,且該副本已分離。
getAttributes()Object擷取元素的屬性。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()EquationFunctionArgumentSeparator|null將元素與相同類型的前一個同層級元素合併。
removeFromParent()EquationFunctionArgumentSeparator|null從父項移除元素。
setAttributes(attributes)EquationFunctionArgumentSeparator設定元素的屬性。

EquationSymbol

方法

方法傳回類型簡短說明
copy()EquationSymbol傳回目前元素的深層副本,且該副本已分離。
getAttributes()Object擷取元素的屬性。
getCode()String擷取與方程式符號對應的程式碼。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()EquationSymbol|null將元素與相同類型的前一個同層級元素合併。
removeFromParent()EquationSymbol|null從父項移除元素。
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為每個指定的字串值附加新的 Table (內含 TableCell)。
appendTable(table)Table附加指定的 Table
clear()FooterSection清除元素內容。
copy()FooterSection傳回目前元素的深層副本,且該副本已分離。
editAsText()Text取得目前元素的 Text 版本,以供編輯。
findElement(elementType)RangeElement|null搜尋元素內容,找出指定型別的後代。
findElement(elementType, from)RangeElement|null從指定 RangeElement 開始,在元素內容中搜尋指定型別的後代。
findText(searchPattern)RangeElement|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAttributes()Object擷取元素的屬性。
getChild(childIndex)Element擷取指定子項索引處的子項元素。
getChildIndex(child)Integer擷取指定子項元素的子項索引。
getImages()InlineImage[]|null擷取該節中包含的所有 InlineImages
getListItems()ListItem[]|null擷取該節中包含的所有 ListItems
getNumChildren()Integer擷取子項數量。
getParagraphs()Paragraph[]|null擷取區段中包含的所有 Paragraphs (包括 ListItems)。
getParent()ContainerElement|null擷取元素的父項元素。
getTables()Table[]|null擷取該節中包含的所有 Tables
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
insertHorizontalRule(childIndex)HorizontalRule在指定索引處建立並插入新的 HorizontalRule
insertImage(childIndex, image)InlineImage在指定索引處,從指定圖片 Blob 建立並插入 InlineImage
insertImage(childIndex, image)InlineImage在指定索引處插入指定 InlineImage
insertListItem(childIndex, listItem)ListItem在指定索引處插入指定 ListItem
insertListItem(childIndex, text)ListItem在指定索引建立並插入新的 ListItem,其中包含指定的文字內容。
insertParagraph(childIndex, paragraph)Paragraph在指定索引處插入指定 Paragraph
insertParagraph(childIndex, text)Paragraph在指定索引建立並插入新的 Paragraph,其中包含指定的文字內容。
insertTable(childIndex)Table在指定索引處建立並插入新的 Table
insertTable(childIndex, cells)Table建立並插入新的 Table,其中包含指定索引處的指定儲存格。
insertTable(childIndex, table)Table在指定索引處插入指定 Table
removeChild(child)FooterSection移除指定的子項元素。
removeFromParent()FooterSection|null從父項移除元素。
replaceText(searchPattern, replacement)Element使用規則運算式,將指定文字模式的所有例項替換為指定替代字串。
setAttributes(attributes)FooterSection設定元素的屬性。
setText(text)FooterSection將內容設為純文字。
setTextAlignment(textAlignment)FooterSection設定文字對齊方式。

Footnote

方法

方法傳回類型簡短說明
copy()Footnote傳回目前元素的深層副本,且該副本已分離。
getAttributes()Object擷取元素的屬性。
getFootnoteContents()FootnoteSection|null擷取註腳元素的內容。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
removeFromParent()Footnote|null從父項移除元素。
setAttributes(attributes)Footnote設定元素的屬性。

FootnoteSection

方法

方法傳回類型簡短說明
appendParagraph(paragraph)Paragraph附加指定的 Paragraph
appendParagraph(text)Paragraph建立並附加包含指定文字內容的新 Paragraph
clear()FootnoteSection清除元素內容。
copy()FootnoteSection傳回目前元素的深層副本,且該副本已分離。
editAsText()Text取得目前元素的 Text 版本,以供編輯。
findElement(elementType)RangeElement|null搜尋元素內容,找出指定型別的後代。
findElement(elementType, from)RangeElement|null從指定 RangeElement 開始,在元素內容中搜尋指定型別的後代。
findText(searchPattern)RangeElement|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAttributes()Object擷取元素的屬性。
getChild(childIndex)Element擷取指定子項索引處的子項元素。
getChildIndex(child)Integer擷取指定子項元素的子項索引。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getNumChildren()Integer擷取子項數量。
getParagraphs()Paragraph[]|null擷取區段中包含的所有 Paragraphs (包括 ListItems)。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
insertParagraph(childIndex, paragraph)Paragraph在指定索引處插入指定 Paragraph
insertParagraph(childIndex, text)Paragraph在指定索引建立並插入新的 Paragraph,其中包含指定的文字內容。
removeChild(child)FootnoteSection移除指定的子項元素。
removeFromParent()FootnoteSection|null從父項移除元素。
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為每個指定的字串值附加新的 Table (內含 TableCell)。
appendTable(table)Table附加指定的 Table
clear()HeaderSection清除元素內容。
copy()HeaderSection傳回目前元素的深層副本,且該副本已分離。
editAsText()Text取得目前元素的 Text 版本,以供編輯。
findElement(elementType)RangeElement|null搜尋元素內容,找出指定型別的後代。
findElement(elementType, from)RangeElement|null從指定 RangeElement 開始,在元素內容中搜尋指定型別的後代。
findText(searchPattern)RangeElement|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAttributes()Object擷取元素的屬性。
getChild(childIndex)Element擷取指定子項索引處的子項元素。
getChildIndex(child)Integer擷取指定子項元素的子項索引。
getImages()InlineImage[]|null擷取該節中包含的所有 InlineImages
getListItems()ListItem[]|null擷取該節中包含的所有 ListItems
getNumChildren()Integer擷取子項數量。
getParagraphs()Paragraph[]|null擷取區段中包含的所有 Paragraphs (包括 ListItems)。
getParent()ContainerElement|null擷取元素的父項元素。
getTables()Table[]|null擷取該節中包含的所有 Tables
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
insertHorizontalRule(childIndex)HorizontalRule在指定索引處建立並插入新的 HorizontalRule
insertImage(childIndex, image)InlineImage在指定索引處,從指定圖片 Blob 建立並插入 InlineImage
insertImage(childIndex, image)InlineImage在指定索引處插入指定 InlineImage
insertListItem(childIndex, listItem)ListItem在指定索引處插入指定 ListItem
insertListItem(childIndex, text)ListItem在指定索引建立並插入新的 ListItem,其中包含指定的文字內容。
insertParagraph(childIndex, paragraph)Paragraph在指定索引處插入指定 Paragraph
insertParagraph(childIndex, text)Paragraph在指定索引建立並插入新的 Paragraph,其中包含指定的文字內容。
insertTable(childIndex)Table在指定索引處建立並插入新的 Table
insertTable(childIndex, cells)Table建立並插入新的 Table,其中包含指定索引處的指定儲存格。
insertTable(childIndex, table)Table在指定索引處插入指定 Table
removeChild(child)HeaderSection移除指定的子項元素。
removeFromParent()HeaderSection|null從父項移除元素。
replaceText(searchPattern, replacement)Element使用規則運算式,將指定文字模式的所有例項替換為指定替代字串。
setAttributes(attributes)HeaderSection設定元素的屬性。
setText(text)HeaderSection將內容設為純文字。
setTextAlignment(textAlignment)HeaderSection設定文字對齊方式。

HorizontalAlignment

屬性

屬性類型說明
LEFTEnum靠左對齊選項。
CENTEREnum置中對齊選項。
RIGHTEnum靠右對齊選項。
JUSTIFYEnum齊行對齊選項。

HorizontalRule

方法

方法傳回類型簡短說明
copy()HorizontalRule傳回目前元素的深層副本,且該副本已分離。
getAttributes()Object擷取元素的屬性。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
removeFromParent()HorizontalRule|null從父項移除元素。
setAttributes(attributes)HorizontalRule設定元素的屬性。

InlineDrawing

方法

方法傳回類型簡短說明
copy()InlineDrawing傳回目前元素的深層副本,且該副本已分離。
getAltDescription()String|null傳回繪圖的替代說明。
getAltTitle()String|null傳回繪圖的替代標題。
getAttributes()Object擷取元素的屬性。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()InlineDrawing|null將元素與相同類型的前一個同層級元素合併。
removeFromParent()InlineDrawing|null從父項移除元素。
setAltDescription(description)InlineDrawing設定繪圖的替代說明。
setAltTitle(title)InlineDrawing設定繪圖的替代標題。
setAttributes(attributes)InlineDrawing設定元素的屬性。

InlineImage

方法

方法傳回類型簡短說明
copy()InlineImage傳回目前元素的深層副本,且該副本已分離。
getAltDescription()String|null傳回圖片的替代說明。
getAltTitle()String|null傳回圖片的替代標題。
getAs(contentType)Blob以轉換為指定內容類型的 Blob 形式,傳回這個物件內的資料。
getAttributes()Object擷取元素的屬性。
getBlob()Blob將這個物件內的資料以 Blob 形式傳回。
getHeight()Integer擷取圖片的高度 (以像素為單位)。
getLinkUrl()String|null擷取連結網址。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getType()ElementType擷取元素的 ElementType
getWidth()Integer以像素為單位擷取圖片寬度。
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()InlineImage|null將元素與相同類型的前一個同層級元素合併。
removeFromParent()InlineImage|null從父項移除元素。
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|null搜尋元素內容,找出指定型別的後代。
findElement(elementType, from)RangeElement|null從指定 RangeElement 開始,在元素內容中搜尋指定型別的後代。
findText(searchPattern)RangeElement|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAlignment()HorizontalAlignment|null擷取 HorizontalAlignment
getAttributes()Object擷取元素的屬性。
getChild(childIndex)Element擷取指定子項索引處的子項元素。
getChildIndex(child)Integer擷取指定子項元素的子項索引。
getGlyphType()GlyphType|null擷取清單項目的 GlyphType
getHeading()ParagraphHeading|null擷取 ParagraphHeading
getIndentEnd()Number|null擷取結尾縮排 (以點為單位)。
getIndentFirstLine()Number|null以點為單位擷取首行縮排。
getIndentStart()Number|null擷取起始縮排。
getLineSpacing()Number|null以點為單位擷取行距。
getLinkUrl()String|null擷取連結網址。
getListId()String|null擷取清單 ID。
getNestingLevel()Integer擷取清單項目的巢狀層級。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getNumChildren()Integer擷取子項數量。
getParent()ContainerElement|null擷取元素的父項元素。
getPositionedImage(id)PositionedImage依圖片 ID 取得 PositionedImage
getPositionedImages()PositionedImage[]取得錨定至段落的所有 PositionedImage 物件。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getSpacingAfter()Number|null以點為單位擷取元素後的間距。
getSpacingBefore()Number|null以點為單位,擷取元素前的間距。
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
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|null擷取由左至右設定。
merge()ListItem|null將元素與相同類型的前一個同層級元素合併。
removeChild(child)ListItem移除指定的子項元素。
removeFromParent()ListItem|null從父項移除元素。
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|null擷取元素的下一個同層級元素。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
removeFromParent()PageBreak|null從父項移除元素。
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|null搜尋元素內容,找出指定型別的後代。
findElement(elementType, from)RangeElement|null從指定 RangeElement 開始,在元素內容中搜尋指定型別的後代。
findText(searchPattern)RangeElement|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAlignment()HorizontalAlignment|null擷取 HorizontalAlignment
getAttributes()Object擷取元素的屬性。
getChild(childIndex)Element擷取指定子項索引處的子項元素。
getChildIndex(child)Integer擷取指定子項元素的子項索引。
getHeading()ParagraphHeading|null擷取 ParagraphHeading
getIndentEnd()Number|null擷取結尾縮排 (以點為單位)。
getIndentFirstLine()Number|null以點為單位擷取首行縮排。
getIndentStart()Number|null擷取起始縮排。
getLineSpacing()Number|null以點為單位擷取行距。
getLinkUrl()String|null擷取連結網址。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getNumChildren()Integer擷取子項數量。
getParent()ContainerElement|null擷取元素的父項元素。
getPositionedImage(id)PositionedImage依圖片 ID 取得 PositionedImage
getPositionedImages()PositionedImage[]取得錨定至段落的所有 PositionedImage 物件。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getSpacingAfter()Number|null以點為單位擷取元素後的間距。
getSpacingBefore()Number|null以點為單位,擷取元素前的間距。
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
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|null擷取由左至右設定。
merge()Paragraph|null將元素與相同類型的前一個同層級元素合併。
removeChild(child)Paragraph移除指定的子項元素。
removeFromParent()Paragraph|null從父項移除元素。
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|null傳回使用者的顯示名稱 (如有設定)。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()Person|null將元素與相同類型的前一個同層級元素合併。
removeFromParent()Person|null從父項移除元素。
setAttributes(attributes)Person設定元素的屬性。

Position

方法

方法傳回類型簡短說明
getElement()Element取得包含這個 Position 的元素。
getOffset()Integer取得這個 Position 在所含元素中的相對位置。
getSurroundingText()Text建立代表 Position 所含文字和格式的人工 Text 元素,無論是直接或透過一連串子項元素。ParagraphListItem
getSurroundingTextOffset()Integer取得 getSurroundingText() 傳回的 Text 元素中,這個 Position 的偏移。
insertBookmark()Bookmark建立並在這個 Position 插入新的 Bookmark
insertInlineImage(image)InlineImage|null從指定的圖片 Blob,在這個 Position 建立並插入新的 InlineImage
insertText(text)Text|nullPosition 插入指定文字。

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將部分 Text 元素新增至這個 RangeBuilder
addElementsBetween(startElement, endElementInclusive)RangeBuilder將兩個完整元素和兩者之間的所有元素新增至這個 RangeBuilder
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilder將兩個部分 Text 元素,以及兩者之間的所有元素,新增至 RangeBuilder
addRange(range)RangeBuilder將另一個 Range 的內容新增至這個 RangeRangeBuilder
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|null傳回連結的 MIME 類型,當項目是雲端硬碟檔案的連結時,這個類型會是 null,否則為其他類型。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getTitle()String傳回連結的顯示標題。
getType()ElementType擷取元素的 ElementType
getUrl()String傳回資源的網址。
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()RichLink|null將元素與相同類型的前一個同層級元素合併。
removeFromParent()RichLink|null從父項移除元素。
setAttributes(attributes)RichLink設定元素的屬性。

Tab

方法

方法傳回類型簡短說明
asDocumentTab()DocumentTabDocumentTab 形式擷取分頁內容。
getChildTabs()Tab[]擷取這個分頁中巢狀的子分頁。
getId()String擷取分頁的 ID。
getIndex()Integer擷取父項中索引值以 0 為準的分頁。
getTitle()String擷取分頁的標題。
getType()TabType擷取分頁類型。

TabType

屬性

屬性類型說明
DOCUMENT_TABEnum對應 DocumentTab 的型別。

Table

方法

方法傳回類型簡短說明
appendTableRow()TableRow建立並附加新的 TableRow
appendTableRow(tableRow)TableRow附加指定的 TableRow
clear()Table清除元素內容。
copy()Table傳回目前元素的深層副本,且該副本已分離。
editAsText()Text取得目前元素的 Text 版本,以供編輯。
findElement(elementType)RangeElement|null搜尋元素內容,找出指定型別的後代。
findElement(elementType, from)RangeElement|null從指定 RangeElement 開始,在元素內容中搜尋指定型別的後代。
findText(searchPattern)RangeElement|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAttributes()Object擷取元素的屬性。
getBorderColor()String|null擷取邊框顏色。
getBorderWidth()Number|null擷取框線寬度 (以點為單位)。
getCell(rowIndex, cellIndex)TableCell|null擷取指定列和儲存格索引的 TableCell
getChild(childIndex)Element擷取指定子項索引處的子項元素。
getChildIndex(child)Integer擷取指定子項元素的子項索引。
getColumnWidth(columnIndex)Number|null以點為單位,擷取指定表格欄的寬度。
getLinkUrl()String|null擷取連結網址。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getNumChildren()Integer擷取子項數量。
getNumRows()Integer擷取 TableRows 的數量。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getRow(rowIndex)TableRow|null擷取指定列索引的 TableRow
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
insertTableRow(childIndex)TableRow在指定索引處建立並插入新的 TableRow
insertTableRow(childIndex, tableRow)TableRow在指定索引處插入指定 TableRow
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
removeChild(child)Table移除指定的子項元素。
removeFromParent()Table|null從父項移除元素。
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|null搜尋元素內容,找出指定型別的後代。
findElement(elementType, from)RangeElement|null從指定 RangeElement 開始,在元素內容中搜尋指定型別的後代。
findText(searchPattern)RangeElement|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAttributes()Object擷取元素的屬性。
getBackgroundColor()String|null擷取背景顏色。
getChild(childIndex)Element擷取指定子項索引處的子項元素。
getChildIndex(child)Integer擷取指定子項元素的子項索引。
getColSpan()Integer擷取欄跨度,也就是這個儲存格跨越的表格儲存格欄數。
getLinkUrl()String|null擷取連結網址。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getNumChildren()Integer擷取子項數量。
getPaddingBottom()Number|null以點為單位擷取底部邊框間距。
getPaddingLeft()Number|null以點為單位擷取左側邊框間距。
getPaddingRight()Number|null以點為單位擷取右側邊框間距。
getPaddingTop()Number|null以點為單位擷取頂端邊框間距。
getParent()ContainerElement|null擷取元素的父項元素。
getParentRow()TableRow|null擷取包含目前 TableCellTableRow
getParentTable()Table|null擷取包含目前 TableCellTable
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getRowSpan()Integer擷取列跨度,也就是這個儲存格跨越的表格儲存格列數。
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
getVerticalAlignment()VerticalAlignment|null擷取 VerticalAlignment
getWidth()Number|null以點為單位,擷取含有儲存格的資料欄寬度。
insertHorizontalRule(childIndex)HorizontalRule在指定索引處建立並插入新的 HorizontalRule
insertImage(childIndex, image)InlineImage在指定索引處,從指定圖片 Blob 建立並插入 InlineImage
insertImage(childIndex, image)InlineImage在指定索引處插入指定 InlineImage
insertListItem(childIndex, listItem)ListItem在指定索引處插入指定 ListItem
insertListItem(childIndex, text)ListItem在指定索引處建立並插入新的 ListItem
insertParagraph(childIndex, paragraph)Paragraph在指定索引處插入指定 Paragraph
insertParagraph(childIndex, text)Paragraph在指定索引處建立並插入新的 Paragraph
insertTable(childIndex)Table在指定索引處建立並插入新的 Table
insertTable(childIndex, cells)Table建立並插入新的 Table,其中包含指定索引處的指定儲存格。
insertTable(childIndex, table)Table在指定索引處插入指定 Table
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()TableCell|null將元素與相同類型的前一個同層級元素合併。
removeChild(child)TableCell移除指定的子項元素。
removeFromParent()TableCell|null從父項移除元素。
replaceText(searchPattern, replacement)Element使用規則運算式,將指定文字模式的所有例項替換為指定替代字串。
setAttributes(attributes)TableCell設定元素的屬性。
setBackgroundColor(color)TableCell設定背景顏色。
setLinkUrl(url)TableCell設定連結網址。
setPaddingBottom(paddingBottom)TableCell以點為單位設定底部邊框間距。
setPaddingLeft(paddingLeft)TableCell以點為單位設定左側邊框間距。
setPaddingRight(paddingRight)TableCell以點為單位設定右側邊框間距。
setPaddingTop(paddingTop)TableCell設定上邊框間距 (以點為單位)。
setText(text)TableCell將內容設為純文字。
setTextAlignment(textAlignment)TableCell設定文字對齊方式。
setVerticalAlignment(alignment)TableCell設定垂直對齊方式。
setWidth(width)TableCell以點為單位,設定包含目前儲存格的資料欄寬度。

TableOfContents

方法

方法傳回類型簡短說明
clear()TableOfContents清除元素內容。
copy()TableOfContents傳回目前元素的深層副本,且該副本已分離。
editAsText()Text取得目前元素的 Text 版本,以供編輯。
findElement(elementType)RangeElement|null搜尋元素內容,找出指定型別的後代。
findElement(elementType, from)RangeElement|null從指定 RangeElement 開始,在元素內容中搜尋指定型別的後代。
findText(searchPattern)RangeElement|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAttributes()Object擷取元素的屬性。
getChild(childIndex)Element擷取指定子項索引處的子項元素。
getChildIndex(child)Integer擷取指定子項元素的子項索引。
getLinkUrl()String|null擷取連結網址。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getNumChildren()Integer擷取子項數量。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
removeFromParent()TableOfContents|null從父項移除元素。
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|null搜尋元素內容,找出指定型別的後代。
findElement(elementType, from)RangeElement|null從指定 RangeElement 開始,在元素內容中搜尋指定型別的後代。
findText(searchPattern)RangeElement|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAttributes()Object擷取元素的屬性。
getCell(cellIndex)TableCell|null擷取指定儲存格索引處的 TableCell
getChild(childIndex)Element擷取指定子項索引處的子項元素。
getChildIndex(child)Integer擷取指定子項元素的子項索引。
getLinkUrl()String|null擷取連結網址。
getMinimumHeight()Number|null以點為單位擷取高度下限。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getNumCells()Integer擷取資料列中的儲存格數。
getNumChildren()Integer擷取子項數量。
getParent()ContainerElement|null擷取元素的父項元素。
getParentTable()Table|null擷取包含目前資料列的 Table
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
insertTableCell(childIndex)TableCell在指定索引處建立並插入新的 TableCell
insertTableCell(childIndex, textContents)TableCell在指定索引處插入含有指定文字的 TableCell
insertTableCell(childIndex, tableCell)TableCell在指定索引處插入指定 TableCell
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()TableRow|null將元素與相同類型的前一個同層級元素合併。
removeCell(cellIndex)TableCell移除指定儲存格索引處的 TableCell
removeChild(child)TableRow移除指定的子項元素。
removeFromParent()TableRow|null從父項移除元素。
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|null使用規則運算式在元素內容中搜尋指定的文字模式。
findText(searchPattern, from)RangeElement|null從指定的搜尋結果開始,在元素內容中搜尋特定文字模式。
getAttributes()Object擷取元素的屬性。
getAttributes(offset)Object擷取指定字元偏移的屬性。
getBackgroundColor()String|null擷取背景顏色設定。
getBackgroundColor(offset)String|null擷取指定字元偏移量的背景顏色。
getFontFamily()String|null擷取字型系列設定。
getFontFamily(offset)String|null擷取指定字元偏移的字型系列。
getFontSize()Number|null擷取字型大小設定。
getFontSize(offset)Number|null擷取指定字元偏移量的字型大小。
getForegroundColor()String|null擷取前景顏色設定。
getForegroundColor(offset)String|null擷取指定字元偏移量的前景色。
getLinkUrl()String|null擷取連結網址。
getLinkUrl(offset)String|null擷取指定字元偏移位置的連結網址。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getText()String以文字字串形式擷取元素內容。
getTextAlignment()TextAlignment|null取得文字對齊方式。
getTextAlignment(offset)TextAlignment|null取得單一字元的文字對齊方式。
getTextAttributeIndices()Integer[]擷取對應於不同文字格式設定執行開始位置的文字索引集。
getType()ElementType擷取元素的 ElementType
insertText(offset, text)Text在指定字元位移處插入指定文字。
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
isBold()Boolean|null擷取粗體設定。
isBold(offset)Boolean|null擷取指定字元偏移的粗體設定。
isItalic()Boolean|null擷取斜體設定。
isItalic(offset)Boolean|null擷取指定字元偏移的斜體設定。
isStrikethrough()Boolean|null擷取刪除線設定。
isStrikethrough(offset)Boolean|null擷取指定字元偏移的刪除線設定。
isUnderline()Boolean|null擷取底線設定。
isUnderline(offset)Boolean|null擷取指定字元偏移的底線設定。
merge()Text|null將元素與相同類型的前一個同層級元素合併。
removeFromParent()Text|null從父項移除元素。
replaceText(searchPattern, replacement)Element使用規則運算式,將指定文字模式的所有例項替換為指定替代字串。
setAttributes(startOffset, endOffsetInclusive, attributes)Text將指定屬性套用至指定字元範圍。
setAttributes(attributes)Text設定元素的屬性。
setBackgroundColor(startOffset, endOffsetInclusive, color)Text為指定字元範圍設定背景顏色。
setBackgroundColor(color)Text設定背景顏色。
setBold(bold)Text設定粗體。
setBold(startOffset, endOffsetInclusive, bold)Text為指定字元範圍設定粗體。
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)Text為指定字元範圍設定字型系列。
setFontFamily(fontFamilyName)Text設定字型系列。
setFontSize(startOffset, endOffsetInclusive, size)Text為指定字元範圍設定字型大小。
setFontSize(size)Text設定字型大小。
setForegroundColor(startOffset, endOffsetInclusive, color)Text為指定字元範圍設定前景顏色。
setForegroundColor(color)Text設定前景色。
setItalic(italic)Text設定斜體。
setItalic(startOffset, endOffsetInclusive, italic)Text為指定字元範圍設定斜體。
setLinkUrl(startOffset, endOffsetInclusive, url)Text為指定字元範圍設定連結網址。
setLinkUrl(url)Text設定連結網址。
setStrikethrough(strikethrough)Text設定刪除線。
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)Text為指定字元範圍設定刪除線。
setText(text)Text設定文字內容。
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)Text為指定字元範圍設定文字對齊方式。
setTextAlignment(textAlignment)Text設定文字對齊方式。
setUnderline(underline)Text設定底線。
setUnderline(startOffset, endOffsetInclusive, underline)Text為指定字元範圍設定底線。

TextAlignment

屬性

屬性類型說明
NORMALEnum一般文字對齊方式。
SUPERSCRIPTEnum上標文字對齊方式。
SUBSCRIPTEnum下標文字對齊方式。

UnsupportedElement

方法

方法傳回類型簡短說明
copy()UnsupportedElement傳回目前元素的深層副本,且該副本已分離。
getAttributes()Object擷取元素的屬性。
getNextSibling()Element|null擷取元素的下一個同層級元素。
getParent()ContainerElement|null擷取元素的父項元素。
getPreviousSibling()Element|null擷取元素的前一個同層級元素。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()UnsupportedElement|null將元素與相同類型的前一個同層級元素合併。
removeFromParent()UnsupportedElement|null從父項移除元素。
setAttributes(attributes)UnsupportedElement設定元素的屬性。

VerticalAlignment

屬性

屬性類型說明
BOTTOMEnum底部對齊選項。
CENTEREnum置中對齊選項。
TOPEnum靠上對齊選項。