Class HeaderSection

HeaderSection

يشير ذلك المصطلح إلى عنصر يمثّل قسمًا للعنوان. تحتوي Document عادةً على HeaderSection واحد كحدّ أقصى. قد يحتوي HeaderSection على ListItem وParagraph و Table. لمزيد من المعلومات حول بنية المستند، يُرجى الاطّلاع على دليل توسيع نطاق عمل "مستندات Google".

الطُرق

الطريقةنوع الإرجاعوصف قصير
appendHorizontalRule()HorizontalRuleتنشئ سمة HorizontalRule جديدة وتلحقها
appendImage(image)InlineImageتنشئ هذه الدالة InlineImage جديدًا وتلحقه من الكائن الثنائي الكبير المحدّد للصورة.
appendImage(image)InlineImageتُرفِق السمة InlineImage المحدّدة.
appendListItem(listItem)ListItemتُرفِق السمة ListItem المحدّدة.
appendListItem(text)ListItemتنشئ هذه السمة ListItem جديدًا وتلحقها به المحتوى النصي المحدّد.
appendParagraph(paragraph)Paragraphتُرفِق السمة Paragraph المحدّدة.
appendParagraph(text)Paragraphتنشئ هذه السمة Paragraph جديدًا وتلحقها به المحتوى النصي المحدّد.
appendTable()Tableتنشئ سمة Table جديدة وتلحقها
appendTable(cells)Tableلإلحاق Table جديد يحتوي على TableCell لكل قيمة سلسلة محددة.
appendTable(table)Tableتُرفِق السمة Table المحدّدة.
clear()HeaderSectionيؤدي إلى محو محتوى العنصر.
copy()HeaderSectionلعرض نسخة منفصلة عميقة من العنصر الحالي.
editAsText()Textالحصول على نسخة Text من العنصر الحالي للتعديل.
findElement(elementType)RangeElementيبحث في محتوى العنصر عن تابع من النوع المحدد.
findElement(elementType, from)RangeElementيبحث في محتوى العنصر عن تابع من النوع المحدد، بدءًا من تم تحديد RangeElement.
findText(searchPattern)RangeElementللبحث في محتويات العنصر عن نمط النص المحدد باستخدام التعبيرات العادية.
findText(searchPattern, from)RangeElementيبحث في محتويات العنصر عن نمط النص المحدد، بدءًا من عنصر نتيجة البحث.
getAttributes()Objectيسترد سمات العنصر.
getChild(childIndex)Elementاسترداد العنصر الفرعي في الفهرس الفرعي المحدد.
getChildIndex(child)Integerاسترداد الفهرس الفرعي للعنصر الفرعي المحدد.
getImages()InlineImage[]لاسترداد كل InlineImages المضمَّنة في القسم
getListItems()ListItem[]لاسترداد كل ListItems المضمَّنة في القسم
getNumChildren()Integerلاسترداد عدد الأطفال.
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 جديدة في الفهرس المحدد، وتحتوي على المحددة المحتوى النصي.
insertParagraph(childIndex, paragraph)Paragraphإدراج Paragraph المحدّد في الفهرس المحدّد
insertParagraph(childIndex, text)Paragraphتنشئ وإدراج Paragraph جديدة في الفهرس المحدد، وتحتوي على المحددة المحتوى النصي.
insertTable(childIndex)Tableتنشئ السمة Table جديدة وإدراجها في الفهرس المحدّد.
insertTable(childIndex, cells)Tableتنشئ وإدراج Table جديدة تحتوي على الخلايا المحددة، في الفهرس المحدد.
insertTable(childIndex, table)Tableإدراج Table المحدّد في الفهرس المحدّد
removeChild(child)HeaderSectionإزالة العنصر الفرعي المحدد
removeFromParent()HeaderSectionإزالة العنصر من عنصره الأساسي
replaceText(searchPattern, replacement)Elementلاستبدال جميع ورود نمط نص معين بسلسلة استبدال معينة، باستخدام والتعبيرات.
setAttributes(attributes)HeaderSectionيعيّن سمات العنصر.
setText(text)HeaderSectionلضبط المحتوى كنص عادي
setTextAlignment(textAlignment)HeaderSectionلضبط محاذاة النص.

الوثائق التفصيلية

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

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

الإرجاع

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

التفويض

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

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

appendTable(cells)

لإلحاق Table جديد يحتوي على TableCell لكل قيمة سلسلة محددة.

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

المعلمات

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

الإرجاع

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

التفويض

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

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

appendTable(table)

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

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

المعلمات

الاسمالنوعالوصف
tableTableالجدول المطلوب إلحاقه.

الإرجاع

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

التفويض

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

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

clear()

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

الإرجاع

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


copy()

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

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

الإرجاع

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

التفويض

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

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

editAsText()

الحصول على نسخة Text من العنصر الحالي للتعديل.

استخدام editAsText لمعالجة محتوى العناصر كنص منسق. يتجاهل وضع editAsText العناصر غير النصية (مثل InlineImage وHorizontalRule).

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

var 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.

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

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

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

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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)

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

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

// Obtain the first element in the tab.
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

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

getNumChildren()

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

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

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

الإرجاع

Integer — عدد الأطفال.

التفويض

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

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

getParagraphs()

استرداد كل Paragraphs المضمَّنة في القسم (بما في ذلك ListItems).

الإرجاع

Paragraph[] — فقرات القسم.

التفويض

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

  • 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 doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Obtain the first element in the active tab's 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 من الكائن الثنائي الكبير (blob) الخاص بالصورة المحدد، الفهرس.

المعلمات

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

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العنصر الثانوي المطلوب إزالته.

الإرجاع

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

التفويض

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

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

removeFromParent()

إزالة العنصر من عنصره الأساسي

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

// Remove all images in the active tab's body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

الإرجاع

HeaderSection — العنصر الذي تمت إزالته

التفويض

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

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

replaceText(searchPattern, replacement)

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

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

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

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

var 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 وكل قيمة خاصية هي القيمة الجديدة التي يجب المنهجية.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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سمات العنصر.

الإرجاع

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

التفويض

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

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

setText(text)

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

setTextAlignment(textAlignment)

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

// Make the entire first paragraph in the active tab be superscript.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

المعلمات

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

الإرجاع

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

التفويض

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

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

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