Class HorizontalRule

HorizontalRule

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

الطُرق

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

الوثائق التفصيلية

copy()

لعرض نسخة عميقة منفصلة من العنصر الحالي.

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

استرجاع الكرة

HorizontalRule — النسخة الجديدة

التفويض

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

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

getAttributes()

لاسترداد سمات العنصر.

والنتيجة هي كائن يحتوي على سمة لكل سمة عنصر صالحة حيث يتجاوب كل اسم خاصية مع عنصر في التعداد DocumentApp.Attribute.

var body = DocumentApp.getActiveDocument().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 body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document 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 body = DocumentApp.getActiveDocument().getBody();

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

استرجاع الكرة

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

التفويض

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

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

setAttributes(attributes)

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

يجب أن تكون معلمة السمات المحددة كائنًا يكون فيه كل اسم للخاصية عنصرًا في التعداد DocumentApp.Attribute وتكون كل قيمة للخاصية هي القيمة الجديدة المطلوب تطبيقها.

var body = DocumentApp.getActiveDocument().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);

المَعلمات

الاسمTypeالوصف
attributesObjectتمثّل هذه السمة سمات العنصر.

استرجاع الكرة

HorizontalRule - العنصر الحالي

التفويض

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

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