عنصری که نشاندهندهی یک شکست صفحه است. یک Page Break میتواند درون یک List Item یا Paragraph قرار گیرد، مگر اینکه List Item یا Paragraph درون یک Table ، Header Section ، Footer Section یا Footnote Section باشد. یک Page Break نمیتواند خود شامل هیچ عنصر دیگری باشد. برای اطلاعات بیشتر در مورد ساختار سند، به راهنمای گسترش Google Docs مراجعه کنید.
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
copy() | Page Break | یک کپی جدا و عمیق از عنصر فعلی را برمیگرداند. |
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 قرار دارد یا خیر. |
remove From Parent() | Page Break |null | عنصر را از والدش حذف میکند. |
set Attributes(attributes) | Page Break | ویژگیهای عنصر را تنظیم میکند. |
مستندات دقیق
copy()
یک کپی جدا و عمیق از عنصر فعلی را برمیگرداند.
هر عنصر فرزندی که در عنصر وجود داشته باشد نیز کپی میشود. عنصر جدید والد ندارد.
بازگشت
Page Break - نسخه جدید.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
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
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 Break |null — عنصر حذف شده.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
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 | ویژگیهای عنصر. |
بازگشت
Page Break - عنصر فعلی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents