汎用要素。Document
の内容は要素として表されます。たとえば、List
、Paragraph
、Table
は要素であり、Element
で定義されたすべてのメソッド(get
など)を継承します。
クラスの実装
名前 | 概要 |
---|---|
Body | Google ドキュメント ドキュメントのタブの内容。 |
Container | 他の要素を含めることができる汎用要素。 |
Date | 日付の書式を指定した要素 |
Equation | 数式を表す要素。 |
Equation | 数学的な Equation で関数を表す要素。 |
Equation | 数学的な Equation の関数区切りを表す要素。 |
Equation | 数学的な Equation の記号を表す要素。 |
Footer | フッター セクションを表す要素。 |
Footnote | 脚注を表す要素。 |
Footnote | 脚注セクションを表す要素。 |
Header | ヘッダー セクションを表す要素。 |
Horizontal | 水平線を表す要素。 |
Inline | 埋め込まれた図形を表す要素。 |
Inline | 埋め込み画像を表す要素。 |
List | リストアイテムを表す要素。 |
Page | ページ分割を表す要素。 |
Paragraph | 段落を表す要素。 |
Person | 人物へのリンクを表す要素。 |
Rich | Google リソース(ドライブのファイルや YouTube 動画など)へのリンクを表す要素。 |
Table | テーブルを表す要素。 |
Table | テーブルセルを表す要素。 |
Table | 目次を含む要素。 |
Table | テーブルの行を表す要素。 |
Text | リッチテキスト領域を表す要素。 |
Unsupported | ページ番号など、不明な領域またはスクリプトの影響を受けない領域を表す要素。 |
メソッド
詳細なドキュメント
as Body()
as Date()
as Equation()
as Equation Function()
現在の要素を Equation
として返します。
このメソッドは、特定の要素が特定のタイプであることがわかっている場合に、自動入力を支援するために使用します。
戻る
Equation
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Equation Function Argument Separator()
現在の要素を Equation
として返します。
このメソッドは、特定の要素が特定のタイプであることがわかっている場合に、自動入力を支援するために使用します。
戻る
Equation
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Equation Symbol()
現在の要素を Equation
として返します。
このメソッドは、特定の要素が特定のタイプであることがわかっている場合に、自動入力を支援するために使用します。
戻る
Equation
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Footnote()
as Footnote Section()
現在の要素を Footnote
として返します。
このメソッドは、特定の要素が特定のタイプであることがわかっている場合に、自動入力を支援するために使用します。
戻る
Footnote
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Header Section()
現在の要素を Header
として返します。
このメソッドは、特定の要素が特定のタイプであることがわかっている場合に、自動入力を支援するために使用します。
戻る
Header
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Horizontal Rule()
現在の要素を Horizontal
として返します。
このメソッドは、特定の要素が特定のタイプであることがわかっている場合に、自動入力を支援するために使用します。
戻る
Horizontal
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Inline Drawing()
現在の要素を Inline
として返します。
このメソッドは、特定の要素が特定のタイプであることがわかっている場合に、自動入力を支援するために使用します。
戻る
Inline
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Inline Image()
現在の要素を Inline
として返します。
このメソッドは、特定の要素が特定のタイプであることがわかっている場合に、自動入力を支援するために使用します。
戻る
Inline
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as List Item()
as Page Break()
as Paragraph()
as Person()
現在の要素を Person
として返します。
要素が Person
であることを確認したら、このメソッドを使用してそのタイプを人物に設定します。これにより、Apps Script エディタのオートコンプリートで、ユーザー要素で使用できるメソッドが表示されます。
戻る
Person
- タイプが Person
に設定された現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Rich Link()
現在の要素を Rich
として返します(Google スプレッドシート ファイルへのリンクなど)。
要素が Rich
であることを確認したら、このメソッドを使用してそのタイプを Rich
に設定します。これにより、Apps Script エディタのオートコンプリートで、Rich
で使用できるメソッドが表示されます。
戻る
Rich
- タイプが Rich
に設定された現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Table()
as Table Cell()
as Table Of Contents()
現在の要素を Table
として返します。
このメソッドは、特定の要素が特定のタイプであることがわかっている場合に、自動入力を支援するために使用します。
戻る
Table
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Table Row()
as Text()
copy()
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 Next Sibling()
get Parent()
要素の親要素を取得します。
親要素には現在の要素が含まれています。
戻る
Container
- 親要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
get Previous Sibling()
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
is At Document End()
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();
戻る
Element
- 統合された要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 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(); }
戻る
Element
- 削除された要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 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 | 要素の属性。 |
戻る
Element
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents