Class PageBreak

فاصل الصفحة

عنصر يمثّل فاصل صفحة يمكن أن يتضمّن PageBreak ListItem أو Paragraph، ما لم يكن ListItem أو Paragraph ضمن Table أو HeaderSection أو FooterSection أو FootnoteSection. لا يمكن أن يحتوي PageBreak على أي عنصر آخر. لمزيد من المعلومات حول بنية المستند، يُرجى الاطّلاع على دليل توسيع نطاق استخدام Google Docs.

الطُرق

الطريقة	نوع القيمة التي يتم عرضها	وصف قصير
copy()	PageBreak	تعرِض نسخة مفصَّلة ومُفصَّلة من العنصر الحالي.
getAttributes()	Object	يسترجع سمات العنصر.
getNextSibling()	Element	يسترجع العنصر الشقيق التالي للعنصر.
getParent()	ContainerElement	يسترجع العنصر الرئيسي للعنصر.
getPreviousSibling()	Element	يسترجع العنصر الشقيق السابق للعنصر.
getType()	ElementType	يسترجع ElementType للعنصر.
isAtDocumentEnd()	Boolean	لتحديد ما إذا كان العنصر في نهاية Document
removeFromParent()	PageBreak	تزيل العنصر من العنصر الرئيسي.
setAttributes(attributes)	PageBreak	تُستخدَم لضبط سمات العنصر.

مستندات تفصيلية

copy()

تعرِض نسخة مفصَّلة ومُفصَّلة من العنصر الحالي.

ويتم أيضًا نسخ أي عناصر فرعية متوفّرة في العنصر. لا يحتوي العنصر الجديد على عنصر رئيسي.

الإرجاع

PageBreak: النسخة الجديدة

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

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

---

getAttributes()

يسترجع سمات العنصر.

والنتيجة هي عنصر يحتوي على سمة لكل سمة عنصر صالحة، حيث يتوافق كل اسم سمة مع عنصر في التعداد DocumentApp.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

---

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() لتحديد النوع الدقيق لعنصر معيّن.

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.');
}

الإرجاع

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

---

removeFromParent()

تزيل العنصر من العنصر الرئيسي.

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();
}

الإرجاع

PageBreak: العنصر الذي تمّت إزالته

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

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

---

setAttributes(attributes)

تُستخدَم لضبط سمات العنصر.

يجب أن تكون مَعلمة السمات المحدّدة عنصرًا يكون فيه كل اسم خاصية عنصرًا في التعداد DocumentApp.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	سمات العنصر

الإرجاع

PageBreak: العنصر الحالي

التفويض

تتطلّب النصوص البرمجية التي تستخدِم هذه الطريقة الحصول على إذن واحد أو أكثر من النطاقات التالية:

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