تمت ترجمة هذه الصفحة بواسطة 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`	لاسترداد سمات العنصر\u39s.
`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`'s.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	إنشاء `HorizontalRule` جديدة وإدراجها في الفهرس المحدّد.
`insertImage(childIndex, image)`	`InlineImage`	إنشاء وإدراج `InlineImage` من كائن الصورة الثنائي الكبير، في الفهرس المحدد.
`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`	تحدد سمات العنصر\u39;s.
`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).

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

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)`

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

المعلّمات

الاسم	النوع	الوصف
`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;
  }
}

المعلّمات

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

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

النتيجة هي كائن يحتوي على خاصية لكل سمة عنصر صالحة حيث يتوافق كل اسم سمة مع عنصر في تعداد 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.");
}

المعلّمات

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

لاسترداد عدد العناصر الثانوية

// 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's.

استخدِم 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 جديدة.

المعلّمات

الاسم	النوع	الوصف
`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 جديدة وإدراجها في الفهرس المحدّد، مع تضمين محتوى النص المحدّد.

المعلّمات

الاسم	النوع	الوصف
`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 جديدة وإدراجها في الفهرس المحدّد، مع تضمين محتوى النص المحدّد.

المعلّمات

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

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

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\u39; ، ما يحدّ من البنية المتوافقة.

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

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

تحدد سمات العنصر\u39;s.

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

المعلّمات

الاسم	النوع	الوصف
`attributes`	`Object`	سمات العنصر\39;s.

تذكرة ذهاب وعودة

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 be superscript.
var text = DocumentApp.getActiveDocument().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