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

Class ContainerElement

他の要素を含む可能性のある汎用要素。Paragraph などの子要素を含むすべての要素は、ContainerElement を継承します。

Methods

方法	戻り値の型	概要
`asBody()`	`Body`	現在の要素を `Body` として返します。
`asEquation()`	`Equation`	現在の要素を `Equation` として返します。
`asFooterSection()`	`FooterSection`	現在の要素を `FooterSection` として返します。
`asFootnoteSection()`	`FootnoteSection`	現在の要素を `FootnoteSection` として返します。
`asHeaderSection()`	`HeaderSection`	現在の要素を `HeaderSection` として返します。
`asListItem()`	`ListItem`	現在の要素を `ListItem` として返します。
`asParagraph()`	`Paragraph`	現在の要素を `Paragraph` として返します。
`asTable()`	`Table`	現在の要素を `Table` として返します。
`asTableCell()`	`TableCell`	現在の要素を `TableCell` として返します。
`asTableOfContents()`	`TableOfContents`	現在の要素を `TableOfContents` として返します。
`asTableRow()`	`TableRow`	現在の要素を `TableRow` として返します。
`clear()`	`ContainerElement`	要素のコンテンツをクリアします。
`copy()`	`ContainerElement`	現在の要素から分離されたディープコピーを返します。
`editAsText()`	`Text`	編集用に現在の要素の `Text` バージョンを取得します。
`findElement(elementType)`	`RangeElement`	要素のコンテンツを指定して、指定された型の子孫を検索します。
`findElement(elementType, from)`	`RangeElement`	要素の内容を検索し、指定された `RangeElement` から始まる、指定されたタイプの子孫を検索します。
`findText(searchPattern)`	`RangeElement`	正規表現を使用して、要素の内容について、指定されたテキストパターンを検索します。
`findText(searchPattern, from)`	`RangeElement`	特定のコンテンツ要素から、指定したテキストパターンで要素のコンテンツを検索します。
`getAttributes()`	`Object`	要素の属性を取得します。
`getChild(childIndex)`	`Element`	指定した子インデックスにある子要素を取得します。
`getChildIndex(child)`	`Integer`	指定した子要素の子インデックスを取得します。
`getLinkUrl()`	`String`	リンクの URL を取得します。
`getNextSibling()`	`Element`	要素の次の兄弟要素を取得します。
`getNumChildren()`	`Integer`	子の数を取得します。
`getParent()`	`ContainerElement`	要素の親要素を取得します。
`getPreviousSibling()`	`Element`	要素の前の兄弟要素を取得します。
`getText()`	`String`	要素のコンテンツをテキスト文字列として取得します。
`getTextAlignment()`	`TextAlignment`	テキストの配置を取得します。
`getType()`	`ElementType`	要素の `ElementType` を取得します。
`isAtDocumentEnd()`	`Boolean`	要素が `Document` の末尾にあるかどうかを判断します。
`merge()`	`ContainerElement`	同じタイプの先行する兄弟要素と要素を結合します。
`removeFromParent()`	`ContainerElement`	親から要素を削除します。
`replaceText(searchPattern, replacement)`	`Element`	正規表現を使用して、特定のテキストパターンをすべて特定の置換文字列に置き換えます。
`setAttributes(attributes)`	`ContainerElement`	要素の属性を設定します。
`setLinkUrl(url)`	`ContainerElement`	リンクの URL を設定します。
`setTextAlignment(textAlignment)`	`ContainerElement`	テキストの配置を設定します。

詳細なドキュメント

`asBody()`

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

このメソッドを使用して、特定の要素が特定の型であることが判明するたびにオートコンプリートを実現できます。

戻る

Body - 現在の要素。

認可

このメソッドを使用するスクリプトには、次の 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

`asFooterSection()`

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

このメソッドを使用して、特定の要素が特定の型であることが判明するたびにオートコンプリートを実現できます。

戻る

FooterSection - 現在の要素。

認可

このメソッドを使用するスクリプトには、次の 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

`asListItem()`

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

このメソッドを使用して、特定の要素が特定の型であることが判明するたびにオートコンプリートを実現できます。

戻る

ListItem - 現在の要素。

認可

このメソッドを使用するスクリプトには、次の 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

`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

`clear()`

要素のコンテンツをクリアします。

戻る

ContainerElement - 現在の要素。

`copy()`

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

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

戻る

ContainerElement - 新しいコピー。

認可

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

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

`editAsText()`

編集用に現在の要素の Text バージョンを取得します。

editAsText を使用して、要素のコンテンツをリッチテキストとして操作します。editAsText モードでは、テキスト以外の要素（InlineImage や HorizontalRule など）は無視されます。

削除されたテキスト範囲に完全に含まれる子要素は、その要素から削除されます。

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

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

戻る

Text - 現在の要素のテキストバージョン。

`findElement(elementType)`

要素のコンテンツを指定して、指定された型の子孫を検索します。

パラメータ

名前	型	説明
`elementType`	`ElementType`	検索する要素のタイプ

戻る

RangeElement - 検索要素の位置を示す検索結果。

認可

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

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

`findElement(elementType, from)`

要素の内容を検索し、指定された RangeElement から始まる、指定されたタイプの子孫を検索します。

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

パラメータ

名前	型	説明
`elementType`	`ElementType`	検索する要素のタイプ
`from`	`RangeElement`	検索元の検索結果

戻る

RangeElement - 検索要素の次の位置を示す検索結果

認可

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

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

`findText(searchPattern)`

正規表現を使用して、要素の内容について、指定されたテキストパターンを検索します。

キャプチャグループやモード修飾子など、JavaScript の正規表現機能の一部はサポートされていません。

指定された正規表現パターンは、現在の要素に含まれるテキストブロックごとに独立して照合されます。

パラメータ

名前	型	説明
`searchPattern`	`String`	検索するパターン

戻る

RangeElement - 検索テキストの位置を示す検索結果。一致がない場合は null を返します。

認可

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

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

`findText(searchPattern, from)`

特定のコンテンツ要素から、指定したテキストパターンで要素のコンテンツを検索します。

キャプチャグループやモード修飾子など、JavaScript の正規表現機能の一部はサポートされていません。

指定された正規表現パターンは、現在の要素に含まれるテキストブロックごとに独立して照合されます。

パラメータ

名前	型	説明
`searchPattern`	`String`	検索するパターン
`from`	`RangeElement`	検索元の検索結果

戻る

RangeElement - 検索テキストの次の位置を示す検索結果。一致がない場合は null を返します。

認可

このメソッドを使用するスクリプトには、次の 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

`getChild(childIndex)`

指定した子インデックスにある子要素を取得します。

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText("This is the first paragraph.");
}

パラメータ

名前	型	説明
`childIndex`	`Integer`	取得する子要素のインデックス

戻る

Element - 指定されたインデックスの子要素

認可

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

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

`getChildIndex(child)`

指定した子要素の子インデックスを取得します。

パラメータ

名前	型	説明
`child`	`Element`	インデックスを取得する子要素

戻る

Integer - 子インデックス。

認可

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

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

`getLinkUrl()`

リンクの URL を取得します。

戻る

String - リンク URL。この属性に複数の値が含まれている場合は要素に null を指定します。

認可

このメソッドを使用するスクリプトには、次の 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

`getNumChildren()`

子の数を取得します。

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

戻る

Integer - 子の数

認可

このメソッドを使用するスクリプトには、次の 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

`getText()`

要素のコンテンツをテキスト文字列として取得します。

戻る

String - テキストの内容としての要素の内容

認可

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

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

`getTextAlignment()`

テキストの配置を取得します。使用可能なアライメントの種類は、DocumentApp.TextAlignment.NORMAL、DocumentApp.TextAlignment.SUBSCRIPT、DocumentApp.TextAlignment.SUPERSCRIPT です。

戻る

TextAlignment - テキスト配置のタイプ。テキストに複数のタイプのテキスト配置が含まれている場合、またはテキスト配置が一度も設定されていない場合は null。

認可

このメソッドを使用するスクリプトには、次の 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();

戻る

ContainerElement - マージされた要素。

認可

このメソッドを使用するスクリプトには、次の 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();
}

戻る

ContainerElement - 削除された要素。

認可

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

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

`replaceText(searchPattern, replacement)`

正規表現を使用して、特定のテキストパターンをすべて特定の置換文字列に置き換えます。

検索パターンは、JavaScript の正規表現オブジェクトではなく、文字列として渡されます。そのため、パターン内のバックスラッシュはエスケープする必要があります。

このメソッドは、Google の RE2 正規表現ライブラリを使用して、サポートされている構文を制限します。

指定された正規表現パターンは、現在の要素に含まれるテキストブロックごとに独立して照合されます。

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

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText("^.*Apps ?Script.*$", "Apps Script");

パラメータ

名前	型	説明
`searchPattern`	`String`	検索する正規表現パターン
`replacement`	`String`	置換として使用するテキスト

戻る

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`	要素の属性。

戻る

ContainerElement - 現在の要素。

認可

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

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

`setLinkUrl(url)`

リンクの URL を設定します。

パラメータ

名前	型	説明
`url`	`String`	リンクの URL

戻る

ContainerElement - 現在の要素。

認可

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

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

`setTextAlignment(textAlignment)`

テキストの配置を設定します。使用可能なアライメントのタイプは、DocumentApp.TextAlignment.NORMAL、DocumentApp.TextAlignment.SUBSCRIPT、DocumentApp.TextAlignment.SUPERSCRIPT です。

// Make the entire first paragraph be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

パラメータ

名前	型	説明
`textAlignment`	`TextAlignment`	適用するテキストの配置タイプ

戻る

ContainerElement - 現在の要素。

認可

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

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