ページ分割を表す要素。List
または Paragraph
が Table
、Header
、Footer
、Footnote
内にある場合を除き、Page
は List
または Paragraph
内に含めることができます。Page
自体に他の要素を含めることはできません。ドキュメント構造の詳細については、Google ドキュメントの拡張に関するガイドをご覧ください。
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | Page | 現在の要素の切断されたディープコピーを返します。 |
get | Object | 要素の属性を取得します。 |
get | Element | 要素の次の兄弟要素を取得します。 |
get | Container | 要素の親要素を取得します。 |
get | Element | 要素の前の兄弟要素を取得します。 |
get | Element | 要素の Element を取得します。 |
is | Boolean | 要素が Document の末尾にあるかどうかを判断します。 |
remove | Page | 要素を親から削除します。 |
set | Page | 要素の属性を設定します。 |
詳細なドキュメント
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()
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(); }
戻る
Page
- 削除された要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 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 | 要素の属性。 |
戻る
Page
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents