這項服務允許指令碼建立、存取及修改 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 | 包含 RTF 格式和元素 (例如表格和清單) 的文件。 |
DocumentApp | 文件服務會建立並開啟可以編輯的 Documents 。 |
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 影片。 |
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 | RT 格式的字型樣式設定。 |
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 | 取得 Document 中 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
方法
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 | 開啟並傳回含有指定網址的文件。 |
Element
方法
ElementType
屬性
屬性 | 類型 | 說明 |
---|---|---|
BODY_SECTION | Enum | 與 Body 元素相對應的類型。 |
COMMENT_SECTION | Enum | 與 元素相對應的類型。 |
DATE | Enum | 與 Date 元素相對應的類型。 |
DOCUMENT | Enum | 對應至文件根目錄的類型。 |
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。 |
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 | 在 getSurroundingText() 傳回的 Text 元素中,取得這個 Position 的偏移值。 |
insertBookmark() | Bookmark | 在這個 Position 建立及插入新的 Bookmark 。 |
insertInlineImage(image) | InlineImage | 在這個 Position 從指定的圖片 blob 建立及插入新的 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_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 | 設定元素的屬性。 |
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 | 向上對齊選項。 |