تمت ترجمة هذه الصفحة بواسطة 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` وتُدرجها من كائن ثنائي كبير (blob) للصورة المحدد، في الفهرس المحدد.
`insertImage(childIndex, image)`	`InlineImage`	لإدراج `InlineImage` المحدّد في الفهرس المحدّد.
`insertListItem(childIndex, listItem)`	`ListItem`	لإدراج `ListItem` المحدّد في الفهرس المحدّد.
`insertListItem(childIndex, text)`	`ListItem`	تنشئ هذه الدالة `ListItem` جديدة وتدرجها في الفهرس المحدّد، مع تضمين المحتوى النصي المحدّد.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	لإدراج `Paragraph` المحدّد في الفهرس المحدّد.
`insertParagraph(childIndex, text)`	`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 جديد.

المَعلمات

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

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

InlineImage — الصورة الملحقة

التفويض

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

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

`appendImage(image)`

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

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

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

المَعلمات

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

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

InlineImage — الصورة الملحقة

التفويض

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

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

`appendListItem(listItem)`

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

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

المَعلمات

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

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

ListItem — عنصر القائمة الملحق

التفويض

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

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

`appendListItem(text)`

لإنشاء ListItem جديد وإلحاقه بمحتوى النص المحدَّد.

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

المَعلمات

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

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

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

التفويض

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

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

`appendParagraph(paragraph)`

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

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

المَعلمات

الاسم	Type	الوصف
`paragraph`	`Paragraph`	الفقرة لإلحاقها

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

Paragraph — الفقرة الملحقة

التفويض

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

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

`appendParagraph(text)`

لإنشاء Paragraph جديد وإلحاقه بمحتوى النص المحدَّد.

المَعلمات

الاسم	Type	الوصف
`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 لكل قيمة سلسلة محدّدة.

المَعلمات

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

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

Table — الجدول الملحق

التفويض

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

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

`appendTable(table)`

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

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

المَعلمات

الاسم	Type	الوصف
`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).

تتم إزالة العناصر الثانوية الموجودة بالكامل داخل نطاق نصي محذوف من العنصر.

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

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

المَعلمات

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

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

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

التفويض

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

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

`findElement(elementType, from)`

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

المَعلمات

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

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

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

التفويض

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

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

`findText(searchPattern)`

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

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

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

المَعلمات

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

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

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

التفويض

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

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

`findText(searchPattern, from)`

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

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

المَعلمات

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

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

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

التفويض

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

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

`getChild(childIndex)`

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var 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.");
}

المَعلمات

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

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

Element - العنصر الفرعي في الفهرس المحدد

التفويض

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

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

`getChildIndex(child)`

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

المَعلمات

الاسم	Type	الوصف
`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()`

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

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document 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() لتحديد النوع الدقيق لعنصر معيّن.

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

`insertHorizontalRule(childIndex)`

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

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

المَعلمات

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

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

HorizontalRule - القاعدة الأفقية الجديدة

التفويض

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

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

`insertImage(childIndex, image)`

تنشئ هذه الدالة InlineImage وتُدرجها من كائن ثنائي كبير (blob) للصورة المحدد، في الفهرس المحدد.

المَعلمات

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

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

InlineImage - الصورة المضمّنة المُدرَجة

التفويض

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

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

`insertImage(childIndex, image)`

لإدراج InlineImage المحدّد في الفهرس المحدّد.

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

المَعلمات

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

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

InlineImage - الصورة المضمّنة المُدرَجة

التفويض

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

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

`insertListItem(childIndex, listItem)`

لإدراج ListItem المحدّد في الفهرس المحدّد.

المَعلمات

الاسم	Type	الوصف
`childIndex`	`Integer`	الفهرس الذي يمكن إدراج
`listItem`	`ListItem`	عنصر القائمة لإدراجه

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

ListItem — عنصر القائمة المدرج

التفويض

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

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

`insertListItem(childIndex, text)`

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

المَعلمات

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

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

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

التفويض

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

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

`insertParagraph(childIndex, paragraph)`

لإدراج Paragraph المحدّد في الفهرس المحدّد.

المَعلمات

الاسم	Type	الوصف
`childIndex`	`Integer`	الفهرس الذي يمكن إدراج
`paragraph`	`Paragraph`	الفقرة المراد إدراجها

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

Paragraph — الفقرة المدرجة

التفويض

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

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

`insertParagraph(childIndex, text)`

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

المَعلمات

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

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

Paragraph - الفقرة الجديدة

التفويض

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

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

`insertTable(childIndex)`

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

المَعلمات

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

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

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

التفويض

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

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

`insertTable(childIndex, cells)`

لإنشاء وإدراج Table جديد يحتوي على الخلايا المحددة، في الفهرس المحدد.

المَعلمات

الاسم	Type	الوصف
`childIndex`	`Integer`	الفهرس الذي يمكن إدراج
`cells`	`String[][]`	محتويات النص في خلايا الجدول لإضافتها إلى الجدول الجديد

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

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

التفويض

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

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

`insertTable(childIndex, table)`

لإدراج Table المحدّد في الفهرس المحدّد.

المَعلمات

الاسم	Type	الوصف
`childIndex`	`Integer`	الفهرس الذي يمكن إدراج
`table`	`Table`	الجدول لإدراج

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

Table — الجدول المدرج

التفويض

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

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

`removeChild(child)`

لإزالة العنصر الفرعي المحدد.

المَعلمات

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

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

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

التفويض

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

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

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

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

التفويض

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

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

`replaceText(searchPattern, replacement)`

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

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

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

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

var body = DocumentApp.getActiveDocument().getBody();

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

المَعلمات

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

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

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

التفويض

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

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	الوصف
`attributes`	`Object`	تمثّل هذه السمة سمات العنصر.

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

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

التفويض

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

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

`setText(text)`

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

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

المَعلمات

الاسم	Type	الوصف
`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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

المَعلمات

الاسم	Type	الوصف
`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 للرابط.

المَعلمات

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

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

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

التفويض

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

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