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

Class Table

テーブルを表す要素。Table には TableRow 要素のみを含めることができます。対象ドキュメント構造について詳しくは、Google ドキュメントの拡張ガイドをご覧ください。

多数の行またはセルを含む Table を作成する場合は、それを文字列配列から取得できます。

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

// Create a two-dimensional array containing the 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.
body.appendTable(cells);

メソッド

メソッド	戻り値の型	概要
`appendTableRow()`	`TableRow`	新しい `TableRow` を作成して追加します。
`appendTableRow(tableRow)`	`TableRow`	指定された `TableRow` を追加します。
`clear()`	`Table`	要素の内容をクリアします。
`copy()`	`Table`	現在の要素の分離されたディープコピーを返します。
`editAsText()`	`Text`	編集用に、現在の要素の `Text` バージョンを取得します。
`findElement(elementType)`	`RangeElement`	要素のコンテンツで、指定された型の子孫を検索します。
`findElement(elementType, from)`	`RangeElement`	要素のコンテンツで、指定された型の子孫を（`RangeElement` が指定されている）。
`findText(searchPattern)`	`RangeElement`	正規表現を使用して、指定されたテキストパターンの要素のコンテンツを検索します。
`findText(searchPattern, from)`	`RangeElement`	要素の内容の中から、指定したテキストパターンから始まるものを検索します。表示されます。
`getAttributes()`	`Object`	要素の属性を取得します。
`getBorderColor()`	`String`	枠線の色を取得します。
`getBorderWidth()`	`Number`	枠線の幅をポイント単位で取得します。
`getCell(rowIndex, cellIndex)`	`TableCell`	指定された行とセルのインデックスで `TableCell` を取得します。
`getChild(childIndex)`	`Element`	指定された子インデックスの子要素を取得します。
`getChildIndex(child)`	`Integer`	指定された子要素の子インデックスを取得します。
`getColumnWidth(columnIndex)`	`Number`	指定されたテーブル列の幅をポイント単位で取得します。
`getLinkUrl()`	`String`	リンクの URL を取得します。
`getNextSibling()`	`Element`	要素の次の兄弟要素を取得します。
`getNumChildren()`	`Integer`	子の数を取得します。
`getNumRows()`	`Integer`	`TableRows` の数を取得します。
`getParent()`	`ContainerElement`	要素の親要素を取得します。
`getPreviousSibling()`	`Element`	要素の前の兄弟要素を取得します。
`getRow(rowIndex)`	`TableRow`	指定された行インデックスの `TableRow` を取得します。
`getText()`	`String`	要素のコンテンツをテキスト文字列として取得します。
`getTextAlignment()`	`TextAlignment`	テキストの配置を取得します。
`getType()`	`ElementType`	要素の `ElementType` を取得します。
`insertTableRow(childIndex)`	`TableRow`	新しい `TableRow` を作成して指定されたインデックスに挿入します。
`insertTableRow(childIndex, tableRow)`	`TableRow`	指定された `TableRow` を指定されたインデックスに挿入します。
`isAtDocumentEnd()`	`Boolean`	要素が `Document` の最後にあるかどうかを決定します。
`removeChild(child)`	`Table`	指定した子要素を削除します。
`removeFromParent()`	`Table`	要素を親から削除します。
`removeRow(rowIndex)`	`TableRow`	指定された行インデックスの `TableRow` を削除します。
`replaceText(searchPattern, replacement)`	`Element`	通常の文字列を使用して、指定したテキストパターンをすべて、指定した置換文字列に置き換えます。表します。
`setAttributes(attributes)`	`Table`	要素の属性を設定します。
`setBorderColor(color)`	`Table`	枠線の色を設定します。
`setBorderWidth(width)`	`Table`	枠線の幅をポイント単位で設定します。
`setColumnWidth(columnIndex, width)`	`Table`	指定された列の幅をポイント単位で設定します。
`setLinkUrl(url)`	`Table`	リンク URL を設定します。
`setTextAlignment(textAlignment)`	`Table`	テキストの配置を設定します。

詳細なドキュメント

`appendTableRow()`

新しい TableRow を作成して追加します。

戻る

TableRow - テーブルの新しい行の要素

承認

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

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

`appendTableRow(tableRow)`

指定された TableRow を追加します。

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table in the tab and copies the second row.
const table = body.getTables()[0];
const row = table.getChild(1).copy();

// Adds the copied row to the bottom of the table.
const tableRow = table.appendTableRow(row);

パラメータ

名前	型	説明
`tableRow`	`TableRow`	追加するテーブルの行。

戻る

TableRow - 追加されたテーブル行の要素。

承認

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

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

`clear()`

要素の内容をクリアします。

戻る

Table - 現在の要素。

`copy()`

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

その要素に含まれている子要素もすべてコピーされます。新しい要素にはできます。

戻る

Table - 新しいコピー。

承認

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

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

