تمت ترجمة هذه الصفحة بواسطة 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\|null`	يبحث في محتوى العنصر عن عنصر فرعي من النوع المحدّد.
`findElement(elementType, from)`	`RangeElement\|null`	يبحث في محتويات العنصر عن عنصر فرعي من النوع المحدّد، بدءًا من `RangeElement` المحدّد.
`findText(searchPattern)`	`RangeElement\|null`	يبحث في محتوى العنصر عن نمط النص المحدّد باستخدام التعبيرات العادية.
`findText(searchPattern, from)`	`RangeElement\|null`	يبحث في محتوى العنصر عن نمط النص المحدّد، بدءًا من نتيجة بحث معيّنة.
`getAttributes()`	`Object`	يستردّ سمات العنصر.
`getChild(childIndex)`	`Element`	يستردّ العنصر الفرعي في فهرس العنصر الفرعي المحدّد.
`getChildIndex(child)`	`Integer`	يستردّ هذا الإجراء فهرس العنصر الفرعي للعنصر الفرعي المحدّد.
`getImages()`	`InlineImage[]\|null`	يستردّ هذا الإجراء جميع `InlineImages` الواردة في القسم.
`getListItems()`	`ListItem[]\|null`	يستردّ هذا الإجراء جميع `ListItems` الواردة في القسم.
`getNumChildren()`	`Integer`	تعرض هذه السمة عدد الأطفال.
`getParagraphs()`	`Paragraph[]\|null`	تعرض هذه السمة جميع `Paragraphs` الواردة في القسم (بما في ذلك `ListItems`).
`getParent()`	`ContainerElement\|null`	تعرض هذه السمة العنصر الرئيسي للعنصر الحالي.
`getTables()`	`Table[]\|null`	يستردّ هذا الإجراء جميع `Tables` الواردة في القسم.
`getText()`	`String`	تعرض محتوى العنصر كسلسلة نصية.
`getTextAlignment()`	`TextAlignment\|null`	تعرض هذه السمة محاذاة النص.
`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` جديدًا وتُدرجه في الفهرس المحدّد، على أن يتضمّن محتوى النص المحدّد.
`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\|null`	يزيل العنصر من العنصر الأصل.
`replaceText(searchPattern, replacement)`	`Element`	لاستبدال جميع تكرارات نمط نصي معيّن بسلسلة استبدال معيّنة، باستخدام التعبيرات العادية.
`setAttributes(attributes)`	`HeaderSection`	تضبط هذه السمة سمات العنصر.
`setText(text)`	`HeaderSection`	يضبط المحتوى كنص عادي.
`setTextAlignment(textAlignment)`	`HeaderSection`	تضبط هذه السمة محاذاة النص.

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

الطريقة	نوع القيمة التي يتم إرجاعها	وصف قصير
`getFootnotes()`	`Footnote[]\|null`	يستردّ هذا الإجراء جميع `Footnotes` الواردة في القسم.
`getLinkUrl()`	`String\|null`	تعرض هذه السمة عنوان 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|null: نتيجة بحث تشير إلى موضع عنصر البحث.

التفويض

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

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|null: نتيجة بحث تشير إلى الموضع التالي لعنصر البحث.

التفويض

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

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

`findText(searchPattern)`

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

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

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

المعلمات

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

الإرجاع

‫RangeElement|null — نتيجة بحث تشير إلى موضع نص البحث، أو قيمة فارغة إذا لم تكن هناك أي مطابقة

التفويض

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

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

`findText(searchPattern, from)`

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

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

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

المعلمات

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

الإرجاع

‫RangeElement|null: نتيجة بحث تشير إلى الموضع التالي لنص البحث، أو قيمة فارغة إذا لم تكن هناك أي مطابقة

التفويض

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

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[]|null: صور الأقسام

التفويض

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

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

`getListItems()`

يستردّ هذا الإجراء جميع ListItems الواردة في القسم.

الإرجاع

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

التفويض

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

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[]|null: فقرات القسم

التفويض

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

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

`getParent()`

تعرض هذه السمة العنصر الرئيسي للعنصر الحالي.

يحتوي العنصر الرئيسي على العنصر الحالي.

الإرجاع

ContainerElement|null: العنصر الرئيسي

التفويض

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

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

`getTables()`

يستردّ هذا الإجراء جميع Tables الواردة في القسم.

الإرجاع

Table[]|null: جداول الأقسام

التفويض

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

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

المعلمات

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

يزيل العنصر من العنصر الأصل.

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|null: العنصر الذي تمت إزالته

التفويض

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

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[]|null: الحواشي السفلية الخاصة بالقسم

التفويض

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

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

`getLinkUrl()`

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

تعرض هذه السمة عنوان URL للرابط.

الإرجاع

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

التفويض

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

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