Class PageBreak

PageBreak

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

الطُرق

الطريقة	نوع الإرجاع	وصف قصير
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.

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

---

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

---

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

الإرجاع

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

التفويض

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

• 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	سمات العنصر.

الإرجاع

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

التفويض

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

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