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تبحث في محتوى العنصر عن سلف من النوع المحدّد.
findElement(elementType, from)RangeElementتبحث في محتويات العنصر عن عنصر فرعي من النوع المحدّد، بدءًا منRangeElement المحدّد.
findText(searchPattern)RangeElementتبحث في محتوى العنصر عن النمط النصي المحدّد باستخدام التعبيرات العادية.
findText(searchPattern, from)RangeElementالبحث في محتوى العنصر عن نمط النص المحدّد، بدءًا من نتيجة بحث معيّنة
getAttributes()Objectيسترجع سمات العنصر.
getChild(childIndex)Elementيسترجع العنصر الفرعي في فهرس العنصر الفرعي المحدّد.
getChildIndex(child)Integerيسترجع فهرس العنصر الفرعي للعنصر الفرعي المحدّد.
getHeadingAttributes(paragraphHeading)Objectيسترجع مجموعة السمات للعنصر ParagraphHeading المقدَّم.
getImages()InlineImage[]يسترجع جميع InlineImages المتوفّرة في القسم.
getListItems()ListItem[]يسترجع جميع ListItems المتوفّرة في القسم.
getMarginBottom()Numberاسترداد الهامش السفلي، بالنقاط
getMarginLeft()Numberيسترجع الهامش الأيسر، بالنقاط.
getMarginRight()Numberيسترجع الهامش الأيمن.
getMarginTop()Numberيسترجع الهامش العلوي.
getNumChildren()Integerيسترجع عدد الأطفال.
getPageHeight()Numberيسترجع ارتفاع الصفحة بالنقاط.
getPageWidth()Numberيسترجع عرض الصفحة بالنقاط.
getParagraphs()Paragraph[]يسترجع جميع Paragraphs المتوفّرة في القسم (بما في ذلك ListItems).
getParent()ContainerElementيسترجع العنصر الرئيسي للعنصر.
getTables()Table[]يسترجع جميع Tables المتوفّرة في القسم.
getText()Stringيسترجع محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getType()ElementTypeيسترجع ElementType للعنصر.
insertHorizontalRule(childIndex)HorizontalRuleلإنشاء HorizontalRule جديدة وإدراجها في الفهرس المحدّد
insertImage(childIndex, image)InlineImageتُنشئ هذه الدالة عنصر InlineImage وتُدرِجه من قطعة بيانات الصورة المحدّدة في الترتيب المحدّد.
insertImage(childIndex, image)InlineImageتُدرج InlineImage المحدّدة في الفهرس المحدّد.
insertListItem(childIndex, listItem)ListItemتُدرج ListItem المحدّدة في الفهرس المحدّد.
insertListItem(childIndex, text)ListItemتُنشئ هذه الدالة ListItem جديدة وتُدرِجها في الفهرس المحدّد، وتتضمّن محتوًى ListItemمحددًا.
insertPageBreak(childIndex)PageBreakلإنشاء PageBreak جديدة وإدراجها في الفهرس المحدّد
insertPageBreak(childIndex, pageBreak)PageBreakتُدرج PageBreak المحدّدة في الفهرس المحدّد.
insertParagraph(childIndex, paragraph)Paragraphتُدرج Paragraph المحدّدة في الفهرس المحدّد.
insertParagraph(childIndex, text)Paragraphتُنشئ هذه الدالة Paragraph جديدة وتُدرِجها في الفهرس المحدّد، وتتضمّن محتوًى Paragraphمحددًا.
insertTable(childIndex)Tableلإنشاء Table جديدة وإدراجها في الفهرس المحدّد
insertTable(childIndex, cells)Tableتُنشئ هذه الدالة صفيفًا Table جديدًا يحتوي على الخلايا المحدّدة وتُدرِجه في الفهرس المحدّد.
insertTable(childIndex, table)Tableتُدرج Table المحدّدة في الفهرس المحدّد.
removeChild(child)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 - نتيجة بحث تشير إلى موضع عنصر البحث

التفويض

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

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

التفويض

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

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

findText(searchPattern)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

findText(searchPattern, from)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

getAttributes()

يسترجع سمات العنصر.

والنتيجة هي عنصر يحتوي على سمة لكل سمة عنصر صالحة، حيث يتوافق كل اسم سمة مع عنصر في التعداد DocumentApp.Attribute.

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

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

الإرجاع

Object: سمات العنصر

التفويض

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

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

getChild(childIndex)

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

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

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

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

المعلمات

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

التفويض

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

  • 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

getMarginBottom()

استرداد الهامش السفلي، بالنقاط

الإرجاع

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

التفويض

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

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

getMarginLeft()

يسترجع الهامش الأيسر، بالنقاط.

الإرجاع

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

التفويض

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

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

getMarginRight()

يسترجع الهامش الأيمن.

الإرجاع

Number: الهامش الأيمن، بوحدة النقطة

التفويض

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

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

getMarginTop()

يسترجع الهامش العلوي.

الإرجاع

Number: الهامش العلوي، بوحدة النقاط

التفويض

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

  • 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 - ارتفاع الصفحة بالنقاط

التفويض

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

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

getPageWidth()

يسترجع عرض الصفحة بالنقاط.

الإرجاع

Number: عرض الصفحة بالنقاط

التفويض

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

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

getParagraphs()

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

الإرجاع

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

التفويض

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

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

getParent()

يسترجع العنصر الرئيسي للعنصر.

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

الإرجاع

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

التفويض

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

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

getTables()

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

الإرجاع

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

التفويض

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

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

getText()

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

الإرجاع

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

التفويض

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

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

getTextAlignment()

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

الإرجاع

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

التفويض

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

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

getType()

يسترجع ElementType للعنصر.

استخدِم getType() لتحديد النوع الدقيق لعنصر معيّن.

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

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

الإرجاع

ElementType: نوع العنصر

التفويض

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

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

insertHorizontalRule(childIndex)

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

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

المعلمات

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

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