Class Text

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。
テキスト

リッチテキスト領域を表す要素。Document 内のすべてのテキストは Text 要素内に含まれています。 Text 要素は、EquationEquationFunctionListItemParagraph のいずれかに含めることができますが、他の要素を含めることはできません。ドキュメント構造の詳細については、Google ドキュメントの拡張ガイドをご覧ください。

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

// Use editAsText to obtain a single text element containing
// all the characters in the document.
var text = body.editAsText();

// Insert text at the beginning of the document.
text.insertText(0, 'Inserted text.\n');

// Insert text at the end of the document.
text.appendText('\nAppended text.');

// Make the first half of the document blue.
text.setForegroundColor(0, text.getText().length / 2, '#00FFFF');

Methods

方法戻り値の型概要
appendText(text)Text指定したテキストをこのテキスト領域の最後に追加します。
copy()Text現在の要素から分離されたディープコピーを返します。
deleteText(startOffset, endOffsetInclusive)Textテキストの範囲を削除します。
editAsText()Text編集用に現在の要素の Text バージョンを取得します。
findText(searchPattern)RangeElement正規表現を使用して、要素の内容について、指定されたテキスト パターンを検索します。
findText(searchPattern, from)RangeElement特定のコンテンツ要素から、指定したテキスト パターンで要素のコンテンツを検索します。
getAttributes()Object要素の属性を取得します。
getAttributes(offset)Object指定された文字オフセットの属性を取得します。
getBackgroundColor()String背景色の設定を取得します。
getBackgroundColor(offset)String指定された文字オフセットの背景色を取得します。
getFontFamily()Stringフォント ファミリーの設定を取得します。
getFontFamily(offset)String指定された文字オフセットのフォント ファミリーを取得します。
getFontSize()Numberフォントサイズの設定を取得します。
getFontSize(offset)Number指定された文字オフセットのフォントサイズを取得します。
getForegroundColor()String前景色の色設定を取得します。
getForegroundColor(offset)String指定された文字オフセットで前景色を取得します。
getLinkUrl()Stringリンクの URL を取得します。
getLinkUrl(offset)String指定された文字オフセットのリンク URL を取得します。
getNextSibling()Element要素の次の兄弟要素を取得します。
getParent()ContainerElement要素の親要素を取得します。
getPreviousSibling()Element要素の前の兄弟要素を取得します。
getText()String要素のコンテンツをテキスト文字列として取得します。
getTextAlignment()TextAlignmentテキストの配置を取得します。
getTextAlignment(offset)TextAlignment1 文字のテキストの配置を取得します。
getTextAttributeIndices()Integer[]個別のテキスト形式の実行の開始に対応するテキスト インデックスのセットを取得します。
getType()ElementType要素の ElementType を取得します。
insertText(offset, text)Text指定された文字を指定された文字オフセットに挿入します。
isAtDocumentEnd()Boolean要素が Document の末尾にあるかどうかを判断します。
isBold()Boolean太字の設定を取得します。
isBold(offset)Boolean指定された文字オフセットの太字設定を取得します。
isItalic()Boolean斜体の設定を取得します。
isItalic(offset)Boolean指定された文字オフセットの斜体設定を取得します。
isStrikethrough()Boolean取り消し線の設定を取得します。
isStrikethrough(offset)Boolean指定された文字オフセットの取り消し線設定を取得します。
isUnderline()Boolean下線の設定を取得します。
isUnderline(offset)Boolean指定された文字オフセットで下線の設定を取得します。
merge()Text同じタイプの先行する兄弟要素と要素を結合します。
removeFromParent()Text親から要素を削除します。
replaceText(searchPattern, replacement)Element正規表現を使用して、特定のテキスト パターンをすべて特定の置換文字列に置き換えます。
setAttributes(startOffset, endOffsetInclusive, attributes)Text指定した属性を指定された文字範囲に適用します。
setAttributes(attributes)Text要素の属性を設定します。
setBackgroundColor(startOffset, endOffsetInclusive, color)Text指定した文字範囲の背景色を設定します。
setBackgroundColor(color)Text背景色を設定します。
setBold(bold)Text太字を設定します。
setBold(startOffset, endOffsetInclusive, bold)Text指定した文字範囲を太字に設定します。
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)Text指定された文字範囲のフォント ファミリーを設定します。
setFontFamily(fontFamilyName)Textフォント ファミリーを設定します。
setFontSize(startOffset, endOffsetInclusive, size)Text指定した文字範囲のフォントサイズを設定します。
setFontSize(size)Textフォントサイズを設定します。
setForegroundColor(startOffset, endOffsetInclusive, color)Text指定した文字範囲の前景色を設定します。
setForegroundColor(color)Text前景色を設定します。
setItalic(italic)Text斜体を設定します。
setItalic(startOffset, endOffsetInclusive, italic)Text指定した文字範囲の斜体を設定します。
setLinkUrl(startOffset, endOffsetInclusive, url)Text指定した文字範囲のリンク URL を設定します。
setLinkUrl(url)Textリンクの URL を設定します。
setStrikethrough(strikethrough)Text取り消し線の設定を設定します。
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)Text指定した文字範囲に取り消し線を設定します。
setText(text)Textテキスト コンテンツを設定します。
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)Text指定した文字範囲のテキストの配置を設定します。
setTextAlignment(textAlignment)Textテキストの配置を設定します。
setUnderline(underline)Text下線の設定を設定します。
setUnderline(startOffset, endOffsetInclusive, underline)Text指定された文字範囲の下線を設定します。

詳細なドキュメント

appendText(text)

指定したテキストをこのテキスト領域の最後に追加します。

パラメータ

名前説明
textString追加するテキスト

戻る

Text - 現在の要素。

認可

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

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

copy()

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

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

戻る

Text - 新しいコピー。

認可

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

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

deleteText(startOffset, endOffsetInclusive)

テキストの範囲を削除します。

パラメータ

名前説明
startOffsetInteger最初に削除する文字の文字オフセット
endOffsetInclusiveInteger削除する最後の文字の文字オフセット

戻る

Text - 現在の要素。

認可

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

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

editAsText()

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

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

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

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 - 現在の要素のテキスト バージョン。


findText(searchPattern)

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

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

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

パラメータ

名前説明
searchPatternString検索するパターン

戻る

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

認可

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

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

findText(searchPattern, from)

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

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

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

パラメータ

名前説明
searchPatternString検索するパターン
fromRangeElement検索元の検索結果

戻る

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

getAttributes(offset)

指定された文字オフセットの属性を取得します。

結果は、有効なテキスト属性ごとにプロパティを含むオブジェクトになります。各プロパティ名は、DocumentApp.Attribute 列挙型内のアイテムに対応しています。

パラメータ

名前説明
offsetInteger文字オフセット

戻る

Object - 要素の属性

認可

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

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

getBackgroundColor()

背景色の設定を取得します。

戻る

String - 背景色。CSS 表記('#ffffff' など)で書式設定します。この属性に複数の値が含まれている場合は、null になります。

認可

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

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

getBackgroundColor(offset)

指定された文字オフセットの背景色を取得します。

パラメータ

名前説明
offsetInteger文字オフセット

戻る

String - 背景色。CSS 表記形式('#ffffff' など)で指定します。

認可

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

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

getFontFamily()

フォント ファミリーの設定を取得します。名前は、ドキュメントの [フォント] メニューまたは Google Fonts の任意のフォントで、大文字と小文字が区別されます。メソッド getFontFamily()setFontFamily(fontFamilyName) は、フォントに FontFamily 列挙型ではなく文字列名を使用するようになりました。この列挙型は非推奨になっていますが、古いスクリプトとの互換性のために引き続き使用できます。