`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

`getBorderColor()`

枠線の色を取得します。

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Sets the border color of the first table.
table.setBorderColor('#00FF00');

// Logs the border color of the first table to the console.
console.log(table.getBorderColor());

戻る

String - 枠線の色。CSS 表記（'#ffffff' など）で指定します。

承認

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

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

`getBorderWidth()`

枠線の幅をポイント単位で取得します。

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Sets the border width of the first table.
table.setBorderWidth(20);

// Logs the border width of the first table.
console.log(table.getBorderWidth());

戻る

Number - 枠線の幅（ポイント単位）。

承認

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

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

`getCell(rowIndex, cellIndex)`

指定された行とセルのインデックスで TableCell を取得します。

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Gets the cell of the table's third row and second column.
const cell = table.getCell(2, 1);

// Logs the cell text to the console.
console.log(cell.getText());

パラメータ

名前	型	説明
`rowIndex`	`Integer`	取得するセルを含む行のインデックス。
`cellIndex`	`Integer`	取得するセルのインデックス。

戻る

TableCell - テーブルのセル。

承認

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

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

`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)`

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

パラメータ

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

戻る

Integer - 子インデックス。

承認

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

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

`getColumnWidth(columnIndex)`

指定されたテーブル列の幅をポイント単位で取得します。

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Sets the width of the second column to 100 points.
const columnWidth = table.setColumnWidth(1, 100);

// Gets the width of the second column and logs it to the console.
console.log(columnWidth.getColumnWidth(1));

パラメータ

名前	型	説明
`columnIndex`	`Integer`	列のインデックス。

戻る

Number - 列の幅（ポイント単位）。

承認

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

子の数を取得します。

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

`getNumRows()`

TableRows の数を取得します。

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Logs the number of rows of the first table to the console.
console.log(table.getNumRows());

戻る

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

`getRow(rowIndex)`

指定された行インデックスの TableRow を取得します。

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table and logs the text of first row to the console.
const table = body.getTables()[0];
console.log(table.getRow(0).getText());

パラメータ

名前	型	説明
`rowIndex`	`Integer`	取得する行のインデックス。

戻る

TableRow - テーブルの行。

承認

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

`insertTableRow(childIndex)`

新しい TableRow を作成して指定されたインデックスに挿入します。

パラメータ

名前	型	説明
`childIndex`	`Integer`	要素を挿入するインデックス

戻る

TableRow - 現在の要素

承認

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

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

`insertTableRow(childIndex, tableRow)`

指定された TableRow を指定されたインデックスに挿入します。

パラメータ

名前	型	説明
`childIndex`	`Integer`	要素を挿入するインデックス
`tableRow`	`TableRow`	挿入するテーブルの行

戻る

TableRow - 挿入された表の行の要素

承認

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

`removeChild(child)`

指定した子要素を削除します。

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Finds the first table row and removes it.
const element = table.findElement(DocumentApp.ElementType.TABLE_ROW);
table.removeChild(element.getElement());

パラメータ

名前	型	説明
`child`	`Element`	削除する子要素。

戻る

Table - 現在の要素。

承認

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

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

`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();
}

戻る

Table - 削除された要素。

承認

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

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

`removeRow(rowIndex)`

指定された行インデックスの TableRow を削除します。

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table and removes its second row.
const table = body.getTables()[0];
table.removeRow(1);

パラメータ

名前	型	説明
`rowIndex`	`Integer`	削除する行のインデックス。

戻る

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

戻る

Table - 現在の要素。

承認

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

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

`setBorderColor(color)`

枠線の色を設定します。

// Opens the Docs file by its ID. If you created your script from within a
// Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById(DOCUMENT_ID);

// Gets the body contents of the tab by its ID.
// TODO(developer): Replace the ID with your own.
const body = doc.getTab(TAB_ID).asDocumentTab().getBody();

// Gets the first table.
const table = body.getTables()[0];

// Sets the border color of the table to green.
table.setBorderColor('#00FF00');

パラメータ

名前	型	説明
`color`	`String`	枠線の色。CSS 表記（`'#ffffff'` など）で指定します。

戻る

Table - 現在の要素。

承認

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

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

`setBorderWidth(width)`

枠線の幅をポイント単位で設定します。

パラメータ

名前	型	説明
`width`	`Number`	枠線の太さ（ポイント単位）

戻る

Table - 現在の要素

承認

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

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

`setColumnWidth(columnIndex, width)`

指定された列の幅をポイント単位で設定します。

パラメータ

名前	型	説明
`columnIndex`	`Integer`	列インデックス
`width`	`Number`	枠線の太さ（ポイント単位）

戻る

Table - 現在の要素

承認

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

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

`setLinkUrl(url)`

リンク URL を設定します。

パラメータ

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

戻る

Table - 現在の要素

承認

このメソッドを使用するスクリプトには、次のスコープの 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 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`	適用するテキスト配置のタイプ

戻る

Table - 現在の要素

承認

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

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