このサービスにより、スクリプトは 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 内の記号を表す要素。 |
| サポートされているフォントの列挙。 |
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 | リッチテキストの領域を表す要素。 |
TextAlignment | テキストの配置の型の列挙型。 |
UnsupportedElement | 不明な地域や、スクリプトの影響を受けない地域(ページ番号など)を表す要素。 |
VerticalAlignment | サポートされている垂直方向の配置型の列挙型。 |
Attribute
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
BACKGROUND_COLOR | Enum | 要素(段落、表など)またはドキュメントの背景色。 |
BOLD | Enum | リッチテキストのフォントの太さの設定。 |
BORDER_COLOR | Enum | 表の要素の枠線の色。 |
BORDER_WIDTH | Enum | 表の要素の枠線の幅(ポイント単位)。 |
CODE | Enum | 方程式要素のコードの内容。 |
FONT_FAMILY | Enum | リッチテキストのフォント ファミリーの設定。 |
FONT_SIZE | Enum | リッチテキストのフォントサイズ設定(ポイント単位)。 |
FOREGROUND_COLOR | Enum | リッチテキストのフォアグラウンド カラーの設定 |
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 | リッチテキストのフォント スタイルの設定。 |
GLYPH_TYPE | Enum | リストアイテム要素のグリフタイプ。 |
LEFT_TO_RIGHT | Enum | リッチテキスト向けのテキスト方向の設定。 |
LINE_SPACING | Enum | 段落要素の行間隔の設定です。 |
LINK_URL | Enum | リッチテキストのリンク URL。 |
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 | リッチテキストの取り消し線設定。 |
UNDERLINE | Enum | リッチテキスト用の下線の設定。 |
VERTICAL_ALIGNMENT | Enum | 表のセル要素に対する垂直方向の配置設定。 |
WIDTH | Enum | 表のセルと画像の要素の幅の設定。 |
Body
Methods
Bookmark
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getId() | String | Bookmark の ID を取得します。 |
getPosition() | Position | Document 内の Bookmark の Position を取得します。 |
remove() | void | Bookmark を削除します。 |
ContainerElement
Methods
Date
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
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
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
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 | ドキュメントの一意の識別子を取得します。 |
getLanguage() | String | ドキュメントの言語コードを取得します。 |
getName() | String | ドキュメントのタイトルを取得します。 |
getNamedRangeById(id) | NamedRange | 指定された ID の NamedRange を取得します。 |
getNamedRanges() | NamedRange[] | ドキュメント内のすべての NamedRange オブジェクトを取得します。 |
getNamedRanges(name) | NamedRange[] | 指定された名前のドキュメント内のすべての NamedRange オブジェクトを取得します。 |
getSelection() | Range | アクティブ ドキュメント内のユーザーの選択を取得します。 |
getSupportedLanguageCodes() | String[] | Google ドキュメント ファイルでサポートされているすべての言語コードを取得します。 |
getUrl() | String | 現在のドキュメントにアクセスする URL を取得します。 |
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 を保存します。 |
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 列挙型。 |
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
create(name) | Document | 新しいドキュメントを作成して返します。 |
getActiveDocument() | Document | スクリプトがコンテナにバインドされているドキュメントを返します。 |
getUi() | Ui | ドキュメントのユーザー インターフェース環境のインスタンスを返します。これにより、スクリプトがメニュー、ダイアログ、サイドバーなどの機能を追加できます。 |
openById(id) | Document | 指定された ID のドキュメントを返します。 |
openByUrl(url) | Document | 指定された URL のドキュメントを開いて返します。 |
Element
Methods
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
Methods
EquationFunction
Methods
EquationFunctionArgumentSeparator
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | EquationFunctionArgumentSeparator | 現在の要素から分離されたディープコピーを返します。 |
getAttributes() | Object | 要素の属性を取得します。 |
getNextSibling() | Element | 要素の次の兄弟要素を取得します。 |
getParent() | ContainerElement | 要素の親要素を取得します。 |
getPreviousSibling() | Element | 要素の前の兄弟要素を取得します。 |
getType() | ElementType | 要素の ElementType を取得します。 |
isAtDocumentEnd() | Boolean | 要素が Document の最後にあるかどうかを判断します。 |
merge() | EquationFunctionArgumentSeparator | 要素を同じ型の前の兄弟と結合します。 |
removeFromParent() | EquationFunctionArgumentSeparator | 親から要素を削除します。 |
setAttributes(attributes) | EquationFunctionArgumentSeparator | 要素の属性を設定します。 |
EquationSymbol
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
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
Methods
Footnote
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | Footnote | 現在の要素から分離されたディープコピーを返します。 |
getAttributes() | Object | 要素の属性を取得します。 |
getFootnoteContents() | FootnoteSection | footnote 要素の内容を取得します。 |
getNextSibling() | Element | 要素の次の兄弟要素を取得します。 |
getParent() | ContainerElement | 要素の親要素を取得します。 |
getPreviousSibling() | Element | 要素の前の兄弟要素を取得します。 |
getType() | ElementType | 要素の ElementType を取得します。 |
isAtDocumentEnd() | Boolean | 要素が Document の最後にあるかどうかを判断します。 |
removeFromParent() | Footnote | 親から要素を削除します。 |
setAttributes(attributes) | Footnote | 要素の属性を設定します。 |
FootnoteSection
Methods
GlyphType
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
BULLET | Enum | デフォルトの箇条書き、円形、塗りつぶし。 |
HOLLOW_BULLET | Enum | 白丸リスト。 |
SQUARE_BULLET | Enum | 黒丸リスト。 |
NUMBER | Enum | 番号ベースの箇条書き記号。 |
LATIN_UPPER | Enum | アルファベットの大文字の箇条書き記号。 |
LATIN_LOWER | Enum | ラテン文字(小文字) |
ROMAN_UPPER | Enum | ローマ数字、大文字の箇条書き記号。 |
ROMAN_LOWER | Enum | 小文字の小文字の箇条書き記号。 |
HeaderSection
Methods
HorizontalAlignment
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
LEFT | Enum | 左揃えオプション。 |
CENTER | Enum | 中央揃えオプション。 |
RIGHT | Enum | 右揃えオプション。 |
JUSTIFY | Enum | 両端揃えオプション。 |
HorizontalRule
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | HorizontalRule | 現在の要素から分離されたディープコピーを返します。 |
getAttributes() | Object | 要素の属性を取得します。 |
getNextSibling() | Element | 要素の次の兄弟要素を取得します。 |
getParent() | ContainerElement | 要素の親要素を取得します。 |
getPreviousSibling() | Element | 要素の前の兄弟要素を取得します。 |
getType() | ElementType | 要素の ElementType を取得します。 |
isAtDocumentEnd() | Boolean | 要素が Document の最後にあるかどうかを判断します。 |
removeFromParent() | HorizontalRule | 親から要素を削除します。 |
setAttributes(attributes) | HorizontalRule | 要素の属性を設定します。 |
InlineDrawing
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
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
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | InlineImage | 現在の要素から分離されたディープコピーを返します。 |
getAltDescription() | String | 画像の代替説明を返します。 |
getAltTitle() | String | 画像の代替タイトルを返します。 |
getAs(contentType) | Blob | このオブジェクト内のデータを、指定されたコンテンツ タイプに変換された blob として返します。 |
getAttributes() | Object | 要素の属性を取得します。 |
getBlob() | Blob | このオブジェクト内のデータを blob として返します。 |
getHeight() | Integer | 画像の高さ(ピクセル単位)を取得します。 |
getLinkUrl() | String | リンク URL を取得します。 |
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 | リンク URL を設定します。 |
setWidth(width) | InlineImage | 画像の幅をピクセル単位で設定します。 |
ListItem
Methods
NamedRange
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getId() | String | この NamedRange の ID を取得します。 |
getName() | String | この NamedRange の名前を取得します。 |
getRange() | Range | この NamedRange に関連付けられている要素の範囲を取得します。 |
remove() | void | この NamedRange をドキュメントから削除します。 |
PageBreak
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | PageBreak | 現在の要素から分離されたディープコピーを返します。 |
getAttributes() | Object | 要素の属性を取得します。 |
getNextSibling() | Element | 要素の次の兄弟要素を取得します。 |
getParent() | ContainerElement | 要素の親要素を取得します。 |
getPreviousSibling() | Element | 要素の前の兄弟要素を取得します。 |
getType() | ElementType | 要素の ElementType を取得します。 |
isAtDocumentEnd() | Boolean | 要素が Document の最後にあるかどうかを判断します。 |
removeFromParent() | PageBreak | 親から要素を削除します。 |
setAttributes(attributes) | PageBreak | 要素の属性を設定します。 |
Paragraph
Methods
ParagraphHeading
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
NORMAL | Enum | 標準テキストの見出しオプション。 |
HEADING1 | Enum | 最上位の見出しオプション。 |
HEADING2 | Enum | 2 つ目の見出しオプション。 |
HEADING3 | Enum | 3 つ目の見出しオプション |
HEADING4 | Enum | 4 つ目の見出しオプション。 |
HEADING5 | Enum | 5 つ目の見出しオプション。 |
HEADING6 | Enum | 最小の見出しオプション。 |
TITLE | Enum | タイトルの見出しオプション。 |
SUBTITLE | Enum | 字幕の見出しオプション。 |
Person
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
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
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getElement() | Element | この Position を含む要素を取得します。 |
getOffset() | Integer | この Position を含む要素内の相対位置を取得します。 |
getSurroundingText() | Text | Position を含む Paragraph または ListItem のテキストと形式を、直接または子要素チェーンで表現する人工的な Text 要素を作成します。 |
getSurroundingTextOffset() | Integer | getSurroundingText() によって返される Text 要素内のこの Position のオフセットを取得します。 |
insertBookmark() | Bookmark | この Position に新しい Bookmark を作成して挿入します。 |
insertInlineImage(image) | InlineImage | 指定されたイメージ blob から、この Position に新しい InlineImage を作成して挿入します。 |
insertText(text) | Text | 指定したテキストをこの Position に挿入します。 |
PositionedImage
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
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
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getRangeElements() | RangeElement[] | 部分的な Text 要素を含めて、この Range のすべての要素を取得します(たとえば、Text 要素の一部のみを含む選択の場合)。 |
RangeBuilder
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
addElement(element) | RangeBuilder | この RangeBuilder に Element 全体を追加します。 |
addElement(textElement, startOffset, endOffsetInclusive) | RangeBuilder | この RangeBuilder に部分的な Text 要素を追加します。 |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | この RangeBuilder に 2 つの要素全体とその間のすべての要素を追加します。 |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | 2 つの部分的な Text 要素と、それらの間のすべての要素を RangeBuilder に追加します。 |
addRange(range) | RangeBuilder | 別の Range の内容をこの RangeBuilder に追加します。 |
build() | Range | ビルダーに適用された設定から Range を作成します。 |
getRangeElements() | RangeElement[] | 部分的な Text 要素を含めて、この Range のすべての要素を取得します(たとえば、Text 要素の一部のみを含む選択の場合)。 |
RangeElement
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
getElement() | Element | この RangeElement に対応する Element を取得します。 |
getEndOffsetInclusive() | Integer | 範囲要素内の部分範囲の終点の位置を取得します。 |
getStartOffset() | Integer | 範囲要素内で部分範囲の開始位置を取得します。 |
isPartial() | Boolean | この範囲要素が要素全体または要素の一部の選択を対象とするかどうかを決定します。 |
RichLink
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | RichLink | 現在の要素から分離されたディープコピーを返します。 |
getAttributes() | Object | 要素の属性を取得します。 |
getMimeType() | String | リンクの MIME タイプを返します。これは、アイテムがドライブ ファイルへのリンクの場合は null 、それ以外の場合は null です。 |
getNextSibling() | Element | 要素の次の兄弟要素を取得します。 |
getParent() | ContainerElement | 要素の親要素を取得します。 |
getPreviousSibling() | Element | 要素の前の兄弟要素を取得します。 |
getTitle() | String | リンクの表示タイトルを返します。 |
getType() | ElementType | 要素の ElementType を取得します。 |
getUrl() | String | リソースの URL を返します。 |
isAtDocumentEnd() | Boolean | 要素が Document の最後にあるかどうかを判断します。 |
merge() | RichLink | 要素を同じ型の前の兄弟と結合します。 |
removeFromParent() | RichLink | 親から要素を削除します。 |
setAttributes(attributes) | RichLink | 要素の属性を設定します。 |
Table
Methods
TableCell
Methods
TableOfContents
Methods
TableRow
Methods
Text
Methods
TextAlignment
プロパティ
プロパティ | タイプ | 説明 |
---|---|---|
NORMAL | Enum | 通常のテキストの配置です。 |
SUPERSCRIPT | Enum | 上付き文字の配置。 |
SUBSCRIPT | Enum | 下付き文字のテキストの配置。 |
UnsupportedElement
Methods
メソッド | 戻り値の型 | 概要 |
---|---|---|
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 | 上揃えのオプション。 |