Document Service

透過集合功能整理內容 你可以依據偏好儲存及分類內容。
文件

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

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

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

類別

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

Attribute

屬性

屬性類型說明
BACKGROUND_COLOREnum元素 (段落、表格等) 或文件的背景顏色。
BOLDEnumRTF 格式字型粗細設定。
BORDER_COLOREnum表格元素的邊框顏色。
BORDER_WIDTHEnum表格元素的邊框寬度 (單位為點)。
CODEEnum方程式元素的程式碼內容。
FONT_FAMILYEnumRTF 格式字型字型設定。
FONT_SIZEEnum適用於 RTF 格式的字型大小設定 (以點為單位)。
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_URLEnumRTF 格式的連結網址。
LIST_IDEnum清單項目元素的納入清單 ID。
MARGIN_BOTTOMEnum段落元素的下邊界設定。
MARGIN_LEFTEnum段落元素的左側邊界設定 (以點為單位)。
MARGIN_RIGHTEnum段落元素的右側邊界設定點。
MARGIN_TOPEnum段落元素的上邊界設定點。
NESTING_LEVELEnum適用於清單項目元素的項目巢狀層級。
MINIMUM_HEIGHTEnum表格列元素的最低高度設定 (以點為單位)。
PADDING_BOTTOMEnum表格儲存格元素的底部邊框間距設定 (單位為點)。
PADDING_LEFTEnum表格儲存格元素的左側邊框間距設定 (單位為點)。
PADDING_RIGHTEnum表格儲存格元素的右側邊框間距設定 (單位為點)。
PADDING_TOPEnum表格儲存格元素的頂部邊框間距設定 (以點為單位)。
PAGE_HEIGHTEnum文件的頁面高度,以點為單位。
PAGE_WIDTHEnum文件的頁面寬度設定點。
SPACING_AFTEREnum段落段落的底部間距設定。
SPACING_BEFOREEnum段落段落的間距上限設定。
STRIKETHROUGHEnum複合式摘要的刪除線設定。
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 在指定索引 blob 上建立並插入 InlineImage
insertImage(childIndex, image)InlineImage在指定的索引插入 InlineImage
insertListItem(childIndex, listItem)ListItem在指定的索引插入 ListItem
insertListItem(childIndex, text)ListItem建立包含指定文字內容的新 ListItem 並在當中插入指定索引。
insertPageBreak(childIndex)PageBreak在指定的索引中建立並插入新的 PageBreak
insertPageBreak(childIndex, pageBreak)PageBreak在指定的索引插入 PageBreak
insertParagraph(childIndex, paragraph)Paragraph在指定的索引插入 Paragraph
insertParagraph(childIndex, text)Paragraph建立包含指定文字內容的新 Paragraph 並在當中插入指定索引。
insertTable(childIndex)Table在指定的索引中建立並插入新的 Table
insertTable(childIndex, cells)Table依據指定索引建立並插入包含指定儲存格的新 Table
insertTable(childIndex, table)Table在指定的索引插入 Table
removeChild(child)Body移除指定的子元素。
replaceText(searchPattern, replacement)Element使用規則運算式將特定文字模式的所有出現情況替換為特定替代字串。
setAttributes(attributes)Body設定元素的屬性。
setHeadingAttributes(paragraphHeading, attributes)Body設定所提供 ParagraphHeading 的屬性。
setMarginBottom(marginBottom)Body設定下邊界。
setMarginLeft(marginLeft)Body設定左邊界,以點為單位。
setMarginRight(marginRight)Body設定起始邊界,以點為單位。
setMarginTop(marginTop)Body設定上邊界。
setPageHeight(pageHeight)Body設定網頁高度 (以點為單位)。
setPageWidth(pageWidth)Body設定網頁寬度 (以點為單位)。
setText(text)Body將內容設為純文字。
setTextAlignment(textAlignment)Body設定文字對齊方式。

Bookmark

方法

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

ContainerElement

方法

方法傳回類型簡短說明
asBody()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搜尋元素內容,尋找指定類型子系。
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傳回用於顯示值的日期's 語言代碼。
getNextSibling()Element擷取元素和下一個下一個同層級元素。
getParent()ContainerElement擷取元素的父項元素。
getPreviousSibling()Element擷取元素的先前同層級元素。
getTimestamp()Date傳回與日期相關聯的時間戳記。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()Date將元素與前相同類型的同層級合併。
removeFromParent()Date從父項中移除元素。
setAttributes(attributes)Date設定元素的屬性。

Document

方法

方法傳回類型簡短說明
addBookmark(position)Bookmark在指定的 Position 中新增 Bookmark
addEditor(emailAddress)Document將指定使用者新增至 Document 的編輯者清單。
addEditor(user)Document將指定使用者新增至 Document 的編輯者清單。
addEditors(emailAddresses)Document將指定使用者陣列新增至 Document 的編輯者清單。
addFooter()FooterSection新增文件頁尾部分 (如果不存在)。
addHeader()HeaderSection新增文件標頭部分 (如果不存在)。
addNamedRange(name, range)NamedRange新增 NamedRange,這是具有名稱和 ID 的 Range,以便之後擷取。
addViewer(emailAddress)Document將指定使用者新增至 Document 的檢視者清單中。
addViewer(user)Document將指定使用者新增至 Document 的檢視者清單中。
addViewers(emailAddresses)Document將指定使用者陣列新增至 Document 的檢視者清單。
getAs(contentType)Blob擷取指定 Document 內容作為指定類型的 blob。
getBlob()Blob將目前的 Document 內容擷取為 blob。
getBody()Body擷取使用中的文件Body
getBookmark(id)Bookmark取得具有指定 ID 的 Bookmark
getBookmarks()Bookmark[]取得文件中的所有 Bookmark 物件。
getCursor()Position於使用中的文件中取得使用者的遊標。
getEditors()User[]取得這個Document的編輯者清單。
getFooter()FooterSection擷取文件的頁尾部分 (如果有的話)。
getFootnotes()Footnote[]擷取文件內文中的所有 Footnote 元素。
getHeader()HeaderSection擷取文件的標頭部分 (如果有的話)。
getId()String擷取文件的專屬 ID。
getLanguage()String取得文件的語言代碼。
getName()String擷取文件標題。
getNamedRangeById(id)NamedRange取得具有指定 ID 的 NamedRange
getNamedRanges()NamedRange[]取得文件中的所有 NamedRange 物件。
getNamedRanges(name)NamedRange[]取得具有指定名稱的文件中的所有 NamedRange 物件。
getSelection()Range讓使用者在有效文件中選取他們。
getSupportedLanguageCodes()String[]取得 Google 文件檔案支援的所有語言代碼。
getUrl()String擷取網址,以便存取目前的文件。
getViewers()User[]取得這個Document的檢視者和加註者清單。
newPosition(element, offset)Position建立新的 Position,以便參照特定元素中相對於特定位置的位置。
newRange()RangeBuilder建立用來從文件元素建構 Range 物件的建構工具。
removeEditor(emailAddress)DocumentDocument 的編輯者清單中移除指定使用者。
removeEditor(user)DocumentDocument 的編輯者清單中移除指定使用者。
removeViewer(emailAddress)DocumentDocument 的檢視者和加註者清單中移除指定使用者。
removeViewer(user)DocumentDocument 的檢視者和加註者清單中移除指定使用者。
saveAndClose()void儲存目前的 Document
setCursor(position)Document設定 Position 時,使用者會在有效文件中設定遊標。
setLanguage(languageCode)Document設定文件的語言代碼。
setName(name)Document設定文件標題。
setSelection(range)Document設定指定文件 Range 的使用者在文件中的選取項目。

DocumentApp

屬性

屬性類型說明
AttributeAttributeAttribute 列舉。
ElementTypeElementTypeElementType 列舉。
FontFamilyFontFamilyFontFamily 列舉。
GlyphTypeGlyphTypeGlyphType 列舉。
HorizontalAlignmentHorizontalAlignmentHorizontalAlignment 列舉。
ParagraphHeadingParagraphHeadingParagraphHeading 列舉。
PositionedLayoutPositionedLayoutPositionedLayout 列舉。
TextAlignmentTextAlignmentTextAlignment 列舉。
VerticalAlignmentVerticalAlignmentVerticalAlignment 列舉。

方法

方法傳回類型簡短說明
create(name)Document建立及傳回新文件。
getActiveDocument()Document傳回指令碼與容器繫結的文件。
getUi()Ui傳回文件的使用者介面環境執行個體,允許指令碼新增選單、對話方塊和側欄等功能。
openById(id)Document傳回含有指定 ID 的文件。
openByUrl(url)Document用於開啟及傳回含有指定網址的文件。

Element

方法

方法傳回類型簡短說明
asBody()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傳回目前元素的 RichLink,例如 Google 試算表檔案連結。
asTable()Table將目前元素做為 Table 傳回。
asTableCell()TableCell將目前元素做為 TableCell 傳回。
asTableOfContents()TableOfContents將目前元素做為 TableOfContents 傳回。
asTableRow()TableRow將目前元素做為 TableRow 傳回。
asText()Text將目前元素做為 Text 傳回。
copy()Element傳回目前元素的卸離深層連結。
getAttributes()Object擷取元素的屬性。
getNextSibling()Element擷取元素和下一個下一個同層級元素。
getParent()ContainerElement擷取元素的父項元素。
getPreviousSibling()Element擷取元素的先前同層級元素。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()Element將元素與前相同類型的同層級合併。
removeFromParent()Element從父項中移除元素。
setAttributes(attributes)Element設定元素的屬性。

ElementType

屬性

屬性類型說明
BODY_SECTIONEnumBody 元素對應的類型。
COMMENT_SECTIONEnumCommentSection 元素對應的類型。
DATEEnumDate 元素對應的類型。
DOCUMENTEnum與文件根目錄對應的類型。
EQUATIONEnumEquation 元素對應的類型。
EQUATION_FUNCTIONEnumEquationFunction 元素對應的類型。
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumEquationFunctionArgumentSeparator 元素對應的類型。
EQUATION_SYMBOLEnumEquationSymbol 元素對應的類型。
RICH_LINKEnumRichLink 元素對應的類型。
FOOTER_SECTIONEnumFooterSection 元素對應的類型。
FOOTNOTEEnumFootnote 元素對應的類型。
FOOTNOTE_SECTIONEnumFootnoteSection 元素對應的類型。
HEADER_SECTIONEnumHeaderSection 元素對應的類型。
HORIZONTAL_RULEEnumHorizontalRule 元素對應的類型。
INLINE_DRAWINGEnumInlineDrawing 元素對應的類型。
INLINE_IMAGEEnumInlineImage 元素對應的類型。
LIST_ITEMEnumListItem 元素對應的類型。
PAGE_BREAKEnumPageBreak 元素對應的類型。
PARAGRAPHEnumParagraph 元素對應的類型。
PERSONEnumPerson 元素對應的類型。
TABLEEnumTable 元素對應的類型。
TABLE_CELLEnumTableCell 元素對應的類型。
TABLE_OF_CONTENTSEnumTableOfContents 元素對應的類型。
TABLE_ROWEnumTableRow 元素對應的類型。
TEXTEnumText 元素對應的類型。
UNSUPPORTEDEnumUnsupportedElement 對應的類型。

Equation

方法

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

EquationFunction

方法

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

EquationFunctionArgumentSeparator

方法

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

EquationSymbol

方法

方法傳回類型簡短說明
copy()EquationSymbol傳回目前元素的卸離深層連結。
getAttributes()Object擷取元素的屬性。
getCode()String擷取與方程式符號對應的程式碼。
getNextSibling()Element擷取元素和下一個下一個同層級元素。
getParent()ContainerElement擷取元素的父項元素。
getPreviousSibling()Element擷取元素的先前同層級元素。
getType()ElementType擷取元素的 ElementType
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()EquationSymbol將元素與前相同類型的同層級合併。
removeFromParent()EquationSymbol從父項中移除元素。
setAttributes(attributes)EquationSymbol設定元素的屬性。

FontFamily

FooterSection

方法

方法傳回類型簡短說明
appendHorizontalRule()HorizontalRule建立並附加新的 HorizontalRule
appendImage(image)InlineImage從指定的圖片 blob 建立及附加新的 InlineImage
appendImage(image)InlineImage附加指定的 InlineImage
appendListItem(listItem)ListItem附加指定的 ListItem
appendListItem(text)ListItem建立並附加包含指定文字內容的新 ListItem
appendParagraph(paragraph)Paragraph附加指定的 Paragraph
appendParagraph(text)Paragraph建立並附加包含指定文字內容的新 Paragraph
appendTable()Table建立並附加新的 Table
appendTable(cells)Table附加至每個指定字串值含有 TableCell 的新 Table
appendTable(table)Table附加指定的 Table
clear()FooterSection清除元素的內容。
copy()FooterSection傳回目前元素的卸離深層連結。
editAsText()Text取得目前元素的 Text 版本以進行編輯。
findElement(elementType)RangeElement搜尋元素內容,尋找指定類型子系。
findElement(elementType, from)RangeElement從指定內容的 RangeElement 開始搜尋元素內容的子系。
findText(searchPattern)RangeElement使用規則運算式搜尋元素中的文字內容。
findText(searchPattern, from)RangeElement從指定搜尋結果中,搜尋指定文字模式的元素內容。
getAttributes()Object擷取元素的屬性。
getChild(childIndex)Element擷取指定子項索引的子元素。
getChildIndex(child)Integer擷取指定子元素的子索引。
getImages()InlineImage[]擷取區段包含的所有 InlineImages
getListItems()ListItem[]擷取區段包含的所有 ListItems
getNumChildren()Integer擷取子項數量。
getParagraphs()Paragraph[]擷取區段包含的所有 Paragraphs (包括 ListItems)。
getParent()ContainerElement擷取元素的父項元素。
getTables()Table[]擷取區段包含的所有 Tables
getText()String以文字字串的形式擷取元素內容。
getTextAlignment()TextAlignment取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
insertHorizontalRule(childIndex)HorizontalRule在指定的索引中建立並插入新的 HorizontalRule
insertImage(childIndex, image)InlineImage透過指定的索引 blob 在指定索引 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 在指定索引 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 在這個 Position 中插入並插入新的 InlineImage
insertText(text)Text在這個 Position 插入指定文字。

PositionedImage

方法

方法傳回類型簡短說明
getAs(contentType)Blob傳回此物件中的資料,以轉換為指定內容類型的 blob。
getBlob()Blob傳回這個物件中的資料,以 blob 形式傳回。
getHeight()Integer擷取圖片的高度 (以像素為單位)。
getId()String取得圖片 ID。
getLayout()PositionedLayout取得表示圖片版面配置方式的列舉值。
getLeftOffset()Number從段落左側取得圖片的偏移值 (以點為單位)。
getParagraph()Paragraph取得錨定圖片的 Paragraph
getTopOffset()Number從段落到圖片的頂點取得圖片的偏移 (以點為單位)。
getWidth()Integer擷取圖片的寬度 (以像素為單位)。
setHeight(height)PositionedImage設定圖片的高度 (以像素為單位)。
setLayout(layout)PositionedImage設定圖片的版面配置方式。
setLeftOffset(offset)PositionedImage設定圖片段落的起始位置,單位為點。
setTopOffset(offset)PositionedImage設定從段落頂端開始調整圖片的偏移值。
setWidth(width)PositionedImage設定圖片的寬度 (以像素為單位)。

PositionedLayout

屬性

屬性類型說明
ABOVE_TEXTEnum圖片位於文字上方,
BREAK_BOTHEnum圖片會破壞左側和右側的文字。
BREAK_LEFTEnum圖片會破壞左側文字。
BREAK_RIGHTEnum圖片會使右側文字損毀。
WRAP_TEXTEnum圖片是以文字包裝。

Range

方法

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

RangeBuilder

方法

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

RangeElement

方法

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

方法

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

Table

方法

方法傳回類型簡短說明
appendTableRow()TableRow建立並附加新的 TableRow
appendTableRow(tableRow)TableRow附加指定的 TableRow
clear()Table清除元素的內容。
copy()Table傳回目前元素的卸離深層連結。
editAsText()Text取得目前元素的 Text 版本以進行編輯。
findElement(elementType)RangeElement搜尋元素內容,尋找指定類型子系。
findElement(elementType, from)RangeElement從指定內容的 RangeElement 開始搜尋元素內容的子系。
findText(searchPattern)RangeElement使用規則運算式搜尋元素中的文字內容。
findText(searchPattern, from)RangeElement從指定搜尋結果中,搜尋指定文字模式的元素內容。
getAttributes()Object擷取元素的屬性。
getBorderColor()String擷取邊框顏色。
getBorderWidth()Number擷取點寬度 (以點為單位)。
getCell(rowIndex, cellIndex)TableCell在指定列和儲存格索引擷取 TableCell
getChild(childIndex)Element擷取指定子項索引的子元素。
getChildIndex(child)Integer擷取指定子元素的子索引。
getColumnWidth(columnIndex)Number擷取指定的表格欄寬度,以點為單位。
getLinkUrl()String擷取連結網址。
getNextSibling()Element擷取元素和下一個下一個同層級元素。
getNumChildren()Integer擷取子項數量。
getNumRows()Integer擷取 TableRows 的數量。
getParent()ContainerElement擷取元素的父項元素。
getPreviousSibling()Element擷取元素的先前同層級元素。
getRow(rowIndex)TableRow在指定列索引擷取 TableRow
getText()String以文字字串的形式擷取元素內容。
getTextAlignment()TextAlignment取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
insertTableRow(childIndex)TableRow在指定的索引中建立並插入新的 TableRow
insertTableRow(childIndex, tableRow)TableRow在指定的索引插入 TableRow
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
removeChild(child)Table移除指定的子元素。
removeFromParent()Table從父項中移除元素。
removeRow(rowIndex)TableRow移除指定列索引的 TableRow
replaceText(searchPattern, replacement)Element使用規則運算式將特定文字模式的所有出現情況替換為特定替代字串。
setAttributes(attributes)Table設定元素的屬性。
setBorderColor(color)Table設定框線顏色。
setBorderWidth(width)Table設定框線寬度 (單位為點)。
setColumnWidth(columnIndex, width)Table設定指定欄的寬度,以點為單位。
setLinkUrl(url)Table設定連結網址。
setTextAlignment(textAlignment)Table設定文字對齊方式。

TableCell

方法

方法傳回類型簡短說明
appendHorizontalRule()HorizontalRule建立並附加新的 HorizontalRule
appendImage(image)InlineImage從指定的圖片 blob 建立及附加新的 InlineImage
appendImage(image)InlineImage附加指定的 InlineImage
appendListItem(listItem)ListItem附加指定的 ListItem
appendListItem(text)ListItem建立並附加新的 ListItem
appendParagraph(paragraph)Paragraph附加指定的 Paragraph
appendParagraph(text)Paragraph建立並附加新的 Paragraph
appendTable()Table建立並附加新的 Table
appendTable(cells)Table附加包含指定儲存格的新 Table
appendTable(table)Table附加指定的 Table
clear()TableCell清除元素的內容。
copy()TableCell傳回目前元素的卸離深層連結。
editAsText()Text取得目前元素的 Text 版本以進行編輯。
findElement(elementType)RangeElement搜尋元素內容,尋找指定類型子系。
findElement(elementType, from)RangeElement從指定內容的 RangeElement 開始搜尋元素內容的子系。
findText(searchPattern)RangeElement使用規則運算式搜尋元素中的文字內容。
findText(searchPattern, from)RangeElement從指定搜尋結果中,搜尋指定文字模式的元素內容。
getAttributes()Object擷取元素的屬性。
getBackgroundColor()String擷取背景顏色。
getChild(childIndex)Element擷取指定子項索引的子元素。
getChildIndex(child)Integer擷取指定子元素的子索引。
getColSpan()Integer擷取欄時距,也就是這個儲存格橫跨的表格儲存格的欄數。
getLinkUrl()String擷取連結網址。
getNextSibling()Element擷取元素和下一個下一個同層級元素。
getNumChildren()Integer擷取子項數量。
getPaddingBottom()Number擷取起始點,以點為單位。
getPaddingLeft()Number擷取起始點,顯示起始點。
getPaddingRight()Number擷取適當的邊框間距。
getPaddingTop()Number擷取起始點,以點為單位。
getParent()ContainerElement擷取元素的父項元素。
getParentRow()TableRow擷取包含目前 TableCellTableRow
getParentTable()Table擷取包含目前 TableCellTable
getPreviousSibling()Element擷取元素的先前同層級元素。
getRowSpan()Integer擷取列時距,這個儲存格是此儲存格跨越的表格儲存格列數。
getText()String以文字字串的形式擷取元素內容。
getTextAlignment()TextAlignment取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
getVerticalAlignment()VerticalAlignment擷取 VerticalAlignment
getWidth()Number擷取包含儲存格的欄寬,點。
insertHorizontalRule(childIndex)HorizontalRule在指定的索引中建立並插入新的 HorizontalRule
insertImage(childIndex, image)InlineImage透過指定的索引 blob 在指定索引 blob 上建立並插入 InlineImage
insertImage(childIndex, image)InlineImage在指定的索引插入 InlineImage
insertListItem(childIndex, listItem)ListItem在指定的索引插入 ListItem
insertListItem(childIndex, text)ListItem在指定的索引中建立並插入新的 ListItem
insertParagraph(childIndex, paragraph)Paragraph在指定的索引插入 Paragraph
insertParagraph(childIndex, text)Paragraph在指定的索引中建立並插入新的 Paragraph
insertTable(childIndex)Table在指定的索引中建立並插入新的 Table
insertTable(childIndex, cells)Table依據指定索引建立並插入包含指定儲存格的新 Table
insertTable(childIndex, table)Table在指定的索引插入 Table
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()TableCell將元素與前相同類型的同層級合併。
removeChild(child)TableCell移除指定的子元素。
removeFromParent()TableCell從父項中移除元素。
replaceText(searchPattern, replacement)Element使用規則運算式將特定文字模式的所有出現情況替換為特定替代字串。
setAttributes(attributes)TableCell設定元素的屬性。
setBackgroundColor(color)TableCell設定背景顏色。
setLinkUrl(url)TableCell設定連結網址。
setPaddingBottom(paddingBottom)TableCell設定底部邊框間距 (以點為單位)。
setPaddingLeft(paddingLeft)TableCell設定左側邊框間距 (以點為單位)。
setPaddingRight(paddingTop)TableCell設定起始點,以點為單位。
setPaddingTop(paddingTop)TableCell設定頂端邊框間距 (以點為單位)。
setText(text)TableCell將內容設為純文字。
setTextAlignment(textAlignment)TableCell設定文字對齊方式。
setVerticalAlignment(alignment)TableCell設定垂直對齊。
setWidth(width)TableCell設定包含目前儲存格的欄寬,以點為單位。

TableOfContents

方法

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

TableRow

方法

方法傳回類型簡短說明
appendTableCell()TableCell建立並附加新的 TableCell
appendTableCell(textContents)TableCell附加含有指定文字的指定 TableCell
appendTableCell(tableCell)TableCell附加指定的 TableCell
clear()TableRow清除元素的內容。
copy()TableRow傳回目前元素的卸離深層連結。
editAsText()Text取得目前元素的 Text 版本以進行編輯。
findElement(elementType)RangeElement搜尋元素內容,尋找指定類型子系。
findElement(elementType, from)RangeElement從指定內容的 RangeElement 開始搜尋元素內容的子系。
findText(searchPattern)RangeElement使用規則運算式搜尋元素中的文字內容。
findText(searchPattern, from)RangeElement從指定搜尋結果中,搜尋指定文字模式的元素內容。
getAttributes()Object擷取元素的屬性。
getCell(cellIndex)TableCell擷取指定儲存格索引的 TableCell
getChild(childIndex)Element擷取指定子項索引的子元素。
getChildIndex(child)Integer擷取指定子元素的子索引。
getLinkUrl()String擷取連結網址。
getMinimumHeight()Number擷取起始高度下限。
getNextSibling()Element擷取元素和下一個下一個同層級元素。
getNumCells()Integer擷取資料列中的儲存格數量。
getNumChildren()Integer擷取子項數量。
getParent()ContainerElement擷取元素的父項元素。
getParentTable()Table擷取包含目前資料列的 Table
getPreviousSibling()Element擷取元素的先前同層級元素。
getText()String以文字字串的形式擷取元素內容。
getTextAlignment()TextAlignment取得文字對齊方式。
getType()ElementType擷取元素的 ElementType
insertTableCell(childIndex)TableCell在指定的索引中建立並插入新的 TableCell
insertTableCell(childIndex, textContents)TableCell將包含指定文字的指定 TableCell 插入指定的索引。
insertTableCell(childIndex, tableCell)TableCell在指定的索引插入 TableCell
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
merge()TableRow將元素與前相同類型的同層級合併。
removeCell(cellIndex)TableCell移除指定儲存格索引的 TableCell
removeChild(child)TableRow移除指定的子元素。
removeFromParent()TableRow從父項中移除元素。
replaceText(searchPattern, replacement)Element使用規則運算式將特定文字模式的所有出現情況替換為特定替代字串。
setAttributes(attributes)TableRow設定元素的屬性。
setLinkUrl(url)TableRow設定連結網址。
setMinimumHeight(minHeight)TableRow設定最小高度 (以點為單位)。
setTextAlignment(textAlignment)TableRow設定文字對齊方式。

Text

方法

方法傳回類型簡短說明
appendText(text)Text將指定文字新增至這個文字區域的結尾。
copy()Text傳回目前元素的卸離深層連結。
deleteText(startOffset, endOffsetInclusive)Text刪除特定文字範圍。
editAsText()Text取得目前元素的 Text 版本以進行編輯。
findText(searchPattern)RangeElement使用規則運算式搜尋元素中的文字內容。
findText(searchPattern, from)RangeElement從指定搜尋結果中,搜尋指定文字模式的元素內容。
getAttributes()Object擷取元素的屬性。
getAttributes(offset)Object擷取指定字元偏移的屬性。
getBackgroundColor()String擷取背景顏色設定。
getBackgroundColor(offset)String擷取指定字元偏移的背景顏色。
getFontFamily()String擷取字型系列設定。
getFontFamily(offset)String擷取指定字元偏移的字型系列。
getFontSize()Number擷取字型大小設定。
getFontSize(offset)Number擷取指定字元偏移的字型大小。
getForegroundColor()String擷取前景色彩設定。
getForegroundColor(offset)String擷取指定字元偏移時的前景顏色。
getLinkUrl()String擷取連結網址。
getLinkUrl(offset)String擷取指定字元偏移的連結網址。
getNextSibling()Element擷取元素和下一個下一個同層級元素。
getParent()ContainerElement擷取元素的父項元素。
getPreviousSibling()Element擷取元素的先前同層級元素。
getText()String以文字字串的形式擷取元素內容。
getTextAlignment()TextAlignment取得文字對齊方式。
getTextAlignment(offset)TextAlignment取得單一字元的文字對齊方式。
getTextAttributeIndices()Integer[]擷取一組與不同文字格式設定執行作業開始的文字索引。
getType()ElementType擷取元素的 ElementType
insertText(offset, text)Text依據指定的字元偏移插入指定文字。
isAtDocumentEnd()Boolean判斷元素是否位於 Document 的結尾。
isBold()Boolean擷取粗體設定。
isBold(offset)Boolean擷取指定字元偏移時的粗體設定。
isItalic()Boolean擷取斜體設定。
isItalic(offset)Boolean擷取指定字元偏移的斜體設定。
isStrikethrough()Boolean擷取刪除線設定。
isStrikethrough(offset)Boolean擷取指定字元偏移時的刪除線設定。
isUnderline()Boolean擷取底線設定。
isUnderline(offset)Boolean擷取指定字元偏移的底線設定。
merge()Text將元素與前相同類型的同層級合併。
removeFromParent()Text從父項中移除元素。
replaceText(searchPattern, replacement)Element使用規則運算式將特定文字模式的所有出現情況替換為特定替代字串。
setAttributes(startOffset, endOffsetInclusive, attributes)Text將指定的屬性套用至指定的字元範圍。
setAttributes(attributes)Text設定元素的屬性。
setBackgroundColor(startOffset, endOffsetInclusive, color)Text設定指定字元範圍的背景顏色。
setBackgroundColor(color)Text設定背景顏色。
setBold(bold)Text套用粗體設定。
setBold(startOffset, endOffsetInclusive, bold)Text設定指定字元範圍的粗體設定。
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)Text設定指定半形字元的字型系列。
setFontFamily(fontFamilyName)Text設定字型系列。
setFontSize(startOffset, endOffsetInclusive, size)Text設定指定半形字元的字型大小。
setFontSize(size)Text設定字型大小。
setForegroundColor(startOffset, endOffsetInclusive, color)Text設定指定字元範圍的前景顏色。
setForegroundColor(color)Text設定前景顏色。
setItalic(italic)Text設定斜體設定。
setItalic(startOffset, endOffsetInclusive, italic)Text用於設定指定字元範圍的斜體設定。
setLinkUrl(startOffset, endOffsetInclusive, url)Text設定指定字元範圍的連結網址。
setLinkUrl(url)Text設定連結網址。
setStrikethrough(strikethrough)Text設定刪除線設定。
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)Text設定指定字元範圍的刪除線設定。
setText(text)Text設定文字內容。
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)Text設定指定半形字元的文字對齊方式。
setTextAlignment(textAlignment)Text設定文字對齊方式。
setUnderline(underline)Text設定底線設定。
setUnderline(startOffset, endOffsetInclusive, underline)Text設定指定半形字元範圍的底線設定。

TextAlignment

屬性

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

UnsupportedElement

方法

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

VerticalAlignment

屬性

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