表の行を表す要素。TableRow は常に Table 内に含まれ、TableCell 要素のみを含めることができます。ドキュメントの詳細については、
詳しくは、
Google ドキュメント。
メソッド
詳細なドキュメント
appendTableCell()
appendTableCell(textContents)
appendTableCell(tableCell)
clear()
copy()
editAsText()
編集用に、現在の要素の Text バージョンを取得します。
editAsText を使用して、要素のコンテンツをリッチテキストとして操作します。editAsText モードでは、テキスト以外の要素（InlineImage や HorizontalRule など）は無視されます。
削除されたテキスト範囲に完全に含まれている子要素は要素から削除されます。
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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 が指定されている）。
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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
getCell(cellIndex)
getChild(childIndex)
指定された子インデックスの子要素を取得します。
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();
// Obtain the first element in the tab.
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)
getLinkUrl()
リンクの URL を取得します。
戻る
String - リンク URL、または要素にこの属性に複数の値が含まれている場合は null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getMinimumHeight()
最小の高さをポイント単位で取得します。
戻る
Number - 最小の高さ（ポイント単位）
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getNextSibling()
getNumCells()
行内のセルの数を取得します。
戻る
Integer - セル数
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getNumChildren()
子の数を取得します。
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();
// Log the number of elements in the tab.
Logger.log("There are " + body.getNumChildren() +
" elements in the tab's 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
getParentTable()
getPreviousSibling()
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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();
// Obtain the first element in the active tab's 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
insertTableCell(childIndex)
insertTableCell(childIndex, textContents)
insertTableCell(childIndex, tableCell)
isAtDocumentEnd()
merge()
要素を、先行する同じ型の兄弟要素と結合します。
結合できるのは同じ ElementType の要素のみです。Deployment に含まれる子要素は、
現在の要素は前の兄弟要素に移動されます。
現在の要素がドキュメントから削除されます。
var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();
// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
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();
戻る
TableRow - マージされた要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
removeCell(cellIndex)
removeChild(child)
removeFromParent()
要素を親から削除します。
var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab()
var body = documentTab.getBody();
// Remove all images in the active tab's body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
imgs[i].removeFromParent();
}
戻る
TableRow - 削除された要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
通常の文字列を使用して、指定したテキスト パターンをすべて、指定した置換文字列に置き換えます。 表します。
検索パターンは、JavaScript 正規表現オブジェクトではなく、文字列として渡されます。 そのため、パターン内でバックスラッシュをエスケープする必要があります。
このメソッドは、Google の RE2 標準版を使用します。 式ライブラリを使用して、サポートされている構文を制限します。
指定した正規表現のパターンが、テキスト ブロックごとに個別に照合される 返されます。
var body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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 | 要素の属性。 |
戻る
TableRow - 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
setLinkUrl(url)
setMinimumHeight(minHeight)
setTextAlignment(textAlignment)
テキストの配置を設定します。使用できるアライメントのタイプは、DocumentApp.TextAlignment.NORMAL、DocumentApp.TextAlignment.SUBSCRIPT、DocumentApp.TextAlignment.SUPERSCRIPT です。
// Make the entire first paragraph in the active tab be superscript. var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); var text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
パラメータ
| 名前 | 型 | 説明 |
|---|---|---|
textAlignment | TextAlignment | 適用するテキスト配置のタイプ |
戻る
TableRow - 現在の要素
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents