Class Body

Body

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

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

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

// Append a paragraph and a page break to the document 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 وتُدرجها من كائن ثنائي كبير (blob) للصورة المحدد، في الفهرس المحدد.
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 جديد.

المَعلمات

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

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

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

التفويض

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

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

appendImage(image)

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

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

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

المَعلمات

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

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

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

التفويض

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

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

appendListItem(listItem)

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

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

المَعلمات

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

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

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

التفويض

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

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

appendListItem(text)

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

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

المَعلمات

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

المَعلمات

الاسمTypeالوصف
pageBreakPageBreakفاصل الصفحة لإلحاقه

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

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

التفويض

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

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

appendParagraph(paragraph)

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

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

المَعلمات

الاسمTypeالوصف
paragraphParagraphالفقرة لإلحاقها

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

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

التفويض

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

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

appendParagraph(text)

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

المَعلمات

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

المَعلمات

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

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

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

التفويض

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

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

appendTable(table)

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

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

المَعلمات

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

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

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

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, "An editAsText sample.");
body.insertHorizontalRule(0);
body.insertParagraph(0, "An example.");

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

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

Text - نسخة نصية من العنصر الحالي


findElement(elementType)

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

المَعلمات

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

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

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

التفويض

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

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

findElement(elementType, from)

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

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

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

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

المَعلمات

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

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

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

التفويض

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

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

findText(searchPattern)

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

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

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

المَعلمات

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

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

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

التفويض

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

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

findText(searchPattern, from)

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

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

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

المَعلمات

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

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

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

التفويض

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

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

getAttributes()

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

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

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

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

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

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

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

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

التفويض

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

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

getChild(childIndex)

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

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

// Obtain the first element in the document.
var firstChild = body.getChild(0);

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

المَعلمات

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

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

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

التفويض

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

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

getChildIndex(child)

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

المَعلمات

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

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

Integer — الفهرس الفرعي

التفويض

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

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

getHeadingAttributes(paragraphHeading)

استرداد مجموعة السمات لسمة ParagraphHeading المقدَّمة.

المَعلمات

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

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

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

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

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

Integer - عدد الأطفال

التفويض

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

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

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() لتحديد النوع الدقيق لعنصر معيّن.

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

// Obtain the first element in the document body.

var firstChild = body.getChild(0);

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

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

ElementType — نوع العنصر

التفويض

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

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

insertHorizontalRule(childIndex)

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

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

المَعلمات

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

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

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

التفويض

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

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

insertImage(childIndex, image)

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

المَعلمات

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

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

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

التفويض

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

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

insertImage(childIndex, image)

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

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

المَعلمات

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

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

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

التفويض

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

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

insertListItem(childIndex, listItem)

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

المَعلمات

الاسمTypeالوصف
childIndexIntegerالفهرس الذي يمكن إدراج
listItemListItemعنصر القائمة لإدراجه

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

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

التفويض

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

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

insertListItem(childIndex, text)

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

المَعلمات

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

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

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

التفويض

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

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

insertPageBreak(childIndex)

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

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

المَعلمات

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

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

PageBreak — فاصل الصفحة الجديد

التفويض

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

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

insertPageBreak(childIndex, pageBreak)

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

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

المَعلمات

الاسمTypeالوصف
childIndexIntegerالفهرس الذي يتم إدراج العنصر فيه
pageBreakPageBreak[فواصل [page] لإدراج

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

PageBreak — فاصل الصفحة المدرج

التفويض

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

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

insertParagraph(childIndex, paragraph)

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

المَعلمات

الاسمTypeالوصف
childIndexIntegerالفهرس الذي يمكن إدراج
paragraphParagraphالفقرة المراد إدراجها

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

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

التفويض

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

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

insertParagraph(childIndex, text)

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

المَعلمات

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

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

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

التفويض

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

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

insertTable(childIndex)

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

المَعلمات

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

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

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

التفويض

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

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

insertTable(childIndex, cells)

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

المَعلمات

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

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

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

التفويض

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

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

insertTable(childIndex, table)

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

المَعلمات

الاسمTypeالوصف
childIndexIntegerالفهرس الذي يمكن إدراج
tableTableالجدول لإدراج

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

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

التفويض

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

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

removeChild(child)

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

المَعلمات

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

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

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

التفويض

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

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

replaceText(searchPattern, replacement)

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

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

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

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

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

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

المَعلمات

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

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

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

التفويض

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

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

setAttributes(attributes)

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

يجب أن تكون معلمة السمات المحددة كائنًا يكون فيه كل اسم للخاصية عنصرًا في التعداد DocumentApp.Attribute وتكون كل قيمة للخاصية هي القيمة الجديدة المطلوب تطبيقها.

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

// Define a custom paragraph style.
var style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
var par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

المَعلمات

الاسمTypeالوصف
attributesObjectتمثّل هذه السمة سمات العنصر.

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

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

التفويض

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

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

setHeadingAttributes(paragraphHeading, attributes)

لضبط السمات لسمة ParagraphHeading المقدّمة.

المَعلمات

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

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

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

التفويض

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

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

setMarginBottom(marginBottom)

لضبط الهامش السفلي بالنقاط

المَعلمات

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

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

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

التفويض

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

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

setMarginLeft(marginLeft)

لضبط الهامش الأيسر بالنقاط

المَعلمات

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

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

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

التفويض

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

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

setMarginRight(marginRight)

لضبط الهامش الأيمن بالنقاط

المَعلمات

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

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

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

التفويض

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

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

setMarginTop(marginTop)

لضبط الهامش العلوي.

المَعلمات

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

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

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

التفويض

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

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

setPageHeight(pageHeight)

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

المَعلمات

الاسمTypeالوصف
pageHeightNumberارتفاع الصفحة بالنقاط

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

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

التفويض

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

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

setPageWidth(pageWidth)

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

المَعلمات

الاسمTypeالوصف
pageWidthNumberعرض الصفحة بالنقاط

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

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

التفويض

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

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

setText(text)

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

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

المَعلمات

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

المَعلمات

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

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

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

التفويض

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

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

الطرق المتوقّفة نهائيًا