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

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

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)

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

المعلّمات

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

المعلّمات

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

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

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

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

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

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

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

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

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

التفويض

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

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

getChild(childIndex)

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

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

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

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

المعلّمات

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

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

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

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

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

// Obtain the first element in the document body.

var firstChild = body.getChild(0);

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

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

ElementType — نوع العنصر.

التفويض

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

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

insertHorizontalRule(childIndex)

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

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

المعلّمات

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

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

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

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

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

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

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

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

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

المعلّمات

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

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

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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

المعلّمات

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

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

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

التفويض

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

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

الطرق التي تم إيقافها نهائيًا