عنصری که نشان دهنده پیوند به یک شخص است. پیوند شخص به یک آدرس ایمیل اشاره دارد و ممکن است به صورت اختیاری یک نام مرتبط با آدرس داشته باشد. اگر نام تنظیم شده باشد، نام همان چیزی است که در بدنه سند نمایش داده می شود.
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
copy() | Person | یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند. |
getAttributes() | Object | ویژگی های عنصر را بازیابی می کند. |
getEmail() | String | آدرس ایمیل شخص را برمی گرداند. |
getName() | String | در صورت تنظیم، نام نمایشی شخص را برمیگرداند. |
getNextSibling() | Element | عنصر خواهر و برادر بعدی عنصر را بازیابی می کند. |
getParent() | ContainerElement | عنصر والد عنصر را بازیابی می کند. |
getPreviousSibling() | Element | عنصر خواهر و برادر قبلی عنصر را بازیابی می کند. |
getType() | ElementType | ElementType عنصر را بازیابی می کند. |
isAtDocumentEnd() | Boolean | تعیین می کند که آیا عنصر در انتهای Document قرار دارد یا خیر. |
merge() | Person | عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند. |
removeFromParent() | Person | عنصر را از والد خود حذف می کند. |
setAttributes(attributes) | Person | ویژگی های عنصر را تنظیم می کند. |
مستندات دقیق
copy()
یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند.
هر عنصر فرزند موجود در عنصر نیز کپی می شود. عنصر جدید والد ندارد.
بازگشت
Person
- نسخه جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
- ویژگی های عنصر.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getEmail()
آدرس ایمیل شخص را برمی گرداند.
بازگشت
String
- آدرس ایمیل شخص.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getName()
در صورت تنظیم، نام نمایشی شخص را برمیگرداند.
بازگشت
String
- نام نمایشی پیوند شخص، یا اگر عنصر به جای آن آدرس ایمیل را نمایش دهد، null
.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
عنصر خواهر و برادر بعدی عنصر را بازیابی می کند.
خواهر و برادر بعدی همان والد را دارد و از عنصر فعلی پیروی می کند.
بازگشت
Element
- عنصر خواهر و برادر بعدی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
عنصر والد عنصر را بازیابی می کند.
عنصر والد حاوی عنصر فعلی است.
بازگشت
ContainerElement
- عنصر والد.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
عنصر خواهر و برادر قبلی عنصر را بازیابی می کند.
خواهر و برادر قبلی والد مشابهی دارد و مقدم بر عنصر فعلی است.
بازگشت
Element
- عنصر خواهر و برادر قبلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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
- نوع عنصر.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
تعیین می کند که آیا عنصر در انتهای Document
قرار دارد یا خیر.
بازگشت
Boolean
- اینکه آیا عنصر در انتهای برگه است.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
عنصر را با خواهر و برادر قبلی از همان نوع ادغام می کند.
فقط عناصر همان ElementType
را می توان ادغام کرد. هر عنصر فرزند موجود در عنصر فعلی به عنصر خواهر و برادر قبلی منتقل می شود.
عنصر فعلی از سند حذف می شود.
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();
بازگشت
Person
- عنصر ادغام شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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(); }
بازگشت
Person
- عنصر حذف شده.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
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 | ویژگی های عنصر |
بازگشت
Person
- عنصر فعلی.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents