這項服務允許指令碼建立、存取及修改 Google 文件檔案。
// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID');
// Create and open a document.
doc = DocumentApp.create('Document Name');
類別
名稱 | 簡短說明 |
---|---|
Attribute | 元素屬性的列舉。 |
Body | Google 文件分頁內容。 |
Bookmark | 代表書籤的物件。 |
ContainerElement | 可包含其他元素的一般元素。 |
Date | 表示格式化日期的元素 |
Document | 文件,內含一或多個 Tab 物件,每個物件都含有 RTF 格式和
元素,例如表格和清單。 |
DocumentApp | 文件服務會建立並開啟可編輯的「Documents 」。 |
DocumentTab | 文件分頁,包含 RTF 格式和元素 (例如表格和清單)。 |
Element | 一般元素。 |
ElementType | 所有元素類型的列舉。 |
Equation | 代表數學運算式的元素。 |
EquationFunction | 代表數學 Equation 中函式的元素。 |
EquationFunctionArgumentSeparator | 代表數學 Equation 中函式分隔符的元素。 |
EquationSymbol | 代表數學 Equation 中符號的元素。 |
| 列舉支援的字型。 |
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 影片。 |
Tab | Google 文件中的分頁。 |
TabType | 所有分頁類型的列舉。 |
Table | 代表資料表的元素。 |
TableCell | 代表表格儲存格的元素。 |
TableOfContents | 包含目錄的元素。 |
TableRow | 代表表格列的元素。 |
Text | 代表 RTF 格式區域的元素。 |
TextAlignment | 文字對齊類型類型的列舉。 |
UnsupportedElement | 元素代表區域不明或不受指令碼影響的區域,例如 頁碼。 |
VerticalAlignment | 列舉支援的垂直對齊類型。 |
Attribute
屬性
屬性 | 類型 | 說明 |
---|---|---|
BACKGROUND_COLOR | Enum | 元素 (段落、表格等) 或文件的背景顏色。 |
BOLD | Enum | RTF 格式的字型粗細設定。 |
BORDER_COLOR | Enum | 表格元素的邊框顏色。 |
BORDER_WIDTH | Enum | 表格元素的框線寬度 (以點為單位)。 |
CODE | Enum | 方程式元素的程式碼內容。 |
FONT_FAMILY | Enum | 字型系列設定,適用於 RTF 格式。 |
FONT_SIZE | Enum | RTF 格式的字型大小設定。 |
FOREGROUND_COLOR | Enum | RTF 格式的前景顏色設定。 |
HEADING | Enum | 段落元素的標題類型 (例如 DocumentApp.ParagraphHeading.HEADING1 )。 |
HEIGHT | Enum | 圖片元素的高度設定。 |
HORIZONTAL_ALIGNMENT | Enum | 段落元素的水平對齊方式 (例如 DocumentApp.HorizontalAlignment.CENTER )。 |
INDENT_END | Enum | 段落元素的結束縮排設定。 |
INDENT_FIRST_LINE | Enum | 第一行縮排設定 (指向段落元素)。 |
INDENT_START | Enum | 段落元素起始縮排設定 (以點表示)。 |
ITALIC | Enum | RTF 字型的字型樣式設定。 |
GLYPH_TYPE | Enum | 清單項目元素的字符類型。 |
LEFT_TO_RIGHT | Enum | RTF 格式的文字方向設定。 |
LINE_SPACING | Enum | 將行距設定為調節係數 (適用於段落元素) 的行距設定。 |
LINK_URL | Enum | 使用 RTF 格式的連結網址。 |
LIST_ID | Enum | 所屬清單的 ID,供清單項目元素使用。 |
MARGIN_BOTTOM | Enum | 點的下邊界設定,適用於段落元素。 |
MARGIN_LEFT | Enum | 點的左邊界設定,適用於段落元素。 |
MARGIN_RIGHT | Enum | 點的右側邊界設定,適用於段落元素。 |
MARGIN_TOP | Enum | 點的上邊界設定,適用於段落元素。 |
NESTING_LEVEL | Enum | 清單項目元素的項目巢狀層級。 |
MINIMUM_HEIGHT | Enum | 表格列元素的最小高度設定 (以點為單位)。 |
PADDING_BOTTOM | Enum | 表格儲存格元素的底部邊框間距設定。 |
PADDING_LEFT | Enum | 表格儲存格元素的左側邊框間距設定。 |
PADDING_RIGHT | Enum | 點的右側邊框間距設定,適用於表格儲存格元素。 |
PADDING_TOP | Enum | 點的頂部邊框間距設定,適用於表格儲存格元素。 |
PAGE_HEIGHT | Enum | 文件的頁面高度 (以點為單位)。 |
PAGE_WIDTH | Enum | 文件的頁面寬度設定 (以點為單位)。 |
SPACING_AFTER | Enum | 段落元素的底部間距設定 (適用於段落元素)。 |
SPACING_BEFORE | Enum | 段落元素的上間距設定 (以點為單位)。 |
STRIKETHROUGH | Enum | 「刪除」設定,適用於 RTF 格式文字。 |
UNDERLINE | Enum | 底線設定 (適用於 RTF 格式)。 |
VERTICAL_ALIGNMENT | Enum | 表格儲存格元素的垂直對齊設定。 |
WIDTH | Enum | 表格儲存格和圖片元素的寬度設定。 |
Body
方法
Bookmark
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getId() | String | 取得 Bookmark 的 ID。 |
getPosition() | Position | 取得 DocumentTab 中 Bookmark 的 Position 。 |
remove() | void | 刪除 Bookmark 。 |
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
Document 類別可用來直接存取及修改文字內容的方法是在使用中分頁 (指令碼「繫結」至特定文件的指令碼) 或第一個分頁 (如果無法使用有效的分頁) 上運作。採用這些方法 (例如 Document.getBody()
) 的指令碼可以更新為以下其中一種方式:
- 使用第一個分頁:
Document.getTabs()[0].asDocumentTab().getBody()
- 使用所有分頁:使用
Document.getTabs()
和Tab.getChildTabs()
穿越分頁樹狀結構。針對樹狀結構中的每個分頁呼叫Tab.asDocumentTab().getBody()
- 使用所選分頁:
Document.getTabs()[Document.getActiveTab().getId()].asDocumentTab().getBody()
- 注意:如果指令碼未使用
Document.setActiveTab(tabId)
設定使用中的分頁,就會擲回錯誤 - 使用特定分頁:
Document.getTab(TAB_ID).asDocumentTab().getBody()
如要進一步瞭解分頁功能,請參閱「使用分頁」。
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
addBookmark(position) | Bookmark | 將 Bookmark 新增至第一個標籤Position 至第一個標籤,針對
文件「繫結」至文件、使用中的分頁。 |
addEditor(emailAddress) | Document | 將特定使用者新增至 Document 的編輯者清單。 |
addEditor(user) | Document | 將特定使用者新增至 Document 的編輯者清單。 |
addEditors(emailAddresses) | Document | 將指定的使用者陣列新增至 Document 的編輯者清單。 |
addFooter() | FooterSection | 將頁尾區段 (如果有的話) 新增至第一個分頁;針對由文件「綁定」文件的指令碼,使用中的分頁新增。 |
addHeader() | HeaderSection | 將標頭區段 (如果有的話) 新增至第一個分頁;針對由「綁定」文件的指令碼 (使用中的分頁) 新增標頭區段。 |
addNamedRange(name, range) | NamedRange | 新增 NamedRange ,這是一個有名稱和 ID 的 Range
之後在第一個分頁中擷取;如果是與文件「繫結」至文件的指令碼,則擷取使用中的分頁。 |
addViewer(emailAddress) | Document | 將特定使用者新增至 Document 的檢視者清單。 |
addViewer(user) | Document | 將特定使用者新增至 Document 的檢視者清單。 |
addViewers(emailAddresses) | Document | 將指定的使用者陣列新增至 Document 的檢視者清單。 |
getActiveTab() | Tab | 在文件中取得使用者目前有效的 Tab 。 |
getAs(contentType) | Blob | 擷取目前的 Document 內容,做為指定類型的 blob。 |
getBlob() | Blob | 將目前的 Document 內容擷取為 blob。 |
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
屬性
屬性 | 類型 | 說明 |
---|---|---|
Attribute | Attribute | Attribute 列舉。 |
ElementType | ElementType | ElementType 列舉。 |
FontFamily |
| 列舉。 |
GlyphType | GlyphType | GlyphType 列舉。 |
HorizontalAlignment | HorizontalAlignment | HorizontalAlignment 列舉。 |
ParagraphHeading | ParagraphHeading | ParagraphHeading 列舉。 |
PositionedLayout | PositionedLayout | PositionedLayout 列舉。 |
TextAlignment | TextAlignment | TextAlignment 列舉。 |
VerticalAlignment | VerticalAlignment | VerticalAlignment 列舉。 |
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
create(name) | Document | 建立並傳回新文件。 |
getActiveDocument() | Document | 傳回指令碼位於 container-bound 的文件。 |
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
方法
ElementType
屬性
屬性 | 類型 | 說明 |
---|---|---|
BODY_SECTION | Enum | 與 Body 元素的對應類型。 |
COMMENT_SECTION | Enum | 與 元素的對應類型。 |
DATE | Enum | 與 Date 對應的類型
元素。 |
EQUATION | Enum | 與 Equation 元素的對應類型。 |
EQUATION_FUNCTION | Enum | 與 EquationFunction 元素的對應類型。 |
EQUATION_FUNCTION_ARGUMENT_SEPARATOR | Enum | 與 EquationFunctionArgumentSeparator 對應的類型
元素。 |
EQUATION_SYMBOL | Enum | 與 EquationSymbol 元素的對應類型。 |
RICH_LINK | Enum | 與 RichLink 元素的對應類型。 |
FOOTER_SECTION | Enum | 與 FooterSection 元素的對應類型。 |
FOOTNOTE | Enum | 與 Footnote 元素的對應類型。 |
FOOTNOTE_SECTION | Enum | 與 FootnoteSection 元素的對應類型。 |
HEADER_SECTION | Enum | 與 HeaderSection 元素的對應類型。 |
HORIZONTAL_RULE | Enum | 與 HorizontalRule 元素的對應類型。 |
INLINE_DRAWING | Enum | 與 InlineDrawing 元素的對應類型。 |
INLINE_IMAGE | Enum | 與 InlineImage 元素的對應類型。 |
LIST_ITEM | Enum | 與 ListItem 元素的對應類型。 |
PAGE_BREAK | Enum | 與 PageBreak 元素的對應類型。 |
PARAGRAPH | Enum | 與 Paragraph 元素的對應類型。 |
PERSON | Enum | 與 Person 元素的對應類型。 |
TABLE | Enum | 與 Table 元素的對應類型。 |
TABLE_CELL | Enum | 與 TableCell 元素的對應類型。 |
TABLE_OF_CONTENTS | Enum | 與 TableOfContents 元素的對應類型。 |
TABLE_ROW | Enum | 與 TableRow 元素的對應類型。 |
TEXT | Enum | 與 Text 對應的類型
元素。 |
UNSUPPORTED | Enum | 與 UnsupportedElement 對應的類型。 |
Equation
方法
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
方法
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
方法
GlyphType
屬性
屬性 | 類型 | 說明 |
---|---|---|
BULLET | Enum | 預設的項目符號、圓形和實心。 |
HOLLOW_BULLET | Enum | 空項目符號。 |
SQUARE_BULLET | Enum | 方形項目符號。 |
NUMBER | Enum | 條列式編號。 |
LATIN_UPPER | Enum | 大寫拉丁字母項目符號。 |
LATIN_LOWER | Enum | 小寫拉丁字母項目符號。 |
ROMAN_UPPER | Enum | 羅馬數字項目符號,大寫。 |
ROMAN_LOWER | Enum | 羅馬數字、小寫項目符號。 |
HeaderSection
方法
HorizontalAlignment
屬性
屬性 | 類型 | 說明 |
---|---|---|
LEFT | Enum | 靠左對齊選項。 |
CENTER | Enum | 置中對齊選項。 |
RIGHT | Enum | 靠右對齊選項。 |
JUSTIFY | Enum | 左右對齊選項。 |
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 的形式傳回這個物件中的資料,做為轉換成指定內容類型的 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
方法
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
方法
ParagraphHeading
屬性
屬性 | 類型 | 說明 |
---|---|---|
NORMAL | Enum | 一般文字的標題選項。 |
HEADING1 | Enum | 最高標題選項, |
HEADING2 | Enum | 第二個標題選項。 |
HEADING3 | Enum | 第三個標題選項 |
HEADING4 | Enum | 第四個標題選項。 |
HEADING5 | Enum | 第五個標題選項, |
HEADING6 | Enum | 最小的標題選項, |
TITLE | Enum | 標題標題選項。 |
SUBTITLE | Enum | 副標題標題選項。 |
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 元素,用來代表
包含 Position 的 Paragraph 或 ListItem (直接或透過子項元素鏈結)。 |
getSurroundingTextOffset() | Integer | 取得此 Position 在 getSurroundingText() 傳回的 Text 元素中的偏移值。 |
insertBookmark() | Bookmark | 在這個 Position 中建立及插入新的 Bookmark 。 |
insertInlineImage(image) | InlineImage | 從指定圖片在這個 Position 建立及插入新的 InlineImage
blob。 |
insertText(text) | Text | 在這個 Position 插入指定文字。 |
PositionedImage
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
getAs(contentType) | Blob | 以 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_TEXT | Enum | 圖片位在文字上方。 |
BREAK_BOTH | Enum | 圖片會分散左側和右側的文字。 |
BREAK_LEFT | Enum | 圖片會分散左側文字。 |
BREAK_RIGHT | Enum | 圖片會打斷右側文字。 |
WRAP_TEXT | Enum | 圖片會經過文字包裝。 |
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 | 決定這個範圍元素是涵蓋整個元素,還是部分選取範圍 元素的字元。 |
RichLink
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
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 | 設定元素的屬性。 |
Tab
方法
方法 | 傳回類型 | 簡短說明 |
---|---|---|
asDocumentTab() | DocumentTab | 將分頁內容擷取為 DocumentTab 。 |
getChildTabs() | Tab[] | 擷取這個分頁內的子分頁。 |
getId() | String | 擷取分頁的 ID。 |
getIndex() | Integer | 擷取父項中分頁從 0 開始的索引。 |
getTitle() | String | 擷取分頁的標題。 |
getType() | TabType | 擷取分頁類型。 |
TabType
屬性
屬性 | 類型 | 說明 |
---|---|---|
DOCUMENT_TAB | Enum | 與 DocumentTab 對應的類型。 |
Table
方法
TableCell
方法
TableOfContents
方法
TableRow
方法
Text
方法
TextAlignment
屬性
屬性 | 類型 | 說明 |
---|---|---|
NORMAL | Enum | 一般文字對齊方式。 |
SUPERSCRIPT | Enum | 上標文字對齊方式。 |
SUBSCRIPT | Enum | 下標文字對齊方式。 |
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
屬性
屬性 | 類型 | 說明 |
---|---|---|
BOTTOM | Enum | 靠下對齊選項。 |
CENTER | Enum | 置中對齊選項。 |
TOP | Enum | 靠上對齊選項。 |