戻る

String - フォント ファミリー。要素にこの属性に複数の値が含まれている場合は null になります。

認可

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

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

getFontFamily(offset)

指定された文字オフセットのフォント ファミリーを取得します。名前は、ドキュメントのフォント メニューまたは Google Fonts の任意のフォントで、大文字と小文字が区別されます。メソッド getFontFamily()setFontFamily(fontFamilyName) は、フォントに FontFamily 列挙型ではなく文字列名を使用するようになりました。この列挙型は非推奨になっていますが、古いスクリプトとの互換性のために引き続き使用できます。

パラメータ

名前説明
offsetInteger文字オフセット

戻る

String - フォント ファミリー

認可

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

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

getFontSize()

フォントサイズの設定を取得します。

戻る

Number - フォントサイズ。または、この属性に複数の値が要素に含まれている場合は null になります。

認可

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

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

getFontSize(offset)

指定された文字オフセットのフォントサイズを取得します。

パラメータ

名前説明
offsetInteger文字オフセット

戻る

Number - フォントサイズ

認可

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

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

getForegroundColor()

前景色の色設定を取得します。

戻る

String - 前景色。CSS 表記('#ffffff' など)で指定します。この属性に複数の値が含まれている場合は null になります。

認可

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

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

getForegroundColor(offset)

指定された文字オフセットで前景色を取得します。

パラメータ

名前説明
offsetInteger文字オフセット

戻る

String - 前景色。CSS 表記形式('#ffffff' など)で指定します。

認可

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

getLinkUrl(offset)

指定された文字オフセットのリンク URL を取得します。

パラメータ

名前説明
offsetInteger文字オフセット

戻る

String - リンクの URL

認可

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

getText()

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

戻る

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

認可

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

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

getTextAlignment()

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

戻る

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

認可

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

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

getTextAlignment(offset)

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

パラメータ

名前説明
offsetInteger文字のオフセット

戻る

TextAlignment - テキストの配置のタイプ。テキストの配置を設定したことがない場合は null

認可

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

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

getTextAttributeIndices()

個別のテキスト形式の実行の開始に対応するテキスト インデックスのセットを取得します。

戻る

Integer[] - テキスト形式を変更するテキスト インデックスのセット

認可

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

insertText(offset, text)

指定された文字を指定された文字オフセットに挿入します。

パラメータ

名前説明
offsetInteger挿入する文字オフセット
textString挿入するテキスト

戻る

Text - 現在の要素。

認可

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

isBold()

太字の設定を取得します。

戻る

Boolean - テキストが太字かどうかを指定します。この属性に複数の値が含まれている場合は、この属性に null を指定します。

認可

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

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

isBold(offset)

指定された文字オフセットの太字設定を取得します。

パラメータ

名前説明
offsetInteger文字オフセット

戻る

Boolean - 太字の設定

認可

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

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

isItalic()

斜体の設定を取得します。

戻る

Boolean - テキストが斜体であるかどうか、または要素にこの属性に複数の値が含まれている場合は null かどうか

認可

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

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

isItalic(offset)

指定された文字オフセットの斜体設定を取得します。

パラメータ

名前説明
offsetInteger文字オフセット

戻る

Boolean - 斜体の設定

認可

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

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

isStrikethrough()

取り消し線の設定を取得します。

戻る

Boolean - テキストに取り消し線を付けるかどうかを指定します。要素にこの属性に複数の値が含まれている場合は null を指定します。

認可

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

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

isStrikethrough(offset)

指定された文字オフセットの取り消し線設定を取得します。

パラメータ

名前説明
offsetInteger文字オフセット

戻る

Boolean - 取り消し線の設定

認可

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

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

isUnderline()

下線の設定を取得します。

戻る

Boolean - テキストに下線を付けるか、要素にこの属性に複数の値が含まれている場合は null を指定します。

認可

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

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

isUnderline(offset)

指定された文字オフセットで下線の設定を取得します。

パラメータ

名前説明
offsetInteger文字オフセット

戻る

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

戻る

Text - マージされた要素。

認可

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

戻る

Text - 削除された要素。

認可

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

パラメータ

名前説明
searchPatternString検索する正規表現パターン
replacementString置換として使用するテキスト

戻る

Element - 現在の要素。

認可

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

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

setAttributes(startOffset, endOffsetInclusive, attributes)

指定された属性を指定された文字範囲に適用します。

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

パラメータ

名前説明
startOffsetIntegerテキスト範囲の開始オフセット
endOffsetInclusiveIntegerテキスト範囲の終了オフセット
attributesObject要素の属性

戻る

Text - 現在の要素。

認可

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

パラメータ

名前説明
attributesObject要素の属性。

戻る

Text - 現在の要素。

認可

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

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

setBackgroundColor(startOffset, endOffsetInclusive, color)

指定した文字範囲の背景色を設定します。

パラメータ

名前説明
startOffsetIntegerテキスト範囲の開始オフセット
endOffsetInclusiveIntegerテキスト範囲の終了オフセット
colorString背景色(CSS 表記形式、'#ffffff' など)。

戻る

Text - 現在の要素。

認可

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

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

setBackgroundColor(color)

背景色を設定します。

パラメータ

名前説明
colorString背景色(CSS 表記形式、'#ffffff' など)。

戻る

Text - 現在の要素。

認可

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

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

setBold(bold)

太字を設定します。

パラメータ

名前説明
boldBoolean太字の設定

戻る

Text - 現在の要素。

認可

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

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

setBold(startOffset, endOffsetInclusive, bold)

指定した文字範囲を太字に設定します。

パラメータ

名前説明
startOffsetIntegerテキスト範囲の開始オフセット
endOffsetInclusiveIntegerテキスト範囲の終了オフセット
boldBoolean太字の設定

戻る

Text - 現在の要素。

認可

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

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

setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)

指定された文字範囲のフォント ファミリーを設定します。名前は、ドキュメントのフォント メニューまたは Google Fonts の任意のフォントで、大文字と小文字が区別されます。 認識できないフォント名は Arial として表示されます。getFontFamily(offset) メソッドと setFontFamily(fontFamilyName) メソッドが、フォントに FontFamily 列挙型ではなく文字列名を使用するようになりました。この列挙型は非推奨になっていますが、古いスクリプトとの互換性のために引き続き使用できます。

パラメータ

名前説明
startOffsetIntegerテキスト範囲の開始オフセット
endOffsetInclusiveIntegerテキスト範囲の終了オフセット
fontFamilyNameStringフォント ファミリーの名前(ドキュメントの [フォント] メニューまたは Google Fonts)

戻る

Text - 現在の要素。

認可

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

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

setFontFamily(fontFamilyName)

フォント ファミリーを設定します。名前は、ドキュメントの [フォント] メニューまたは Google Fonts の任意のフォントで、大文字と小文字が区別されます。認識されないフォント名は italic として表示されます。getFontFamily() メソッドと setFontFamily(fontFamilyName) メソッドが、フォントに FontFamily 列挙型ではなく文字列名を使用するようになりました。この列挙型は非推奨になっていますが、古いスクリプトとの互換性のために引き続き使用できます。

パラメータ

名前説明
fontFamilyNameStringフォント ファミリーの名前(ドキュメントの [フォント] メニューまたは Google Fonts)

戻る

Text - 現在の要素。

認可

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

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

setFontSize(startOffset, endOffsetInclusive, size)

指定した文字範囲のフォントサイズを設定します。

パラメータ

名前説明
startOffsetIntegerテキスト範囲の開始オフセット
endOffsetInclusiveIntegerテキスト範囲の終了オフセット
sizeNumberフォント サイズ

戻る

Text - 現在の要素。

認可

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

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

setFontSize(size)

フォントサイズを設定します。

パラメータ

名前説明
sizeNumberフォント サイズ

戻る

Text - 現在の要素。

認可

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

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

setForegroundColor(startOffset, endOffsetInclusive, color)

指定した文字範囲の前景色を設定します。

パラメータ

名前説明
startOffsetIntegerテキスト範囲の開始オフセット
endOffsetInclusiveIntegerテキスト範囲の終了オフセット
colorString前景色、CSS 表記形式('#ffffff' など)

戻る

Text - 現在の要素。

認可

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

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

setForegroundColor(color)

前景色を設定します。

パラメータ

名前説明
colorString前景色、CSS 表記形式('#ffffff' など)

戻る

Text - 現在の要素。

認可

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

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

setItalic(italic)

斜体を設定します。

パラメータ

名前説明
italicBoolean斜体の設定

戻る

Text - 現在の要素。

認可

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

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

setItalic(startOffset, endOffsetInclusive, italic)

指定した文字範囲の斜体を設定します。

パラメータ

名前説明
startOffsetIntegerテキスト範囲の開始オフセット
endOffsetInclusiveIntegerテキスト範囲の終了オフセット
italicBoolean斜体の設定

戻る

Text - 現在の要素。

認可

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

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

setLinkUrl(startOffset, endOffsetInclusive, url)

指定した文字範囲のリンク URL を設定します。

パラメータ

名前説明
startOffsetIntegerテキスト範囲の開始オフセット
endOffsetInclusiveIntegerテキスト範囲の終了オフセット
urlStringリンクの URL

戻る

Text - 現在の要素。

認可

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

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

setLinkUrl(url)

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

パラメータ

名前説明
urlStringリンクの URL

戻る

Text - 現在の要素。

認可

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

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

setStrikethrough(strikethrough)

取り消し線の設定を設定します。

パラメータ

名前説明
strikethroughBoolean取り消し線の設定

戻る

Text - 現在の要素。

認可

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

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

setStrikethrough(startOffset, endOffsetInclusive, strikethrough)

指定した文字範囲に取り消し線を設定します。

パラメータ

名前説明
startOffsetIntegerテキスト範囲の開始オフセット
endOffsetInclusiveIntegerテキスト範囲の終了オフセット
strikethroughBoolean取り消し線の設定

戻る

Text - 現在の要素。

認可

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

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

setText(text)

テキスト コンテンツを設定します。

パラメータ

名前説明
textString新しいテキスト コンテンツ

戻る

Text - 現在の要素。

認可

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

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

setTextAlignment(startOffset, endOffsetInclusive, textAlignment)

指定した文字範囲のテキストの配置を設定します。使用可能なアライメントのタイプは、DocumentApp.TextAlignment.NORMALDocumentApp.TextAlignment.SUBSCRIPTDocumentApp.TextAlignment.SUPERSCRIPT です。

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

パラメータ

名前説明
startOffsetInteger文字範囲の開始オフセット
endOffsetInclusiveInteger文字範囲の終了オフセット(その範囲を含む)
textAlignmentTextAlignment適用するテキストの配置タイプ

戻る

Text - 現在の要素。

認可

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

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

setTextAlignment(textAlignment)

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

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

パラメータ

名前説明
textAlignmentTextAlignment適用するテキストの配置タイプ

戻る

Text - 現在の要素。

認可

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

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

setUnderline(underline)

下線の設定を設定します。

パラメータ

名前説明
underlineBoolean下線の設定

戻る

Text - 現在の要素。

認可

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

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

setUnderline(startOffset, endOffsetInclusive, underline)

指定された文字範囲の下線を設定します。

パラメータ

名前説明
startOffsetIntegerテキスト範囲の開始オフセット
endOffsetInclusiveIntegerテキスト範囲の終了オフセット
underlineBoolean下線の設定

戻る

Text - 現在の要素。

認可

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

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