このサービスを使用すると、スクリプトで 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 | 1 つ以上の Tab オブジェクトを含むドキュメント。各オブジェクトには、リッチテキストと
テーブルやリストなどの要素です |
DocumentApp | ドキュメント サービスが、編集可能な Documents を作成して開きます。 |
DocumentTab | リッチテキストと、テーブルやリストなどの要素を含むドキュメントタブ。 |
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 | ドライブ ファイルや YouTube 動画などの Google リソースへのリンクを表す要素。 |
Tab | Google ドキュメントのドキュメント内のタブ。 |
TabType | すべてのタブタイプの列挙。 |
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 | 段落要素の 1 行目のインデント設定(ポイント単位)。 |
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
メソッド
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 | 指定された 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 の閲覧者のリストに追加します。 |
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 | ドキュメントの一意の識別子を取得します。 |
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 | 現在のドキュメントにアクセスするための 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 を保存します。 |
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 | スクリプトがコンテナバインドされているドキュメントを返します。 |
getUi() | Ui | スクリプトによる追加を許可するドキュメントのユーザー インターフェース環境のインスタンスを返します。 メニュー、ダイアログ、サイドバーなどの 機能を作成できます |
openById(id) | Document | 指定された ID のドキュメントを返します。 |
openByUrl(url) | Document | 指定された URL のドキュメントを開いて返します。 |
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 として返します。 |
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
メソッド
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 | 2 番目の見出しオプション。 |
HEADING3 | Enum | 3 つ目の見出しオプションは |
HEADING4 | Enum | 4 番目の見出しオプション。 |
HEADING5 | Enum | 5 番目の見出しオプション。 |
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 | 新しい Bookmark を作成してこの Position に挿入します。 |
insertInlineImage(image) | InlineImage | 指定されたイメージから、この 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_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 | この RangeBuilder に部分的な Text 要素を追加します。 |
addElementsBetween(startElement, endElementInclusive) | RangeBuilder | 2 つの要素全体と、その間のすべての要素をこの RangeBuilder に追加します。 |
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive) | RangeBuilder | 2 つの部分的な 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 | リソースの URL を返します。 |
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 | 上揃えのオプション。 |