ドライブ ファイルや YouTube 動画などの Google リソースへのリンクを表す要素。
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
copy() | RichLink | 現在の要素の分離されたディープコピーを返します。 |
getAttributes() | Object | 要素の属性を取得します。 |
getMimeType() | String | 次の MIME タイプを返します。
リンク(アイテムがドライブ ファイルへのリンクであり、null の場合に使用できます)
できません。 |
getNextSibling() | Element | 要素の次の兄弟要素を取得します。 |
getParent() | ContainerElement | 要素の親要素を取得します。 |
getPreviousSibling() | Element | 要素の前の兄弟要素を取得します。 |
getTitle() | String | リンクの表示タイトルを返します。 |
getType() | ElementType | 要素の ElementType を取得します。 |
getUrl() | String | リソースの URL を返します。 |
isAtDocumentEnd() | Boolean | 要素が Document の最後にあるかどうかを決定します。 |
merge() | RichLink | 要素を、先行する同じ型の兄弟要素と結合します。 |
removeFromParent() | RichLink | 要素を親から削除します。 |
setAttributes(attributes) | RichLink | 要素の属性を設定します。 |
詳細なドキュメント
copy()
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
getMimeType()
次の MIME タイプを返します。
リンク(アイテムがドライブ ファイルへのリンクであり、null
の場合に使用できます)
できません。
たとえば、リンクが Google ドキュメント ファイルを指している場合、文字列
application/vnd.google-apps.document
が返されます。
戻る
String
- リンクの MIME タイプ(利用可能な場合)。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
getParent()
要素の親要素を取得します。
親要素には現在の要素が含まれます。
戻る
ContainerElement
- 親要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
getTitle()
リンクの表示タイトルを返します。このタイトルは、
リンクの挿入日時または最終更新時刻。たとえば、このリンクが Google
「Analysis」というタイトルのドキュメントをAnalysis
を返します。
戻る
String
- リンクの表示タイトル。
承認
このメソッドを使用するスクリプトには、次のスコープの 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
getUrl()
リソースの URL を返します。
戻る
String
- リソースの URL。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
merge()
要素を、先行する同じ型の兄弟要素と結合します。
結合できるのは同じ ElementType
の要素のみです。Deployment に含まれる子要素は、
現在の要素は前の兄弟要素に移動されます。
現在の要素がドキュメントから削除されます。
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); var body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. 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();
戻る
RichLink
- マージされた要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 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(); }
戻る
RichLink
- 削除された要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 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 | 要素の属性。 |
戻る
RichLink
- 現在の要素。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上を使用した承認が必要です。
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents