Class Body

Body

محتوى علامة تبويب في مستند "مستندات Google" قد يحتوي Body على عناصر ListItem وParagraph وTable وTableOfContents. لمزيد من المعلومات حول بنية المستند، راجِع دليل توسيع نطاق "مستندات Google".

تحتوي Body عادةً على المحتوى الكامل للعلامة باستثناء HeaderSection وFooterSection وأي عناصر FootnoteSection.

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

// Append a paragraph and a page break to the tab's body section directly.
body.appendParagraph('A paragraph.');
body.appendPageBreak();

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
appendHorizontalRule()HorizontalRuleتنشئ هذه السمة HorizontalRule جديدة وتلحقها.
appendImage(image)InlineImageتنشئ هذه الطريقة InlineImage جديدًا وتضيفه من كائن ثنائي كبير الحجم للصورة المحدّدة.
appendImage(image)InlineImageتُلحق هذه السمة InlineImage المحدّدة.
appendListItem(listItem)ListItemتُلحق هذه السمة ListItem المحدّدة.
appendListItem(text)ListItemتنشئ هذه الطريقة عنصر ListItem جديدًا وتضيفه إلى نهاية المستند، ويحتوي هذا العنصر على محتوى النص المحدّد.
appendPageBreak()PageBreakتنشئ هذه السمة PageBreak جديدة وتلحقها.
appendPageBreak(pageBreak)PageBreakتُلحق هذه السمة PageBreak المحدّدة.
appendParagraph(paragraph)Paragraphتُلحق هذه السمة Paragraph المحدّدة.
appendParagraph(text)Paragraphتنشئ هذه الطريقة عنصر Paragraph جديدًا وتضيفه إلى نهاية المستند، ويحتوي هذا العنصر على محتوى النص المحدّد.
appendTable()Tableتنشئ هذه السمة Table جديدة وتلحقها.
appendTable(cells)Tableتُلحق هذه السمة Table جديدة تحتوي على TableCell لكل قيمة سلسلة محددة.
appendTable(table)Tableتُلحق هذه السمة Table المحدّدة.
clear()Bodyيمحو محتوى العنصر.
copy()Bodyتعرض نسخة منفصلة وعميقة من العنصر الحالي.
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يستردّ هذا الإجراء فهرس العنصر الفرعي للعنصر الفرعي المحدّد.
getHeadingAttributes(paragraphHeading)Objectتعرض هذه الطريقة مجموعة السمات الخاصة بـ ParagraphHeading المقدَّم.
getImages()InlineImage[]|nullيستردّ هذا الإجراء جميع InlineImages الواردة في القسم.
getListItems()ListItem[]|nullيستردّ هذا الإجراء جميع ListItems الواردة في القسم.
getMarginBottom()Number|nullتعرض هذه السمة الهامش السفلي بالنقاط.
getMarginLeft()Number|nullتعرض هذه السمة الهامش الأيسر بالنقاط.
getMarginRight()Number|nullتعرض هذه السمة الهامش الأيمن.
getMarginTop()Number|nullتعرض هذه السمة الهامش العلوي.
getNumChildren()Integerتعرض هذه السمة عدد الأطفال.
getPageHeight()Number|nullتعرض هذه السمة ارتفاع الصفحة بالنقاط.
getPageWidth()Number|nullتعرض هذه السمة عرض الصفحة بالنقاط.
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 جديدًا وتُدرجه في الفهرس المحدّد، على أن يتضمّن محتوى النص المحدّد.
insertPageBreak(childIndex)PageBreakتُنشئ هذه الطريقة عنصر PageBreak جديدًا وتُدرجه في الفهرس المحدّد.
insertPageBreak(childIndex, pageBreak)PageBreakتُدرِج هذه الدالة القيمة PageBreak المحدّدة في الفهرس المحدّد.
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)Bodyيزيل العنصر الفرعي المحدّد.
replaceText(searchPattern, replacement)Elementلاستبدال جميع تكرارات نمط نصي معيّن بسلسلة استبدال معيّنة، باستخدام التعبيرات العادية.
setAttributes(attributes)Bodyتضبط هذه السمة سمات العنصر.
setHeadingAttributes(paragraphHeading, attributes)Bodyتضبط هذه الطريقة سمات ParagraphHeading المقدَّمة.
setMarginBottom(marginBottom)Bodyتضبط هذه السمة الهامش السفلي بالنقاط.
setMarginLeft(marginLeft)Bodyتضبط هذه السمة الهامش الأيسر بالنقاط.
setMarginRight(marginRight)Bodyتضبط هذه السمة الهامش الأيمن بالنقاط.
setMarginTop(marginTop)Bodyتضبط هذه السمة الهامش العلوي.
setPageHeight(pageHeight)Bodyتضبط هذه السمة ارتفاع الصفحة بالنقاط.
setPageWidth(pageWidth)Bodyتضبط هذه السمة عرض الصفحة بالنقاط.
setText(text)Bodyيضبط المحتوى كنص عادي.
setTextAlignment(textAlignment)Bodyتضبط هذه السمة محاذاة النص.

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

appendHorizontalRule()

تنشئ هذه السمة HorizontalRule جديدة وتلحقها.

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

الإرجاع

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

التفويض

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

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

appendImage(image)

تنشئ هذه الطريقة InlineImage جديدًا وتضيفه من كائن ثنائي كبير الحجم للصورة المحدّدة.

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

المعلمات

الاسمالنوعالوصف
imageBlobSourceبيانات الصورة

الإرجاع

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

التفويض

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

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

appendImage(image)

تُلحق هذه السمة InlineImage المحدّدة.

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

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

المعلمات

الاسمالنوعالوصف
imageInlineImageبيانات الصورة

الإرجاع

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

التفويض

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

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

appendListItem(listItem)

تُلحق هذه السمة ListItem المحدّدة.

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

المعلمات

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

الإرجاع

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

التفويض

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

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

appendListItem(text)

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

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

المعلمات

الاسمالنوعالوصف
textStringمحتوى النص الخاص بعنصر القائمة

الإرجاع

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

التفويض

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

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

appendPageBreak()

تنشئ هذه السمة PageBreak جديدة وتلحقها.

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

الإرجاع

PageBreak: فاصل الصفحات الجديد

التفويض

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

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

appendPageBreak(pageBreak)

تُلحق هذه السمة PageBreak المحدّدة.

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

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

المعلمات

الاسمالنوعالوصف
pageBreakPageBreakتمثّل هذه السمة فاصل الصفحة المطلوب إلحاقه.

الإرجاع

PageBreak: فاصل الصفحة الملحق

التفويض

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

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

appendParagraph(paragraph)

تُلحق هذه السمة Paragraph المحدّدة.

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

المعلمات

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

الإرجاع

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

التفويض

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

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

appendParagraph(text)

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

المعلمات

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

الإرجاع

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" لا يمكن أن تنتهي بجدول.

المعلمات

الاسمالنوعالوصف
cellsString[][]محتوى النص في خلايا الجدول الذي تريد إضافته إلى الجدول الجديد

الإرجاع

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

التفويض

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

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

appendTable(table)

تُلحق هذه السمة Table المحدّدة.

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

المعلمات

الاسمالنوعالوصف
tableTableالجدول الذي سيتم إلحاقه.

الإرجاع

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

التفويض

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

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

clear()

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

الإرجاع

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


copy()

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

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

الإرجاع

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

التفويض

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

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

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

المعلمات

الاسمالنوعالوصف
elementTypeElementTypeنوع العنصر المطلوب البحث عنه.

الإرجاع

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

المعلمات

الاسمالنوعالوصف
elementTypeElementTypeنوع العنصر المطلوب البحث عنه.
fromRangeElementنتيجة البحث التي سيتم البحث منها

الإرجاع

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

التفويض

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

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

findText(searchPattern)

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

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

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

المعلمات

الاسمالنوعالوصف
searchPatternStringالنمط المطلوب البحث عنه

الإرجاع

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

التفويض

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

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

findText(searchPattern, from)

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

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

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

المعلمات

الاسمالنوعالوصف
searchPatternStringالنمط المطلوب البحث عنه
fromRangeElementنتيجة البحث التي تريد البحث منها

الإرجاع

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.');
}

المعلمات

الاسمالنوعالوصف
childIndexIntegerفهرس العنصر الفرعي المطلوب استرداده

الإرجاع

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

التفويض

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

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

getChildIndex(child)

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

المعلمات

الاسمالنوعالوصف
childElementالعنصر الثانوي الذي سيتم استرداد الفهرس الخاص به.

الإرجاع

Integer: فهرس الطفل

التفويض

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

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

getHeadingAttributes(paragraphHeading)

تعرض هذه الطريقة مجموعة السمات الخاصة بـ ParagraphHeading المقدَّم.

المعلمات

الاسمالنوعالوصف
paragraphHeadingParagraphHeadingالعنوان المطلوب استرداد سماته.

الإرجاع

Object: خريطة للسمات وقيمها الحالية.

التفويض

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

  • 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

getMarginBottom()

تعرض هذه السمة الهامش السفلي بالنقاط.

الإرجاع

Number|null: الهامش السفلي، بالنقاط

التفويض

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

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

getMarginLeft()

تعرض هذه السمة الهامش الأيسر بالنقاط.

الإرجاع

Number|null: الهامش الأيسر، بالنقاط

التفويض

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

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

getMarginRight()

تعرض هذه السمة الهامش الأيمن.

الإرجاع

Number|null: الهامش الأيمن، بالنقاط

التفويض

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

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

getMarginTop()

تعرض هذه السمة الهامش العلوي.

الإرجاع

Number|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

getPageHeight()

تعرض هذه السمة ارتفاع الصفحة بالنقاط.

الإرجاع

Number|null: تمثّل ارتفاع الصفحة بالنقاط.

التفويض

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

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

getPageWidth()

تعرض هذه السمة عرض الصفحة بالنقاط.

الإرجاع

استبدِل Number|null بعرض الصفحة بالنقاط.

التفويض

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

  • 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 جديد.

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم إدراج العنصر فيه.

الإرجاع

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

التفويض

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

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

insertImage(childIndex, image)

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

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم إدراج العنصر فيه.
imageBlobSourceبيانات الصورة

الإرجاع

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

التفويض

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

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

insertImage(childIndex, image)

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

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

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم إدراج العنصر فيه.
imageInlineImageالصورة المطلوب إدراجها

الإرجاع

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

التفويض

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

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

insertListItem(childIndex, listItem)

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

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم الإدراج فيه.
listItemListItemعنصر القائمة المطلوب إدراجه

الإرجاع

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

التفويض

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

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

insertListItem(childIndex, text)

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

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم الإدراج فيه.
textStringمحتوى النص الخاص بعنصر القائمة

الإرجاع

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

التفويض

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

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

insertPageBreak(childIndex)

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

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

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم إدراج العنصر فيه.

الإرجاع

PageBreak: فاصل الصفحات الجديد

التفويض

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

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

insertPageBreak(childIndex, pageBreak)

تُدرِج هذه الدالة القيمة PageBreak المحدّدة في الفهرس المحدّد.

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

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم إدراج العنصر فيه.
pageBreakPageBreakتمثّل هذه السمة فاصل الصفحة المطلوب إدراجه.

الإرجاع

PageBreak: فاصل الصفحة الذي تم إدراجه

التفويض

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

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

insertParagraph(childIndex, paragraph)

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

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم الإدراج فيه.
paragraphParagraphالفقرة المطلوب إدراجها

الإرجاع

Paragraph: الفقرة المُدرَجة

التفويض

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

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

insertParagraph(childIndex, text)

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

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم الإدراج فيه.
textStringمحتوى النص في الفقرة

الإرجاع

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

التفويض

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

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

insertTable(childIndex)

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

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم الإدراج فيه.

الإرجاع

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

التفويض

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

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

insertTable(childIndex, cells)

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

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم الإدراج فيه.
cellsString[][]محتوى النص في خلايا الجدول الذي تريد إضافته إلى الجدول الجديد

الإرجاع

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

التفويض

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

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

insertTable(childIndex, table)

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

المعلمات

الاسمالنوعالوصف
childIndexIntegerالفهرس الذي سيتم الإدراج فيه.
tableTableالجدول المطلوب إدراجه

الإرجاع

Table: الجدول الذي تم إدراجه

التفويض

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

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

removeChild(child)

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

المعلمات

الاسمالنوعالوصف
childElementعنصر الطفل الذي ستتم إزالته.

الإرجاع

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

التفويض

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

  • 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');

المعلمات

الاسمالنوعالوصف
searchPatternStringنمط التعبير العادي الذي سيتم البحث عنه
replacementStringالنص الذي سيتم استخدامه كبديل

الإرجاع

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

المعلمات

الاسمالنوعالوصف
attributesObjectسمات العنصر

الإرجاع

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

التفويض

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

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

setHeadingAttributes(paragraphHeading, attributes)

تضبط هذه الطريقة سمات ParagraphHeading المقدَّمة.

المعلمات

الاسمالنوعالوصف
paragraphHeadingParagraphHeadingالعنوان الذي يجب ضبط سماته
attributesObjectخريطة للسمات والقيم التي سيتم ضبطها عليها

الإرجاع

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

التفويض

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

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

setMarginBottom(marginBottom)

تضبط هذه السمة الهامش السفلي بالنقاط.

المعلمات

الاسمالنوعالوصف
marginBottomNumberالهامش السفلي، بالنقاط

الإرجاع

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

التفويض

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

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

setMarginLeft(marginLeft)

تضبط هذه السمة الهامش الأيسر بالنقاط.

المعلمات

الاسمالنوعالوصف
marginLeftNumberالهامش الأيسر، بالنقاط

الإرجاع

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

التفويض

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

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

setMarginRight(marginRight)

تضبط هذه السمة الهامش الأيمن بالنقاط.

المعلمات

الاسمالنوعالوصف
marginRightNumberالهامش الأيمن

الإرجاع

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

التفويض

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

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

setMarginTop(marginTop)

تضبط هذه السمة الهامش العلوي.

المعلمات

الاسمالنوعالوصف
marginTopNumberتمثّل هذه السمة الهامش العلوي بالنقاط.

الإرجاع

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

التفويض

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

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

setPageHeight(pageHeight)

تضبط هذه السمة ارتفاع الصفحة بالنقاط.

المعلمات

الاسمالنوعالوصف
pageHeightNumberتمثّل هذه السمة ارتفاع الصفحة بالنقاط.

الإرجاع

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

التفويض

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

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

setPageWidth(pageWidth)

تضبط هذه السمة عرض الصفحة بالنقاط.

المعلمات

الاسمالنوعالوصف
pageWidthNumberتمثّل هذه السمة عرض الصفحة بالنقاط.

الإرجاع

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

التفويض

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

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

setText(text)

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

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

المعلمات

الاسمالنوعالوصف
textStringمحتوى النص الجديد

الإرجاع

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

التفويض

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

  • 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);

المعلمات

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

الإرجاع

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

التفويض

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

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

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