این صفحه به‌وسیله ‏Cloud Translation API‏ ترجمه شده است.

Class PageBreak

عنصری که نمایانگر شکست صفحه است. یک Page Break می توان در یک List Item یا Paragraph قرار داد، مگر اینکه آیتم یا Paragraph List Item در یک Table ، Header Section ، Footer Section یا Footnote Section باشد. یک Page Break خود نمی تواند حاوی هیچ عنصر دیگری باشد. برای اطلاعات بیشتر در مورد ساختار سند، راهنمای گسترش Google Docs را ببینید.

روش ها

روش	نوع برگشت	شرح مختصر
`copy()`	`Page Break`	یک کپی جدا شده و عمیق از عنصر فعلی را برمی گرداند.
`get Attributes()`	`Object`	ویژگی های عنصر را بازیابی می کند.
`get Next Sibling()`	`Element`	عنصر خواهر و برادر بعدی عنصر را بازیابی می کند.
`get Parent()`	`Container Element`	عنصر والد عنصر را بازیابی می کند.
`get Previous Sibling()`	`Element`	عنصر خواهر و برادر قبلی عنصر را بازیابی می کند.
`get Type()`	`Element Type`	`Element Type` عنصر را بازیابی می کند.
`is At Document End()`	`Boolean`	تعیین می کند که آیا عنصر در انتهای `Document` قرار دارد یا خیر.
`remove From Parent()`	`Page Break`	عنصر را از والد خود حذف می کند.
`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 - عنصر خواهر و برادر بعدی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`get Parent()`

عنصر والد عنصر را بازیابی می کند.

عنصر والد حاوی عنصر فعلی است.

بازگشت

Container Element - عنصر والد.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`get Previous Sibling()`

عنصر خواهر و برادر قبلی عنصر را بازیابی می کند.

خواهر و برادر قبلی والد مشابهی دارد و مقدم بر عنصر فعلی است.

بازگشت

Element - عنصر خواهر و برادر قبلی.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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 - عنصر حذف شده.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

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