تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

Class HeaderSection
تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

عنصر يمثّل قسم عنوان يحتوي Document عادةً على HeaderSection واحد كحد أقصى. قد يحتوي العنصر HeaderSection على عناصر ListItem وParagraph و Table. لمزيد من المعلومات عن بنية المستند، يُرجى الاطّلاع على دليل توسيع نطاق "مستندات Google".

الطُرق

الطريقة	نوع القيمة التي يتم عرضها	وصف قصير
`appendHorizontalRule()`	`HorizontalRule`	لإنشاء `HorizontalRule` جديد وإضافته
`appendImage(image)`	`InlineImage`	لإنشاء `InlineImage` جديد وإضافته من قطعة الصورة المحدّدة
`appendImage(image)`	`InlineImage`	إلحاق `InlineImage` المحدَّد
`appendListItem(listItem)`	`ListItem`	إلحاق `ListItem` المحدَّد
`appendListItem(text)`	`ListItem`	لإنشاء `ListItem` جديدة وإضافتها تحتوي على محتوى النص المحدّد
`appendParagraph(paragraph)`	`Paragraph`	إلحاق `Paragraph` المحدَّد
`appendParagraph(text)`	`Paragraph`	لإنشاء `Paragraph` جديدة وإضافتها تحتوي على محتوى النص المحدّد
`appendTable()`	`Table`	لإنشاء `Table` جديد وإضافته
`appendTable(cells)`	`Table`	إلحاق `Table` جديد يحتوي على `TableCell` لكل قيمة سلسلة محدّدة
`appendTable(table)`	`Table`	إلحاق `Table` المحدَّد
`clear()`	`HeaderSection`	تمحو محتويات العنصر.
`copy()`	`HeaderSection`	تعرِض نسخة مفصَّلة ومُفصَّلة من العنصر الحالي.
`editAsText()`	`Text`	الحصول على نسخة `Text` من العنصر الحالي لتعديلها
`findElement(elementType)`	`RangeElement`	تبحث في محتوى العنصر عن سلف من النوع المحدّد.
`findElement(elementType, from)`	`RangeElement`	تبحث في محتويات العنصر عن عنصر فرعي من النوع المحدّد، بدءًا من`RangeElement` المحدّد.
`findText(searchPattern)`	`RangeElement`	تبحث في محتوى العنصر عن النمط النصي المحدّد باستخدام التعبيرات العادية.
`findText(searchPattern, from)`	`RangeElement`	البحث في محتوى العنصر عن نمط النص المحدّد، بدءًا من نتيجة بحث معيّنة
`getAttributes()`	`Object`	يسترجع سمات العنصر.
`getChild(childIndex)`	`Element`	يسترجع العنصر الفرعي في فهرس العنصر الفرعي المحدّد.
`getChildIndex(child)`	`Integer`	يسترجع فهرس العنصر الفرعي للعنصر الفرعي المحدّد.
`getImages()`	`InlineImage[]`	يسترجع جميع `InlineImages` المتوفّرة في القسم.
`getListItems()`	`ListItem[]`	يسترجع جميع `ListItems` المتوفّرة في القسم.
`getNumChildren()`	`Integer`	يسترجع عدد الأطفال.
`getParagraphs()`	`Paragraph[]`	يسترجع جميع `Paragraphs` المتوفّرة في القسم (بما في ذلك `ListItems`).
`getParent()`	`ContainerElement`	يسترجع العنصر الرئيسي للعنصر.
`getTables()`	`Table[]`	يسترجع جميع `Tables` المتوفّرة في القسم.
`getText()`	`String`	يسترجع محتوى العنصر كسلسلة نصية.
`getTextAlignment()`	`TextAlignment`	الحصول على محاذاة النص
`getType()`	`ElementType`	يسترجع `ElementType` للعنصر.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	لإنشاء `HorizontalRule` جديدة وإدراجها في الفهرس المحدّد
`insertImage(childIndex, image)`	`InlineImage`	تُنشئ هذه الدالة عنصر `InlineImage` وتُدرِجه من قطعة بيانات الصورة المحدّدة في الترتيب المحدّد.
`insertImage(childIndex, image)`	`InlineImage`	تُدرج `InlineImage` المحدّدة في الفهرس المحدّد.
`insertListItem(childIndex, listItem)`	`ListItem`	تُدرج `ListItem` المحدّدة في الفهرس المحدّد.
`insertListItem(childIndex, text)`	`ListItem`	تُنشئ هذه الدالة `ListItem` جديدة وتُدرِجها في الفهرس المحدّد، وتتضمّن محتوًى `ListItem`محددًا.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	تُدرج `Paragraph` المحدّدة في الفهرس المحدّد.
`insertParagraph(childIndex, text)`	`Paragraph`	تُنشئ هذه الدالة `Paragraph` جديدة وتُدرِجها في الفهرس المحدّد، وتتضمّن محتوًى `Paragraph`محددًا.
`insertTable(childIndex)`	`Table`	لإنشاء `Table` جديدة وإدراجها في الفهرس المحدّد
`insertTable(childIndex, cells)`	`Table`	تُنشئ هذه الدالة صفيفًا `Table` جديدًا يحتوي على الخلايا المحدّدة وتُدرِجه في الفهرس المحدّد.
`insertTable(childIndex, table)`	`Table`	تُدرج `Table` المحدّدة في الفهرس المحدّد.
`removeChild(child)`	`HeaderSection`	تزيل العنصر الفرعي المحدّد.
`removeFromParent()`	`HeaderSection`	تزيل العنصر من العنصر الرئيسي.
`replaceText(searchPattern, replacement)`	`Element`	لاستبدال جميع مظاهر نمط نصي معيّن بسلسلة بديل معيّنة، باستخدام تعبيرات عادية.
`setAttributes(attributes)`	`HeaderSection`	تُستخدَم لضبط سمات العنصر.
`setText(text)`	`HeaderSection`	لضبط المحتوى كنص عادي
`setTextAlignment(textAlignment)`	`HeaderSection`	لضبط محاذاة النص

الطرق المتوقّفة

الطريقة	نوع القيمة التي يتم عرضها	وصف قصير
`getFootnotes()`	`Footnote[]`	يسترجع جميع `Footnotes` المتوفّرة في القسم.
`getLinkUrl()`	`String`	يستردّ عنوان URL للرابط.
`getNextSibling()`	`Element`	يسترجع العنصر الشقيق التالي للعنصر.
`getPreviousSibling()`	`Element`	يسترجع العنصر الشقيق السابق للعنصر.
`isAtDocumentEnd()`	`Boolean`	لتحديد ما إذا كان العنصر في نهاية `Document`
`setLinkUrl(url)`	`HeaderSection`	لضبط عنوان URL للرابط

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

`appendHorizontalRule()`

لإنشاء HorizontalRule جديد وإضافته

سيتم تضمين HorizontalRule في Paragraph جديد.

الإرجاع

HorizontalRule: الخط الأفقي الجديد

التفويض

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

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

`appendImage(image)`

لإنشاء InlineImage جديد وإضافته من قطعة الصورة المحدّدة

ستتم تضمين الصورة في Paragraph جديد.

المعلمات

الاسم	النوع	الوصف
`image`	`BlobSource`	بيانات الصورة

الإرجاع

InlineImage: الصورة المُرفَقة

التفويض

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

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

`appendImage(image)`

إلحاق InlineImage المحدَّد

سيتم تضمين InlineImage في Paragraph جديد.

استخدِم هذا الإصدار من appendImage عند إلحاق نسخة من InlineImage حالية.

المعلمات

الاسم	النوع	الوصف
`image`	`InlineImage`	بيانات الصورة

الإرجاع

InlineImage: الصورة المُرفَقة

التفويض

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

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

`appendListItem(listItem)`

إلحاق ListItem المحدَّد

استخدِم هذا الإصدار من appendListItem عند إلحاق نسخة من ListItem حالية.

المعلمات

الاسم	النوع	الوصف
`listItem`	`ListItem`	عنصر القائمة المطلوب إلحاقه

الإرجاع

ListItem: عنصر القائمة المُضاف.

التفويض

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

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

`appendListItem(text)`

لإنشاء ListItem جديدة وإضافتها تحتوي على محتوى النص المحدّد

تتم إضافة عناصر القائمة المتتالية كجزء من القائمة نفسها.

المعلمات

الاسم	النوع	الوصف
`text`	`String`	محتوى النص لعنصر القائمة.

الإرجاع

ListItem: عنصر القائمة الجديد.

التفويض

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

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

`appendParagraph(paragraph)`

إلحاق Paragraph المحدَّد

استخدِم هذا الإصدار من appendParagraph عند إلحاق نسخة من Paragraph حالية.

المعلمات

الاسم	النوع	الوصف
`paragraph`	`Paragraph`	الفقرة المطلوب إلحاقها.

الإرجاع

Paragraph: الفقرة المُرفَقة.

التفويض

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

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

`appendParagraph(text)`

لإنشاء Paragraph جديدة وإضافتها تحتوي على محتوى النص المحدّد

المعلمات

الاسم	النوع	الوصف
`text`	`String`	محتوى النص في الفقرة

الإرجاع

Paragraph: الفقرة الجديدة.

التفويض

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

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

`appendTable()`

لإنشاء Table جديد وإضافته

ستُلحق هذه الطريقة أيضًا فقرة فارغة بعد الجدول، لأنّه لا يمكن أن تنتهي مستندات "مستندات Google" بجدول.

الإرجاع

Table: الجدول الجديد

التفويض

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

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

`appendTable(cells)`

إلحاق Table جديد يحتوي على TableCell لكل قيمة سلسلة محدّدة

ستُلحق هذه الطريقة أيضًا فقرة فارغة بعد الجدول، لأنّه لا يمكن أن تنتهي مستندات "مستندات Google" بجدول.

المعلمات

الاسم	النوع	الوصف
`cells`	`String[][]`	محتوى النصوص في خلايا الجدول المطلوب إضافتها إلى الجدول الجديد

الإرجاع

Table - الجدول المُرفَق.

التفويض

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

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

`appendTable(table)`

إلحاق Table المحدَّد

استخدِم هذا الإصدار من appendTable عند إلحاق نسخة من Table حالية. ستُلحق هذه الطريقة أيضًا فقرة فارغة بعد الجدول، لأنّه لا يمكن أن تنتهي مستندات "مستندات Google" بجدول.

المعلمات

الاسم	النوع	الوصف
`table`	`Table`	الجدول المطلوب إلحاقه.

الإرجاع

Table - الجدول المُرفَق.

التفويض

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

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

`clear()`

تمحو محتويات العنصر.

الإرجاع

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

`copy()`

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

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

الإرجاع

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

التفويض

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

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

`editAsText()`

الحصول على نسخة Text من العنصر الحالي لتعديلها

استخدِم editAsText لتعديل محتوى العناصر كنص منسق. يتجاهل وضع editAsText العناصر غير النصية (مثل InlineImage وHorizontalRule).

تتم إزالة العناصر الفرعية المضمّنة بالكامل ضمن نطاق نص تم حذفه من العنصر.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

الإرجاع

Text: نسخة نصية للعنصر الحالي

`findElement(elementType)`

تبحث في محتوى العنصر عن سلف من النوع المحدّد.

المعلمات

الاسم	النوع	الوصف
`elementType`	`ElementType`	نوع العنصر المطلوب البحث عنه

الإرجاع

RangeElement - نتيجة بحث تشير إلى موضع عنصر البحث

التفويض

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

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

`findElement(elementType, from)`

تبحث في محتويات العنصر عن عنصر فرعي من النوع المحدّد، بدءًا منRangeElement المحدّد.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

المعلمات

الاسم	النوع	الوصف
`elementType`	`ElementType`	نوع العنصر المطلوب البحث عنه
`from`	`RangeElement`	نتيجة البحث التي تريد البحث منها

الإرجاع

RangeElement: نتيجة بحث تشير إلى الموضع التالي لعنصر البحث

التفويض

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

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

`findText(searchPattern)`

تبحث في محتوى العنصر عن النمط النصي المحدّد باستخدام التعبيرات العادية.

لا تتوفّر مجموعة فرعية من ميزات التعبير العادي في JavaScript بالكامل، مثل مجموعات الالتقاط وعوامل تعديل الوضع.

تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كلّ كتلة نص مضمّنة في العنصر الحالي.

المعلمات

الاسم	النوع	الوصف
`searchPattern`	`String`	النمط المطلوب البحث عنه

الإرجاع

RangeElement: نتيجة بحث تشير إلى موضع نص البحث، أو قيمة فارغة في حال عدم توفّر مطابقة

التفويض

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

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

`findText(searchPattern, from)`

البحث في محتوى العنصر عن نمط النص المحدّد، بدءًا من نتيجة بحث معيّنة

لا تتوفّر مجموعة فرعية من ميزات التعبير العادي في JavaScript بالكامل، مثل مجموعات الالتقاط وعوامل تعديل الوضع.

تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كلّ كتلة نص مضمّنة في العنصر الحالي.

المعلمات

الاسم	النوع	الوصف
`searchPattern`	`String`	النمط المطلوب البحث عنه
`from`	`RangeElement`	نتيجة البحث التي تريد البحث منها

الإرجاع

RangeElement: نتيجة بحث تشير إلى الموضع التالي لنص البحث، أو قيمة فارغة في حال عدم توفّر مطابقة

التفويض

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

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

`getChild(childIndex)`

يسترجع العنصر الفرعي في فهرس العنصر الفرعي المحدّد.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

المعلمات

الاسم	النوع	الوصف
`childIndex`	`Integer`	فهرس العنصر الفرعي الذي تريد استرجاعه

الإرجاع

Element: العنصر الثانوي في الفهرس المحدّد

التفويض

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

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

`getChildIndex(child)`

يسترجع فهرس العنصر الفرعي للعنصر الفرعي المحدّد.

المعلمات

الاسم	النوع	الوصف
`child`	`Element`	العنصر الفرعي الذي يتم استرداد الفهرس له.

الإرجاع

Integer - فهرس الطفل

التفويض

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

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

`getImages()`

يسترجع جميع InlineImages المتوفّرة في القسم.

الإرجاع

InlineImage[]: صور الأقسام

التفويض

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

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

`getListItems()`

يسترجع جميع ListItems المتوفّرة في القسم.

الإرجاع

ListItem[]: عناصر قائمة الأقسام

التفويض

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

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

`getNumChildren()`

يسترجع عدد الأطفال.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

الإرجاع

‫Integer: عدد الأطفال

التفويض

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

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

`getParagraphs()`

يسترجع جميع Paragraphs المتوفّرة في القسم (بما في ذلك ListItems).

الإرجاع

Paragraph[]: فقرات القسم

التفويض

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

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

`getTables()`

يسترجع جميع Tables المتوفّرة في القسم.

الإرجاع

Table[] - جداول الأقسام

التفويض

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

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

`getText()`

يسترجع محتوى العنصر كسلسلة نصية.

الإرجاع

‫String: محتوى العنصر بتنسيق سلسلة نصية

التفويض

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

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

`getTextAlignment()`

الحصول على محاذاة النص الأنواع المتاحة للمحاذاة هي DocumentApp.TextAlignment.NORMAL وDocumentApp.TextAlignment.SUBSCRIPT وDocumentApp.TextAlignment.SUPERSCRIPT.

الإرجاع

‫TextAlignment: نوع محاذاة النص، أو null إذا كان النص يحتوي على أنواع متعدّدة من محاذاة النص أو إذا لم يتم ضبط محاذاة النص مطلقًا

التفويض

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

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

`insertHorizontalRule(childIndex)`

لإنشاء HorizontalRule جديدة وإدراجها في الفهرس المحدّد

سيتم تضمين HorizontalRule في Paragraph جديد.

المعلمات

الاسم	النوع	الوصف
`childIndex`	`Integer`	الفهرس الذي سيتم إدراج العنصر فيه

الإرجاع

HorizontalRule: الخط الأفقي الجديد

التفويض

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

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

`insertImage(childIndex, image)`

تُنشئ هذه الدالة عنصر InlineImage وتُدرِجه من قطعة بيانات الصورة المحدّدة في الترتيب المحدّد.

المعلمات

الاسم	النوع	الوصف
`childIndex`	`Integer`	الفهرس الذي سيتم إدراج العنصر فيه
`image`	`BlobSource`	بيانات الصورة

الإرجاع

InlineImage: الصورة المضمّنة التي تم إدراجها

التفويض

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

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

`insertImage(childIndex, image)`

تُدرج InlineImage المحدّدة في الفهرس المحدّد.

ستتم تضمين الصورة في Paragraph جديد.

المعلمات

الاسم	النوع	الوصف
`childIndex`	`Integer`	الفهرس الذي سيتم إدراج العنصر فيه
`image`	`InlineImage`	الصورة المطلوب إدراجها.

الإرجاع

InlineImage: الصورة المضمّنة التي تم إدراجها

التفويض

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

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

`insertListItem(childIndex, listItem)`

تُدرج ListItem المحدّدة في الفهرس المحدّد.

المعلمات

الاسم	النوع	الوصف
`childIndex`	`Integer`	الفهرس الذي سيتمّ فيه الإدراج.
`listItem`	`ListItem`	عنصر القائمة المطلوب إدراجه

الإرجاع

ListItem: عنصر القائمة الذي تم إدراجه

التفويض

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

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

`insertListItem(childIndex, text)`

تُنشئ هذه الدالة ListItem جديدة وتُدرِجها في الفهرس المحدّد، وتتضمّن محتوًى ListItemمحددًا.

المعلمات

الاسم	النوع	الوصف
`childIndex`	`Integer`	الفهرس الذي سيتمّ فيه الإدراج.
`text`	`String`	محتوى النص لعنصر القائمة.

الإرجاع

ListItem: عنصر القائمة الجديد.

التفويض

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

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

`insertParagraph(childIndex, paragraph)`

تُدرج Paragraph المحدّدة في الفهرس المحدّد.

المعلمات

الاسم	النوع	الوصف
`childIndex`	`Integer`	الفهرس الذي سيتمّ فيه الإدراج.
`paragraph`	`Paragraph`	الفقرة المطلوب إدراجها.

الإرجاع

Paragraph: الفقرة التي تم إدراجها

التفويض

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

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

`insertParagraph(childIndex, text)`

تُنشئ هذه الدالة Paragraph جديدة وتُدرِجها في الفهرس المحدّد، وتتضمّن محتوًى Paragraphمحددًا.

المعلمات

الاسم	النوع	الوصف
`childIndex`	`Integer`	الفهرس الذي سيتمّ فيه الإدراج.
`text`	`String`	محتوى النص في الفقرة

الإرجاع

Paragraph: الفقرة الجديدة.

التفويض

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

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

`insertTable(childIndex)`

لإنشاء Table جديدة وإدراجها في الفهرس المحدّد

المعلمات

الاسم	النوع	الوصف
`childIndex`	`Integer`	الفهرس الذي سيتمّ فيه الإدراج.

الإرجاع

Table: الجدول الجديد

التفويض

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

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

`insertTable(childIndex, cells)`

تُنشئ هذه الدالة صفيفًا Table جديدًا يحتوي على الخلايا المحدّدة وتُدرِجه في الفهرس المحدّد.

المعلمات

الاسم	النوع	الوصف
`childIndex`	`Integer`	الفهرس الذي سيتمّ فيه الإدراج.
`cells`	`String[][]`	محتوى النصوص في خلايا الجدول المطلوب إضافتها إلى الجدول الجديد

الإرجاع

Table: الجدول الجديد

التفويض

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

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

`insertTable(childIndex, table)`

تُدرج Table المحدّدة في الفهرس المحدّد.

المعلمات

الاسم	النوع	الوصف
`childIndex`	`Integer`	الفهرس الذي سيتمّ فيه الإدراج.
`table`	`Table`	الجدول المطلوب إدراجه.

الإرجاع

Table: الجدول المُدرَج

التفويض

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

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

`removeChild(child)`

تزيل العنصر الفرعي المحدّد.

المعلمات

الاسم	النوع	الوصف
`child`	`Element`	العنصر الفرعي المطلوب إزالته

الإرجاع

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

التفويض

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

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

الإرجاع

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

التفويض

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

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

`replaceText(searchPattern, replacement)`

لاستبدال جميع مظاهر نمط نصي معيّن بسلسلة بديل معيّنة، باستخدام تعبيرات عادية.

يتم تمرير نمط البحث كسلسلة، وليس ككائن تعبير عادي في JavaScript. لهذا السبب، عليك إزالة أي شرطات سفلية في النمط.

تستخدِم هذه الطرق مكتبة RE2 للتعبيرات العادية من Google، ما يحدّ من البنية المتوافقة.

تتم مطابقة نمط التعبير العادي المقدَّم بشكل مستقل مع كلّ كتلة نص مضمّنة في العنصر الحالي.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

المعلمات

الاسم	النوع	الوصف
`searchPattern`	`String`	نمط التعبير العادي المطلوب البحث عنه
`replacement`	`String`	النص الذي سيتم استخدامه كبديل

الإرجاع

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

التفويض

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

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

الإرجاع

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

التفويض

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

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

`setText(text)`

لضبط المحتوى كنص عادي

ملاحظة: يتم محو المحتوى الحالي.

المعلمات

الاسم	النوع	الوصف
`text`	`String`	المحتوى النصي الجديد

الإرجاع

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

التفويض

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

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

`setTextAlignment(textAlignment)`

لضبط محاذاة النص الأنواع المتاحة للمحاذاة هي DocumentApp.TextAlignment.NORMAL وDocumentApp.TextAlignment.SUBSCRIPT وDocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

المعلمات

الاسم	النوع	الوصف
`textAlignment`	`TextAlignment`	نوع محاذاة النص المطلوب تطبيقها

الإرجاع

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

التفويض

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

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

الطرق المتوقّفة

`getFootnotes()`

تمّ إيقاف هذا العمود نهائيًا. لا يمكن أن يحتوي هذا العنصر على Footnote.

يسترجع جميع Footnotes المتوفّرة في القسم.

الإرجاع

Footnote[]: الحواشي السفلية للقسم

التفويض

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

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

`getLinkUrl()`

تمّ إيقاف هذا العمود نهائيًا. بدلاً من تطبيق رابط على قسم كامل، طبِّق الرابط على عنصر ضمن القسم بدلاً من ذلك.

يستردّ عنوان URL للرابط.

الإرجاع

String: عنوان URL للرابط، أو قيمة فارغة إذا كان العنصر يحتوي على قيم متعددة لهذه السمة

التفويض

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

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

`getPreviousSibling()`

تمّ إيقاف هذا العمود نهائيًا. لا يتضمّن هذا العنصر أي عناصر شقيقة.

يسترجع العنصر الشقيق السابق للعنصر.

يتضمّن العنصر الشقيق السابق العنصر الرئيسي نفسه ويسبق العنصر الحالي.

الإرجاع

Element: العنصر الشقيق السابق

التفويض

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

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

`isAtDocumentEnd()`

تمّ إيقاف هذا العمود نهائيًا. هذه الطريقة غير موثوقة في HeaderSection.

لتحديد ما إذا كان العنصر في نهاية Document

الإرجاع

‫Boolean — ما إذا كان العنصر في نهاية علامة التبويب

التفويض

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

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

`setLinkUrl(url)`

لضبط عنوان URL للرابط

المعلمات

الاسم	النوع	الوصف
`url`	`String`	عنوان URL للرابط

الإرجاع

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

التفويض

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

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

Class HeaderSection تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

الطُرق

الطرق المتوقّفة

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

appendHorizontalRule()

الإرجاع

التفويض

appendImage(image)

المعلمات

الإرجاع

التفويض

appendImage(image)

المعلمات

الإرجاع

التفويض

appendListItem(listItem)

المعلمات

الإرجاع

التفويض

appendListItem(text)

المعلمات

الإرجاع

التفويض

appendParagraph(paragraph)

المعلمات

الإرجاع

التفويض

appendParagraph(text)

المعلمات

الإرجاع

التفويض

appendTable()

الإرجاع

التفويض

appendTable(cells)

المعلمات

الإرجاع

التفويض

appendTable(table)

المعلمات

الإرجاع

التفويض

clear()

الإرجاع

copy()

الإرجاع

التفويض

editAsText()

الإرجاع

findElement(elementType)

المعلمات

الإرجاع

التفويض

findElement(elementType, from)

المعلمات

الإرجاع

التفويض

findText(searchPattern)

المعلمات

الإرجاع

التفويض

findText(searchPattern, from)

المعلمات

الإرجاع

التفويض

getAttributes()

الإرجاع

التفويض

getChild(childIndex)

المعلمات

الإرجاع

التفويض

getChildIndex(child)

المعلمات

الإرجاع

التفويض

getImages()

الإرجاع

التفويض

getListItems()

Class HeaderSection
تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.

`appendHorizontalRule()`

`appendImage(image)`

`appendImage(image)`

`appendListItem(listItem)`

`appendListItem(text)`

`appendParagraph(paragraph)`

`appendParagraph(text)`

`appendTable()`

`appendTable(cells)`

`appendTable(table)`

`clear()`

`copy()`

`editAsText()`

`findElement(elementType)`

`findElement(elementType, from)`

`findText(searchPattern)`

`findText(searchPattern, from)`

`getAttributes()`

`getChild(childIndex)`

`getChildIndex(child)`

`getImages()`

`getListItems()`

`getNumChildren()`

`getParagraphs()`

`getParent()`

`getTables()`

`getText()`

`getTextAlignment()`

`getType()`

`insertHorizontalRule(childIndex)`

`insertImage(childIndex, image)`

`insertImage(childIndex, image)`

`insertListItem(childIndex, listItem)`

`insertListItem(childIndex, text)`

`insertParagraph(childIndex, paragraph)`

`insertParagraph(childIndex, text)`

`insertTable(childIndex)`

`insertTable(childIndex, cells)`

`insertTable(childIndex, table)`

`removeChild(child)`

`removeFromParent()`