リッチテキスト領域を表す要素。Document
内のすべてのテキストは Text
要素内に含まれます。Text
要素は Equation
、Equation
、List
、Paragraph
内に含めることができますが、他の要素を含めることはできません。ドキュメント構造の詳細については、Google ドキュメントの拡張に関するガイドをご覧ください。
// Gets the body contents of the active tab. const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Use editAsText to obtain a single text element containing // all the characters in the tab. const text = body.editAsText(); // Insert text at the beginning of the tab. text.insertText(0, 'Inserted text.\n'); // Insert text at the end of the tab. text.appendText('\nAppended text.'); // Make the first half of the tab blue. text.setForegroundColor(0, text.getText().length / 2, '#00FFFF');
メソッド
詳細なドキュメント
append Text(text)
指定したテキストをこのテキスト領域の末尾に追加します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Adds the text, 'Sample body text,' to the end of the tab body. const text = body.editAsText().appendText('Sample body text');
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | String | 追加するテキスト。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
copy()
delete Text(startOffset, endOffsetInclusive)
テキストの範囲を削除します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Deletes the first 10 characters in the body. const text = body.editAsText().deleteText(0, 9);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | 削除する最初の文字の文字オフセット。 |
end | Integer | 削除する最後の文字の文字オフセット。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
edit As Text()
編集用に現在の要素の Text
バージョンを取得します。
要素の内容をリッチ テキストとして操作するには、edit
を使用します。edit
モードでは、テキスト以外の要素(Inline
や Horizontal
など)は無視されます。
削除されたテキスト範囲に完全に含まれる子要素は、要素から削除されます。
const 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
- 現在の要素のテキスト バージョン
find Text(searchPattern)
正規表現を使用して、要素のコンテンツで指定されたテキスト パターンを検索します。
JavaScript 正規表現機能のサブセット(キャプチャ グループやモード修飾子など)は完全にはサポートされていません。
指定された正規表現パターンは、現在の要素に含まれる各テキスト ブロックと個別に照合されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
search | String | 検索するパターン |
戻る
Range
- 検索テキストの位置を示す検索結果。一致がない場合、null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
find Text(searchPattern, from)
指定された検索結果から、要素のコンテンツで指定されたテキスト パターンを検索します。
JavaScript 正規表現機能のサブセット(キャプチャ グループやモード修飾子など)は完全にはサポートされていません。
指定された正規表現パターンは、現在の要素に含まれる各テキスト ブロックと個別に照合されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
search | String | 検索するパターン |
from | Range | 検索結果 |
戻る
Range
- 検索テキストの次の位置を示す検索結果。一致がない場合、null です。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Attributes()
要素の属性を取得します。
結果は、有効な要素属性ごとにプロパティを含むオブジェクトです。各プロパティ名は、Document
列挙型の項目に対応しています。
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
戻る
Object
- 要素の属性。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Attributes(offset)
指定された文字オフセットの属性を取得します。
結果は、有効なテキスト属性ごとにプロパティを含むオブジェクトです。各プロパティ名は Document
列挙型の項目に対応しています。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Declares style attributes. const style = {}; style[DocumentApp.Attribute.BOLD] = true; style[DocumentApp.Attribute.ITALIC] = true; style[DocumentApp.Attribute.FONT_SIZE] = 29; // Sets the style attributes to the tab's body. const text = body.editAsText(); text.setAttributes(style); // Gets the style attributes applied to the eleventh character in the // body and logs them to the console. const attributes = text.getAttributes(10); console.log(attributes);
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | 文字のオフセット。 |
戻る
Object
- 要素の属性。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Background Color()
背景色の設定を取得します。
戻る
String
- 背景色(CSS 表記('#ffffff'
など)で指定)。要素にこの属性の値が複数含まれている場合は null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Background Color(offset)
指定された文字オフセットの背景色を取得します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the background color of the first 3 characters in the body. const text = body.editAsText().setBackgroundColor(0, 2, '#FFC0CB'); // Gets the background color of the first character in the body. const backgroundColor = text.getBackgroundColor(0); // Logs the background color to the console. console.log(backgroundColor);
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | 文字のオフセット。 |
戻る
String
- CSS 記法('#ffffff'
など)で書式設定された背景色。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Font Family()
フォント ファミリーの設定を取得します。名前には、ドキュメントの [フォント] メニューまたは Google Fonts の任意のフォントを使用できます。大文字と小文字が区別されます。メソッド get
と set
で、
列挙型ではなくフォント文字列名を使用するようになりました。この列挙型は非推奨ですが、古いスクリプトとの互換性を確保するために引き続き使用できます。Font
戻る
String
- フォント ファミリー。要素にこの属性の値が複数含まれている場合は null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Font Family(offset)
指定された文字オフセットのフォント ファミリーを取得します。名前には、ドキュメントの [フォント] メニューまたは Google Fonts の任意のフォントを使用できます。大文字と小文字は区別されます。メソッド get
と set
で、フォントには
列挙型ではなく文字列名を使用するようになりました。この列挙型は非推奨ですが、古いスクリプトとの互換性を確保するために引き続き使用できます。Font
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the font of the first 16 characters to Impact. const text = body.editAsText().setFontFamily(0, 15, 'Impact'); // Gets the font family of the 16th character in the tab body. const fontFamily = text.getFontFamily(15); // Logs the font family to the console. console.log(fontFamily);
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | 文字のオフセット。 |
戻る
String
- フォント ファミリー。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Font Size()
フォントサイズの設定を取得します。
戻る
Number
- フォントサイズ。要素にこの属性の値が複数含まれている場合は null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Font Size(offset)
指定された文字オフセットのフォントサイズを取得します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the font size of the first 13 characters to 15. const text = body.editAsText().setFontSize(0, 12, 15); // Gets the font size of the first character. const fontSize = text.getFontSize(0); // Logs the font size to the console. console.log(fontSize);
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | 文字のオフセット。 |
戻る
Number
- フォントサイズ。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Foreground Color()
前景色の設定を取得します。
戻る
String
- フォアグラウンド カラー(CSS 表記('#ffffff'
など)でフォーマット)。要素にこの属性の値が複数含まれている場合は null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Foreground Color(offset)
指定された文字オフセットの前景色を取得します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the foreground color of the first 3 characters in the tab body. const text = body.editAsText().setForegroundColor(0, 2, '#0000FF'); // Gets the foreground color of the first character in the tab body. const foregroundColor = text.getForegroundColor(0); // Logs the foreground color to the console. console.log(foregroundColor);
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | 文字のオフセット。 |
戻る
String
- CSS 記法('#ffffff'
など)でフォーマットされた前景色。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Link Url()
リンクの URL を取得します。
戻る
String
- リンク URL。要素にこの属性の値が複数含まれている場合は null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Link Url(offset)
指定された文字オフセットのリンク URL を取得します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Applies a link to the first 10 characters in the body. const text = body.editAsText().setLinkUrl(0, 9, 'https://www.example.com/'); // Gets the URL of the link from the first character. const link = text.getLinkUrl(0); // Logs the link URL to the console. console.log(link);
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | 文字のオフセット。 |
戻る
String
- リンクの URL。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Next Sibling()
get Parent()
要素の親要素を取得します。
親要素には現在の要素が含まれています。
戻る
Container
- 親要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Previous Sibling()
get Text()
要素のコンテンツをテキスト文字列として取得します。
戻る
String
- 要素の内容(テキスト文字列)
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text Alignment()
テキストの配置を取得します。使用できる配置のタイプは、Document
、Document
、Document
です。
戻る
Text
- テキストの配置のタイプ。テキストに複数のタイプのテキストの配置が含まれている場合、またはテキストの配置が設定されていない場合は null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text Alignment(offset)
1 文字のテキストの配置を取得します。使用できる配置のタイプは、Document
、Document
、Document
です。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the text alignment of the tab's body to NORMAL. const text = body.editAsText().setTextAlignment(DocumentApp.TextAlignment.NORMAL); // Gets the text alignment of the ninth character. const alignment = text.getTextAlignment(8); // Logs the text alignment to the console. console.log(alignment.toString());
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | 文字のオフセット。 |
戻る
Text
- テキストの配置のタイプ。テキストの配置が設定されていない場合は null
。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Text Attribute Indices()
個別のテキスト形式化実行の開始に対応するテキスト インデックスのセットを取得します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the text indices at which text formatting changes. const indices = body.editAsText().getTextAttributeIndices(); // Logs the indices to the console. console.log(indices.toString());
戻る
Integer[]
- テキストの書式が変更されるテキスト インデックスのセット。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Type()
要素の Element
を取得します。
get
を使用して、特定の要素の正確な型を判断します。
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const 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.'); }
戻る
Element
- 要素のタイプ。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insert Text(offset, text)
指定された文字オフセットに指定されたテキストを挿入します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Inserts the text, 'Sample inserted text', at the start of the body content. const text = body.editAsText().insertText(0, 'Sample inserted text');
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | テキストを挿入する文字オフセット。 |
text | String | 挿入するテキスト。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
is At Document End()
is Bold()
太字の設定を取得します。
戻る
Boolean
- テキストが太字かどうか。要素にこの属性の値が複数含まれている場合は null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
is Bold(offset)
指定された文字オフセットの太字設定を取得します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Bolds the first 4 characters in the tab body. const text = body.editAsText().setBold(0, 3, true); // Gets whether or not the text is bold. const bold = text.editAsText().isBold(0); // Logs the text's bold setting to the console console.log(bold);
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | 文字のオフセット。 |
戻る
Boolean
- 太字の設定。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
is Italic()
斜体の設定を取得します。
戻る
Boolean
- テキストが斜体かどうか。要素にこの属性の値が複数含まれている場合は null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
is Italic(offset)
指定された文字オフセットの斜体設定を取得します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the first 13 characters of the tab body to italic. const text = body.editAsText().setItalic(0, 12, true); // Gets whether the fifth character in the tab body is set to // italic and logs it to the console. const italic = text.isItalic(4); console.log(italic);
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | 文字のオフセット。 |
戻る
Boolean
- 斜体設定。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
is Strikethrough()
取り消し線の設定を取得します。
戻る
Boolean
- テキストが取り消し線付きかどうか。要素にこの属性の値が複数含まれている場合は null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
is Strikethrough(offset)
指定された文字オフセットの取り消し線の設定を取得します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the first 17 characters of the tab body to strikethrough. const text = body.editAsText().setStrikethrough(0, 16, true); // Gets whether the first character in the tab body is set to // strikethrough and logs it to the console. const strikethrough = text.isStrikethrough(0); console.log(strikethrough);
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | 文字のオフセット。 |
戻る
Boolean
- 取り消し線の設定。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
is Underline()
下線の設定を取得します。
戻る
Boolean
- テキストに下線が引かれるかどうか。要素にこの属性の値が複数含まれている場合は null
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
is Underline(offset)
指定された文字オフセットの下線設定を取得します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the first 13 characters of the tab body to underline. const text = body.editAsText().setUnderline(0, 12, false); // Gets whether the first character in the tab body is set to // underline and logs it to the console const underline = text.editAsText().isUnderline(0); console.log(underline);
パラメータ
名前 | 型 | 説明 |
---|---|---|
offset | Integer | 文字のオフセット。 |
戻る
Boolean
- 下線の設定。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
要素を、同じタイプの前の兄弟要素と統合します。
マージできるのは、同じ Element
の要素のみです。現在の要素に含まれる子要素は、前の兄弟要素に移動されます。
現在の要素がドキュメントから削除されます。
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. const par1 = body.appendParagraph('Paragraph 1.'); const 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. const cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'], ]; // Build a table from the array. const table = body.appendTable(cells); // Get the first row in the table. const row = table.getRow(0); // Get the two cells in this row. const cell1 = row.getCell(0); const cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. const merged = cell2.merge();
戻る
Text
- 統合された要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
remove From Parent()
要素を親から削除します。
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
戻る
Text
- 削除された要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replace Text(searchPattern, replacement)
正規表現を使用して、指定したテキスト パターンのすべての出現を指定された置換文字列に置き換えます。
検索パターンは、JavaScript 正規表現オブジェクトではなく、文字列として渡されます。そのため、パターン内のバックスラッシュをエスケープする必要があります。
このメソッドは Google の RE2 正規表現ライブラリを使用します。これにより、サポートされる構文が制限されます。
指定された正規表現パターンは、現在の要素に含まれる各テキスト ブロックに対して個別に照合されます。
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
パラメータ
名前 | 型 | 説明 |
---|---|---|
search | String | 検索する正規表現パターン |
replacement | String | 置換として使用するテキスト |
戻る
Element
- 現在の要素
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Attributes(startOffset, endOffsetInclusive, attributes)
指定した属性を指定された文字範囲に適用します。
指定された attributes パラメータは、各プロパティ名が Document
列挙型のアイテムで、各プロパティ値が適用される新しい値であるオブジェクトである必要があります。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Declares style attributes for font size and font family. const style = {}; style[DocumentApp.Attribute.FONT_SIZE] = 20; style[DocumentApp.Attribute.FONT_FAMILY] = 'Impact'; // Sets the style attributes to the first 9 characters in the tab's body. const text = body.setAttributes(0, 8, style);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | テキスト範囲の開始オフセット。 |
end | Integer | テキスト範囲の終了オフセット。 |
attributes | Object | 要素の属性。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Attributes(attributes)
要素の属性を設定します。
指定された attributes パラメータは、各プロパティ名が Document
列挙型のアイテムで、各プロパティ値が適用される新しい値であるオブジェクトである必要があります。
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const 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. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
パラメータ
名前 | 型 | 説明 |
---|---|---|
attributes | Object | 要素の属性。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Background Color(startOffset, endOffsetInclusive, color)
指定された文字範囲の背景色を設定します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the background color of the first 3 characters in the // tab body to hex color #0000FF. const text = body.editAsText().setBackgroundColor(0, 2, '#0000FF');
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | テキスト範囲の開始オフセット。 |
end | Integer | テキスト範囲の終了オフセット。 |
color | String | 背景色('#ffffff' など、CSS の記法で指定)。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Background Color(color)
set Bold(bold)
set Bold(startOffset, endOffsetInclusive, bold)
指定した文字範囲に太字の設定を適用します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the first 11 characters in the tab's body to bold. const text = body.editAsText().setBold(0, 10, true);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | テキスト範囲の開始オフセット。 |
end | Integer | テキスト範囲の終了オフセット。 |
bold | Boolean | 太字の設定。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Font Family(startOffset, endOffsetInclusive, fontFamilyName)
指定した文字範囲のフォント ファミリーを設定します。名前には、ドキュメントの [フォント] メニューまたは Google Fonts の任意のフォントを使用できます。大文字と小文字は区別されます。認識されないフォント名は Arial としてレンダリングされます。メソッド get
と set
で、
列挙型ではなくフォント文字列名を使用するようになりました。この列挙型は非推奨ですが、古いスクリプトとの互換性を確保するために引き続き使用できます。Font
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the font of the first 4 characters in the tab's body to Roboto. const text = body.editAsText().setFontFamily(0, 3, 'Roboto');
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | テキスト範囲の開始オフセット。 |
end | Integer | テキスト範囲の終了オフセット。 |
font | String | ドキュメントの [フォント] メニューまたは Google Fonts のフォント ファミリーの名前。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Font Family(fontFamilyName)
フォント ファミリーを設定します。名前には、ドキュメントの [フォント] メニューまたは Google Fonts の任意のフォントを使用できます。大文字と小文字が区別されます。認識されないフォント名は Arial としてレンダリングされます。メソッド get
と set
で、フォントには
列挙型ではなく文字列名を使用するようになりました。この列挙型は非推奨ですが、古いスクリプトとの互換性を確保するために引き続き使用できます。Font
パラメータ
名前 | 型 | 説明 |
---|---|---|
font | String | ドキュメントの [フォント] メニューまたは Google Fonts から選択したフォント ファミリーの名前 |
戻る
Text
- 現在の要素
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Font Size(startOffset, endOffsetInclusive, size)
指定した文字範囲のフォントサイズを設定します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the size of the first 11 characters in the tab's body to 12. const text = body.editAsText().setFontSize(0, 10, 12);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | テキスト範囲の開始オフセット。 |
end | Integer | テキスト範囲の終了オフセット。 |
size | Number | フォントサイズ。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Font Size(size)
set Foreground Color(startOffset, endOffsetInclusive, color)
指定した文字範囲のフォアグラウンド カラーを設定します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the foreground color of the first 2 characters in the // tab's body to hex color #FF0000. const text = body.editAsText().setForegroundColor(0, 1, '#FF0000'); // Gets the foreground color for the second character in the tab's body. const foregroundColor = text.getForegroundColor(1); // Logs the foreground color to the console. console.log(foregroundColor);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | テキスト範囲の開始オフセット。 |
end | Integer | テキスト範囲の終了オフセット。 |
color | String | 前景色(CSS 記法('#ffffff' など)でフォーマット)。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Foreground Color(color)
set Italic(italic)
set Italic(startOffset, endOffsetInclusive, italic)
指定した文字範囲に斜体設定を適用します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the first 11 characters in the tab's body to italic. const text = body.editAsText().setItalic(0, 10, true);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | テキスト範囲の開始オフセット。 |
end | Integer | テキスト範囲の終了オフセット。 |
italic | Boolean | 斜体設定。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Link Url(startOffset, endOffsetInclusive, url)
指定した文字範囲のリンク URL を設定します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Applies a link to the first 11 characters in the body. const text = body.editAsText().setLinkUrl(0, 10, 'https://example.com');
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | テキスト範囲の開始オフセット。 |
end | Integer | テキスト範囲の終了オフセット。 |
url | String | リンク URL です。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Link Url(url)
set Strikethrough(strikethrough)
set Strikethrough(startOffset, endOffsetInclusive, strikethrough)
指定した文字範囲の取り消し線の設定を設定します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the first 11 characters in the tab's body to strikethrough. const text = body.editAsText().setStrikethrough(0, 10, true);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | テキスト範囲の開始オフセット。 |
end | Integer | テキスト範囲の終了オフセット。 |
strikethrough | Boolean | 取り消し線の設定。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text(text)
テキスト コンテンツを設定します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Replaces the contents of the body with the text, 'New body text.' const text = body.editAsText().setText('New body text.');
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | String | 新しいテキスト コンテンツ。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text Alignment(startOffset, endOffsetInclusive, textAlignment)
指定した文字範囲のテキストの配置を設定します。使用できる配置のタイプは、Document
、Document
、Document
です。
// Make the first character in the first paragraph of the active tab be // superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(0, 0, DocumentApp.TextAlignment.SUPERSCRIPT);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | 文字範囲の開始オフセット。 |
end | Integer | 文字範囲の終了オフセット(この値を含む)。 |
text | Text | 適用するテキストの配置のタイプ。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Text Alignment(textAlignment)
テキストの配置を設定します。使用できる配置のタイプは、Document
、Document
、Document
です。
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | Text | 適用するテキストの配置の種類 |
戻る
Text
- 現在の要素
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
set Underline(underline)
set Underline(startOffset, endOffsetInclusive, underline)
指定した文字範囲の下線設定を設定します。
// Opens the Docs file by its URL. If you created your script from within a // Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the URL with your own. const doc = DocumentApp.openByUrl( 'https://docs.google.com/document/d/DOCUMENT_ID/edit', ); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Sets the first 11 characters in the tab's body to underline. const text = body.editAsText().setUnderline(0, 10, true);
パラメータ
名前 | 型 | 説明 |
---|---|---|
start | Integer | テキスト範囲の開始オフセット。 |
end | Integer | テキスト範囲の終了オフセット。 |
underline | Boolean | 下線の設定。 |
戻る
Text
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents