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 物件,每個物件都包含富文字和表格和清單等元素。
DocumentApp文件服務會建立並開啟可編輯的 Documents
DocumentTab包含多媒體文字和表格、清單等元素的文件分頁。
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 影片。
TabGoogle 文件中的分頁。
TabType所有分頁類型的列舉。
Table代表資料表的元素。
TableCell代表表格儲存格的元素。
TableOfContents包含目錄的元素。
TableRow代表表格資料列的元素。
Text代表富文字區域的元素。
TextAlignment文字對齊類型的列舉。
UnsupportedElement代表未知或無法受指令碼影響的區域的元素,例如頁碼。
VerticalAlignment列舉支援的垂直對齊類型。

Attribute

屬性

屬性類型說明
BACKGROUND_COLOREnum元素 (段落、表格等) 或文件的背景顏色。
BOLDEnum適用於富文字的字型粗細設定。
BORDER_COLOREnum表格元素的邊框顏色。
BORDER_WIDTHEnum表格元素的框線寬度,以點為單位。
CODEEnum等式元素的程式碼內容。
FONT_FAMILYEnum適用於富文字的字型系列設定。
FONT_SIZEEnum富文字的字型大小設定 (以點為單位)。
FOREGROUND_COLOREnumRTF 格式文字的前景顏色設定。
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段落元素的頂部間距設定 (以點為單位)。
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針對每個指定的字串值,附加包含 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取得 DocumentTabBookmarkPosition
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)BookmarkBookmark 新增至指定 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,可用於日後擷取)。如果是繫結至文件的指令碼,則會在目前分頁中新增 NamedRange
addViewer(emailAddress)Document將指定使用者新增至 Document 的觀眾名單。
addViewer(user)Document將指定使用者新增至 Document 的觀眾名單。
addViewers(emailAddresses)Document將指定的使用者陣列新增至 Document 的觀眾清單。
getActiveTab()Tab取得使用者在文件中目前使用的 Tab
getAs(contentType)Blob將目前的 Document 內容擷取為指定類型的 blob。
getBlob()Blob以 blob 的形式擷取目前的 Document 內容。
getBody()Body擷取第一個分頁的 Body,或是針對繫結至文件的指令碼,擷取目前分頁的 DocumentBodySection
getBookmark(id)Bookmark取得第一個分頁中具有指定 ID 的 Bookmark,如果是與文件繫結的指令碼,則取得目前分頁。
getBookmarks()Bookmark[]取得第一個分頁中的所有 Bookmark 物件,或是與文件繫結的指令碼的目前分頁。
getCursor()Position取得使用者在有效分頁中的游標。
getEditors()User[]取得這個 Document 的編輯者清單。
getFooter()FooterSection擷取第一個分頁的頁尾部分,或是與文件繫結的指令碼的目前分頁頁尾部分。
getFootnotes()Footnote[]擷取第一個分頁主體中的所有 Footnote 元素,或是與文件繫結的指令碼的目前分頁主體。
getHeader()HeaderSection擷取第一個分頁的標題區段,或是與文件繫結的指令碼的目前分頁標題區段。
getId()String擷取文件的專屬 ID。
getLanguage()String取得文件的語言代碼。
getName()String擷取文件的標題。
getNamedRangeById(id)NamedRange取得第一個分頁中具有指定 ID 的 NamedRange,如果是與文件繫結的指令碼,則取得目前分頁。
getNamedRanges()NamedRange[]取得第一個分頁中的所有 NamedRange 物件,或是與文件繫結的指令碼的目前分頁。
getNamedRanges(name)NamedRange[]在第一個分頁中,或針對已繫結至文件的腳本,在有效分頁中,取得所有具有指定名稱的 NamedRange 物件。
getSelection()Range取得使用者在現用分頁中的選項。
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)Document將指定使用者從 Document 的編輯者清單中移除。
removeEditor(user)Document將指定使用者從 Document 的編輯者清單中移除。
removeViewer(emailAddress)Document將指定使用者從 Document 的觀眾和留言者名單中移除。
removeViewer(user)Document將指定使用者從 Document 的觀眾和留言者名單中移除。
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取得具有指定 ID 的 Bookmark
getBookmarks()Bookmark[]取得分頁中的所有 Bookmark 物件。
getFooter()FooterSection擷取分頁的頁尾部分 (如果有的話)。
getFootnotes()Footnote[]擷取分頁內文中的所有 Footnote 元素。
getHeader()HeaderSection擷取分頁的標頭區段 (如有)。
getNamedRangeById(id)NamedRange取得具有指定 ID 的 NamedRange
getNamedRanges()NamedRange[]取得分頁中的所有 NamedRange 物件。
getNamedRanges(name)NamedRange[]取得指定名稱分頁中的所有 NamedRange 物件。
newPosition(element, offset)Position建立新的 Position,這是對分頁中位置的參照,相對於特定元素。
newRange()RangeBuilder建立用於從分頁元素建構 Range 物件的建構工具。

Element

方法

方法傳回類型簡短說明
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()RichLink將目前元素傳回為 RichLink,例如 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_SECTIONEnum對應至 Body 元素的類型。
COMMENT_SECTIONEnum對應至 CommentSection 元素的類型。
DATEEnum對應至 Date 元素的類型。
EQUATIONEnum對應至 Equation 元素的類型。
EQUATION_FUNCTIONEnum對應至 EquationFunction 元素的類型。
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnum對應至 EquationFunctionArgumentSeparator 元素的類型。
EQUATION_SYMBOLEnum對應至 EquationSymbol 元素的類型。
RICH_LINKEnum對應至 RichLink 元素的類型。
FOOTER_SECTIONEnum對應至 FooterSection 元素的類型。
FOOTNOTEEnum對應至 Footnote 元素的類型。
FOOTNOTE_SECTIONEnum對應至 FootnoteSection 元素的類型。
HEADER_SECTIONEnum對應至 HeaderSection 元素的類型。
HORIZONTAL_RULEEnum對應至 HorizontalRule 元素的類型。
INLINE_DRAWINGEnum對應至 InlineDrawing 元素的類型。
INLINE_IMAGEEnum對應至 InlineImage 元素的類型。
LIST_ITEMEnum對應至 ListItem 元素的類型。
PAGE_BREAKEnum對應至 PageBreak 元素的類型。
PARAGRAPHEnum對應至 Paragraph 元素的類型。
PERSONEnum對應至 Person 元素的類型。
TABLEEnum對應至 Table 元素的類型。
TABLE_CELLEnum對應至 TableCell 元素的類型。
TABLE_OF_CONTENTSEnum對應至 TableOfContents 元素的類型。
TABLE_ROWEnum對應至 TableRow 元素的類型。
TEXTEnum對應至 Text 元素的類型。
UNSUPPORTEDEnum對應至 UnsupportedElement 的類型。

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右對齊選項。
JUSTIFYEnum對齊選項。

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 建立並插入新的 InlineImage 到這個 Position
insertText(text)Text在這個 Position 中插入指定的文字。

PositionedImage

方法

方法傳回類型簡短說明
getAs(contentType)Blob將此物件內的資料傳回為轉換為指定內容類型的 Blob。
getBlob()Blob將此物件內的資料以 blob 格式傳回。
getHeight()Integer擷取圖片的高度 (以像素為單位)。
getId()String取得圖片的 ID。
getLayout()PositionedLayout取得代表圖片排版方式的列舉值。
getLeftOffset()Number取得圖片相對於段落左側的偏移量 (以點為單位)。
getParagraph()Paragraph取得圖片固定的 Paragraph
getTopOffset()Number取得圖片相對於段落頂端的偏移量 (以點為單位)。
getWidth()Integer擷取圖片的寬度 (以像素為單位)。
setHeight(height)PositionedImage設定圖片的高度 (以像素為單位)。
setLayout(layout)PositionedImage設定圖片的版面配置方式。
setLeftOffset(offset)PositionedImage設定圖片相對於段落左側的偏移量 (以點為單位)。
setTopOffset(offset)PositionedImage設定圖片相對於段落頂端的偏移量 (以點為單位)。
setWidth(width)PositionedImage設定圖片的寬度,以像素為單位。

PositionedLayout

屬性

屬性類型說明
ABOVE_TEXTEnum圖片會顯示在文字上方。
BREAK_BOTHEnum圖片會將文字分散在左側和右側。
BREAK_LEFTEnum圖片會中斷左側的文字。
BREAK_RIGHTEnum圖片會破壞右側的文字。
WRAP_TEXTEnum圖片會被文字包圍。

Range

方法

方法傳回類型簡短說明
getRangeElements()RangeElement[]取得此 Range 中的所有元素,包括任何部分 Text 元素 (例如,如果選取範圍只包含 Text 元素的一部分)。

RangeBuilder

方法

方法傳回類型簡短說明
addElement(element)RangeBuilder將整個 Element 新增至這個 RangeBuilder
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilder在這個 RangeBuilder 中加入部分 Text 元素。
addElementsBetween(startElement, endElementInclusive)RangeBuilder將兩個完整元素和兩者之間的所有元素新增至這個 RangeBuilder
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilder將兩個部分 Text 元素和兩者之間的所有元素新增至 RangeBuilder
addRange(range)RangeBuilder將其他 Range 的內容新增至這個 RangeBuilder
build()Range根據套用至建構工具的設定,建構 Range
getRangeElements()RangeElement[]取得此 Range 中的所有元素,包括任何部分 Text 元素 (例如,如果選取範圍只包含 Text 元素的一部分)。

RangeElement

方法

方法傳回類型簡短說明
getElement()Element取得與此 RangeElement 對應的 Element
getEndOffsetInclusive()Integer取得範圍元素中部分範圍的結束位置。
getStartOffset()Integer取得範圍元素中部分範圍的起始位置。
isPartial()Boolean判斷此範圍元素是否涵蓋整個元素,或是元素字元部分選取範圍。

方法

方法傳回類型簡短說明
copy()RichLink傳回目前元素的已分離的深層副本。
getAttributes()Object擷取元素的屬性。
getMimeType()String傳回連結的 MIME 類型,如果項目是 Google 雲端硬碟檔案的連結,則可使用此類型,否則為 null
getNextSibling()Element擷取元素的下一個同層元素。
getParent()ContainerElement擷取元素的父項元素。
getPreviousSibling()Element擷取元素的上一個同胞元素。
getTitle()String傳回連結的顯示標題。
getType()ElementType擷取元素的 ElementType
getUrl()String傳回資源的網址。
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()RichLink將元素與相同類型的前一個同胞元素合併。
removeFromParent()RichLink從父項移除元素。
setAttributes(attributes)RichLink設定元素的屬性。

Tab

方法

方法傳回類型簡短說明
asDocumentTab()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搜尋指定類型子項的元素內容。
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靠上對齊選項。