ヘッダー セクションを表す要素。Document
には通常、最大で 1 つの HeaderSection
が含まれます。HeaderSection
には、ListItem
、Paragraph
、および
Table
要素。ドキュメント構造について詳しくは、Google ドキュメントの拡張ガイドをご覧ください。
メソッド
詳細なドキュメント
appendHorizontalRule()
新しい HorizontalRule
を作成して追加します。
HorizontalRule
は新しい Paragraph
に含まれます。
戻る
HorizontalRule
- 新しい横方向のルール。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
指定された画像 blob から新しい InlineImage
を作成して追加します。
この画像は新しい Paragraph
に含まれます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
image | BlobSource | 画像データ。 |
戻る
InlineImage
- 追加された画像。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendImage(image)
指定された InlineImage
を追加します。
InlineImage
は新しい Paragraph
に含まれます。
既存の InlineImage
のコピーを追加するときに、このバージョンの appendImage
を使用します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
image | InlineImage | 画像データ。 |
戻る
InlineImage
- 追加された画像。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendListItem(listItem)
appendListItem(text)
appendParagraph(paragraph)
appendParagraph(text)
appendTable()
appendTable(cells)
指定された文字列値ごとに TableCell
を含む新しい Table
を追加します。
この方法でも、表の後に空の段落が追加されます。これは、Google ドキュメントでドキュメントが 末尾を表にすることはできません。
パラメータ
名前 | 型 | 説明 |
---|---|---|
cells | String[][] | 新しい表に追加する表のセルのテキスト コンテンツ。 |
戻る
Table
- 追加されたテーブル。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendTable(table)
指定された Table
を追加します。
既存の Table
のコピーを追加するときに、このバージョンの appendTable
を使用します。
この方法でも、表の後に空の段落が追加されます。これは、Google ドキュメントでドキュメントが
末尾を表にすることはできません。
パラメータ
名前 | 型 | 説明 |
---|---|---|
table | Table | 追加するテーブル。 |
戻る
Table
- 追加されたテーブル。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
現在の要素の分離されたディープコピーを返します。
その要素に含まれている子要素もすべてコピーされます。新しい要素には できます。
戻る
HeaderSection
- 新しいコピー。
承認
このメソッドを使用するスクリプトには、次のスコープの 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
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)
getImages()
セクションに含まれるすべての InlineImages
を取得します。
戻る
InlineImage[]
- セクション画像。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getListItems()
セクションに含まれるすべての ListItems
を取得します。
戻る
ListItem[]
- セクション リストの項目。
承認
このメソッドを使用するスクリプトには、次のスコープの 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
getParagraphs()
セクションに含まれるすべての Paragraphs
(ListItems
を含む)を取得します。
戻る
Paragraph[]
— セクションの段落。
承認
このメソッドを使用するスクリプトには、次のスコープの 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
getTables()
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
insertHorizontalRule(childIndex)
新しい HorizontalRule
を作成して指定されたインデックスに挿入します。
HorizontalRule
は新しい Paragraph
に含まれます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
childIndex | Integer | 要素を挿入するインデックス。 |
戻る
HorizontalRule
- 新しい横方向のルール。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
指定された画像 blob から InlineImage
を作成して、指定された場所に挿入します。
あります。
パラメータ
名前 | 型 | 説明 |
---|---|---|
childIndex | Integer | 要素を挿入するインデックス。 |
image | BlobSource | 画像データ。 |
戻る
InlineImage
- 挿入されるインライン画像。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertImage(childIndex, image)
指定された InlineImage
を指定されたインデックスに挿入します。
この画像は新しい Paragraph
に含まれます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
childIndex | Integer | 要素を挿入するインデックス。 |
image | InlineImage | 挿入する画像。 |
戻る
InlineImage
- 挿入されるインライン画像。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertListItem(childIndex, listItem)
insertListItem(childIndex, text)
insertParagraph(childIndex, paragraph)
insertParagraph(childIndex, text)
insertTable(childIndex)
insertTable(childIndex, cells)
insertTable(childIndex, table)
removeChild(child)
指定した子要素を削除します。
パラメータ
名前 | 型 | 説明 |
---|---|---|
child | Element | 削除する子要素。 |
戻る
HeaderSection
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 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(); }
戻る
HeaderSection
- 削除された要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 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 | 要素の属性。 |
戻る
HeaderSection
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
コンテンツを書式なしテキストとして設定します。
注: 既存の内容は消去されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
text | String | 新しいテキスト コンテンツ。 |
戻る
HeaderSection
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 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 | 適用するテキスト配置のタイプ |
戻る
HeaderSection
- 現在の要素
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents