عنصری که نمایانگر یک ترسیم جاسازیشده است. یک Inline Drawing میتواند درون یک List Item یا Paragraph قرار گیرد، مگر اینکه List Item یا Paragraph درون یک Footnote Section باشد. یک Inline Drawing نمیتواند خود شامل هیچ عنصر دیگری باشد. برای اطلاعات بیشتر در مورد ساختار سند، به راهنمای توسعه Google Docs مراجعه کنید.
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
copy() | Inline Drawing | یک کپی جدا و عمیق از عنصر فعلی را برمیگرداند. |
get Alt Description() | String|null | توضیحات جایگزین نقاشی را برمیگرداند. |
get Alt Title() | String|null | عنوان جایگزین نقاشی را برمیگرداند. |
get Attributes() | Object | ویژگیهای عنصر را بازیابی میکند. |
get Next Sibling() | Element |null | عنصر خواهر یا برادر بعدی عنصر را بازیابی میکند. |
get Parent() | Container Element |null | عنصر والد عنصر را بازیابی میکند. |
get Previous Sibling() | Element |null | عنصر خواهر و برادر قبلی عنصر را بازیابی میکند. |
get Type() | Element Type | Element Type را بازیابی میکند. |
is At Document End() | Boolean | تعیین میکند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | Inline Drawing |null | عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام میکند. |
remove From Parent() | Inline Drawing |null | عنصر را از والدش حذف میکند. |
set Alt Description(description) | Inline Drawing | توضیحات جایگزین نقاشی را تنظیم میکند. |
set Alt Title(title) | Inline Drawing | عنوان جایگزین نقاشی را تنظیم میکند. |
set Attributes(attributes) | Inline Drawing | ویژگیهای عنصر را تنظیم میکند. |
مستندات دقیق
copy()
یک کپی جدا و عمیق از عنصر فعلی را برمیگرداند.
هر عنصر فرزندی که در عنصر وجود داشته باشد نیز کپی میشود. عنصر جدید والد ندارد.
بازگشت
Inline Drawing - نسخه جدید.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Alt Description()
توضیحات جایگزین نقاشی را برمیگرداند.
بازگشت
String|null — توصیف جایگزین، یا اگر عنصر توصیف جایگزینی نداشته باشد، null .
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Alt Title()
عنوان جایگزین نقاشی را برمیگرداند.
بازگشت
String|null — عنوان جایگزین، یا null اگر عنصر عنوان جایگزینی نداشته باشد.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Attributes()
ویژگیهای عنصر را بازیابی میکند.
نتیجه، یک شیء حاوی یک ویژگی برای هر ویژگی عنصر معتبر است که در آن هر نام ویژگی با یک آیتم در شمارش Document App.Attribute مطابقت دارد.
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 - ویژگیهای عنصر.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Next Sibling()
عنصر خواهر یا برادر بعدی عنصر را بازیابی میکند.
خواهر یا برادر بعدی، والد یکسانی دارد و عنصر فعلی را دنبال میکند.
بازگشت
Element |null — عنصر خواهر یا برادر بعدی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Parent()
عنصر والد عنصر را بازیابی میکند.
عنصر والد شامل عنصر فعلی است.
بازگشت
Container Element |null — عنصر والد.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Previous Sibling()
عنصر خواهر و برادر قبلی عنصر را بازیابی میکند.
عنصر خواهر یا برادر قبلی، والد یکسانی دارد و قبل از عنصر فعلی قرار میگیرد.
بازگشت
Element |null — عنصر خواهر یا برادر قبلی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
get Type()
Element Type را بازیابی میکند.
برای تعیین نوع دقیق یک عنصر داده شده، get Type() استفاده کنید.
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 Type - نوع عنصر.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
is At Document End()
تعیین میکند که آیا عنصر در انتهای Document قرار دارد یا خیر.
بازگشت
Boolean - اینکه آیا عنصر در انتهای تب قرار دارد یا خیر.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
merge()
عنصر را با عنصر خواهر یا برادر قبلی از همان نوع ادغام میکند.
فقط عناصری که از Element Type یکسانی هستند میتوانند ادغام شوند. هر عنصر فرزندی که در عنصر فعلی قرار داشته باشد، به عنصر خواهر و برادر قبلی منتقل میشود.
عنصر فعلی از سند حذف میشود.
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();
بازگشت
Inline Drawing |null — عنصر ادغامشده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
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(); }
بازگشت
Inline Drawing |null — عنصر حذفشده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Alt Description(description)
توضیحات جایگزین ترسیم را تنظیم میکند. اگر توضیحات داده شده null باشد، توضیحات را روی رشته خالی تنظیم میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
description | String | توضیحات جایگزین. |
بازگشت
Inline Drawing - شیء فعلی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Alt Title(title)
عنوان جایگزین نقاشی را تنظیم میکند. اگر عنوان داده شده null باشد، عنوان را روی رشته خالی تنظیم میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
title | String | عنوان جایگزین. |
بازگشت
Inline Drawing - شیء فعلی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
set Attributes(attributes)
ویژگیهای عنصر را تنظیم میکند.
پارامتر ویژگیهای مشخصشده باید یک شیء باشد که در آن نام هر ویژگی، یک آیتم در شمارش Document App.Attribute است و مقدار هر ویژگی، مقدار جدیدی است که باید اعمال شود.
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 | ویژگیهای عنصر. |
بازگشت
Inline Drawing - عنصر فعلی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents