このページは Cloud Translation API によって翻訳されました。

Interface Element

汎用要素です。Document のコンテンツは要素として表現されます。たとえば、ListItem、Paragraph、Table は要素であり、Element で定義されたすべてのメソッド（getType() など）を継承します。

クラスの実装

名前	概要
`Body`	ドキュメントの本文を表す要素。
`ContainerElement`	他の要素を含む可能性のある汎用要素です。
`Date`	書式設定された日付を表す要素
`Equation`	数式を表す要素。
`EquationFunction`	数学的な `Equation` の関数を表す要素。
`EquationFunctionArgumentSeparator`	数学的な `Equation` における関数の区切り文字を表す要素。
`EquationSymbol`	数学的な `Equation` の記号を表す要素。
`FooterSection`	フッターセクションを表す要素。
`Footnote`	脚注を表す要素。
`FootnoteSection`	脚注セクションを表す要素。
`HeaderSection`	ヘッダーセクションを表す要素。
`HorizontalRule`	水平方向の規則を表す要素。
`InlineDrawing`	埋め込み図形描画を表す要素。
`InlineImage`	埋め込み画像を表す要素。
`ListItem`	リストアイテムを表す要素。
`PageBreak`	改ページを表す要素。
`Paragraph`	段落を表す要素。
`Person`	ユーザーへのリンクを表す要素。
`RichLink`	Google リソース（ドライブのファイルや YouTube 動画など）へのリンクを表す要素。
`Table`	テーブルを表す要素。
`TableCell`	テーブルのセルを表す要素。
`TableOfContents`	目次を含む要素。
`TableRow`	テーブルの行を表す要素。
`Text`	リッチテキスト形式の領域を表す要素。
`UnsupportedElement`	ページ番号など、不明な地域やスクリプトの影響を受けない地域を表す要素。

Methods

メソッド	戻り値の型	概要
`asBody()`	`Body`	現在の要素を `Body` として返します。
`asDate()`	`Date`	現在の要素を `Date` として返します。
`asEquation()`	`Equation`	現在の要素を `Equation` として返します。
`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`	要素の属性を設定します。

詳細なドキュメント

`asBody()`

現在の要素を Body として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

Body - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asDate()`

現在の要素を Date として返します。

要素が Date であることがわかっている場合は、このメソッドを使用して型を Date に設定します。これにより、Apps Script エディタのオートコンプリートにより、Date で使用できるメソッドが表示されるようになります。

リターン

Date - 型が Date に設定された現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asEquation()`

現在の要素を Equation として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

Equation - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asEquationFunction()`

現在の要素を EquationFunction として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

EquationFunction - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asEquationFunctionArgumentSeparator()`

現在の要素を EquationFunctionArgumentSeparator として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

EquationFunctionArgumentSeparator - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asEquationSymbol()`

現在の要素を EquationSymbol として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

EquationSymbol - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asFooterSection()`

現在の要素を FooterSection として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

FooterSection - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asFootnote()`

現在の要素を Footnote として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

Footnote - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asFootnoteSection()`

現在の要素を FootnoteSection として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

FootnoteSection - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asHeaderSection()`

現在の要素を HeaderSection として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

HeaderSection - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asHorizontalRule()`

現在の要素を HorizontalRule として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

HorizontalRule - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asInlineDrawing()`

現在の要素を InlineDrawing として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

InlineDrawing - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asInlineImage()`

現在の要素を InlineImage として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

InlineImage - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asListItem()`

現在の要素を ListItem として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

ListItem - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asPageBreak()`

現在の要素を PageBreak として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

PageBreak - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asParagraph()`

現在の要素を Paragraph として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

Paragraph - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asPerson()`

現在の要素を Person として返します。

要素が Person であることがわかっている場合は、このメソッドを使用してそのタイプを人物として設定します。これにより、Apps Script エディタのオートコンプリートで、person 要素で使用できるメソッドを表示できるようになります。

リターン

Person - 型が Person に設定された現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asRichLink()`

現在の要素を RichLink として返します（Google スプレッドシートファイルへのリンクなど）。

要素が RichLink であることがわかっている場合は、このメソッドを使用して型を RichLink に設定します。これにより、Apps Script エディタのオートコンプリートにより、RichLink で使用できるメソッドが表示されるようになります。

リターン

RichLink - 型が RichLink に設定された現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asTable()`

現在の要素を Table として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

Table - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asTableCell()`

現在の要素を TableCell として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

TableCell - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asTableOfContents()`

現在の要素を TableOfContents として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

TableOfContents - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asTableRow()`

現在の要素を TableRow として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

TableRow - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`asText()`

現在の要素を Text として返します。

指定した要素が特定のタイプであることがわかっている場合は、このメソッドを使用してオートコンプリートが促進されます。

リターン

Text - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`copy()`

現在の要素の分離されたディープコピーを返します。

その要素内にある子要素もコピーされます。新しい要素には親がありません。

リターン

Element - 新しいコピー。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getAttributes()`

要素の属性を取得します。

その結果、各有効な要素属性のプロパティを含むオブジェクトが返されます。各プロパティ名は、DocumentApp.Attribute 列挙型のアイテムに対応しています。

var body = DocumentApp.getActiveDocument().getBody();

// Append a styled paragraph.
var par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
var atts = par.getAttributes();

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

リターン

Object - 要素の属性。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getNextSibling()`

要素の次の兄弟要素を取得します。

次の兄弟要素は同じ親を持ち、現在の要素をフォローします。

リターン

Element - 次の兄弟要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getParent()`

要素の親要素を取得します。

親要素には現在の要素が含まれます。

リターン

ContainerElement - 親要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getPreviousSibling()`

要素の前の兄弟要素を取得します。

前の兄弟要素は同じ親を持ち、現在の要素の前にあります。

リターン

Element - 前の兄弟要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getType()`

要素の ElementType を取得します。

特定の要素の正確なタイプを特定するには、getType() を使用します。

var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document body.

var firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

リターン

ElementType - 要素のタイプ。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`isAtDocumentEnd()`

要素が Document の末尾にあるかどうかを判断します。

リターン

Boolean - 要素がドキュメントの末尾にあるかどうか。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`merge()`

要素を、上の同じタイプの兄弟要素と結合します。

結合できるのは、同じ ElementType の要素のみです。現在の要素に含まれるすべての子要素は、前の兄弟要素に移動します。

現在の要素がドキュメントから削除されます。

var body = DocumentApp.getActiveDocument().getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document.
var par1 = body.appendParagraph('Paragraph 1.');
var par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
var cells = [
['Row 1, Cell 1', 'Row 1, Cell 2'],
['Row 2, Cell 1', 'Row 2, Cell 2']
];
// Build a table from the array.
var table = body.appendTable(cells);
// Get the first row in the table.
 var row = table.getRow(0);
// Get the two cells in this row.
var cell1 = row.getCell(0);
var cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
var merged = cell2.merge();

リターン

Element - 結合された要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`removeFromParent()`

要素を親から削除します。

var body = DocumentApp.getActiveDocument().getBody();

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

リターン

Element - 削除された要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`setAttributes(attributes)`

要素の属性を設定します。

指定する属性パラメータは、各プロパティ名が DocumentApp.Attribute 列挙型のアイテム、各プロパティ値が、適用される新しい値であるオブジェクトである必要があります。

var body = DocumentApp.getActiveDocument().getBody();

// Define a custom paragraph style.
var style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
var par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

パラメータ

名前	型	説明
`attributes`	`Object`	要素の属性。

リターン

Element - 現在の要素。

承認

この方法を使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents