Class ContainerElement

عنصر الحاوية

عنصر عام قد يحتوي على عناصر أخرى ترث كل العناصر التي قد تحتوي على عناصر ثانوية، مثل Paragraph، من ContainerElement.

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
asBody()Bodyلعرض العنصر الحالي كBody.
asEquation()Equationلعرض العنصر الحالي كEquation.
asFooterSection()FooterSectionلعرض العنصر الحالي كFooterSection.
asFootnoteSection()FootnoteSectionلعرض العنصر الحالي كFootnoteSection.
asHeaderSection()HeaderSectionلعرض العنصر الحالي كHeaderSection.
asListItem()ListItemلعرض العنصر الحالي كListItem.
asParagraph()Paragraphلعرض العنصر الحالي كParagraph.
asTable()Tableلعرض العنصر الحالي كTable.
asTableCell()TableCellلعرض العنصر الحالي كTableCell.
asTableOfContents()TableOfContentsلعرض العنصر الحالي كTableOfContents.
asTableRow()TableRowلعرض العنصر الحالي كTableRow.
clear()ContainerElementتمحو محتويات العنصر.
copy()ContainerElementتعرِض نسخة مفصَّلة ومُفصَّلة من العنصر الحالي.
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يسترجع فهرس العنصر الفرعي للعنصر الفرعي المحدّد.
getLinkUrl()Stringيستردّ عنوان URL للرابط.
getNextSibling()Elementيسترجع العنصر الشقيق التالي للعنصر.
getNumChildren()Integerيسترجع عدد الأطفال.
getParent()ContainerElementيسترجع العنصر الرئيسي للعنصر.
getPreviousSibling()Elementيسترجع العنصر الشقيق السابق للعنصر.
getText()Stringيسترجع محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getType()ElementTypeيسترجع ElementType للعنصر.
isAtDocumentEnd()Booleanلتحديد ما إذا كان العنصر في نهاية Document
merge()ContainerElementدمج العنصر مع العنصر الشقيق السابق من النوع نفسه
removeFromParent()ContainerElementتزيل العنصر من العنصر الرئيسي.
replaceText(searchPattern, replacement)Elementلاستبدال جميع مظاهر نمط نصي معيّن بسلسلة بديل معيّنة، باستخدام تعبيرات عادية.
setAttributes(attributes)ContainerElementتُستخدَم لضبط سمات العنصر.
setLinkUrl(url)ContainerElementلضبط عنوان URL للرابط
setTextAlignment(textAlignment)ContainerElementلضبط محاذاة النص

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

asBody()

لعرض العنصر الحالي كBody.

استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.

الإرجاع

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

التفويض

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

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

asEquation()

لعرض العنصر الحالي كEquation.

استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.

الإرجاع

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

التفويض

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

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

asFooterSection()

لعرض العنصر الحالي كFooterSection.

استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.

الإرجاع

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

التفويض

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

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

asFootnoteSection()

لعرض العنصر الحالي كFootnoteSection.

استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.

الإرجاع

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

التفويض

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

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

asHeaderSection()

لعرض العنصر الحالي كHeaderSection.

استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.

الإرجاع

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

التفويض

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

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

asListItem()

لعرض العنصر الحالي كListItem.

استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.

الإرجاع

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

التفويض

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

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

asParagraph()

لعرض العنصر الحالي كParagraph.

استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.

الإرجاع

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

التفويض

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

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

asTable()

لعرض العنصر الحالي كTable.

استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.

الإرجاع

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

التفويض

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

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

asTableCell()

لعرض العنصر الحالي كTableCell.

استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.

الإرجاع

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

التفويض

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

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

asTableOfContents()

لعرض العنصر الحالي كTableOfContents.

استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.

الإرجاع

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

التفويض

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

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

asTableRow()

لعرض العنصر الحالي كTableRow.

استخدِم هذه الطريقة للمساعدة في الإكمال التلقائي عندما يكون معروفًا أنّ عنصرًا معيّنًا من نوع معيّن.

الإرجاع

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

التفويض

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

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

clear()

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

الإرجاع

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


copy()

تعرِض نسخة مفصَّلة ومُفصَّلة من العنصر الحالي.

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

الإرجاع

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

التفويض

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

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

editAsText()

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

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

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

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

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

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

الإرجاع

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


findElement(elementType)

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

المعلمات

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

الإرجاع

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

التفويض

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

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

findElement(elementType, from)

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

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

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

المعلمات

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

الإرجاع

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

التفويض

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

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

findText(searchPattern)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

findText(searchPattern, from)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

getAttributes()

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

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

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

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

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

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

الإرجاع

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

التفويض

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

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

getChild(childIndex)

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

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

getChildIndex(child)

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

المعلمات

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

الإرجاع

Integer - فهرس الطفل

التفويض

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

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

getLinkUrl()

يستردّ عنوان URL للرابط.

الإرجاع

String: عنوان URL للرابط، أو قيمة فارغة إذا كان العنصر يحتوي على قيم متعددة لهذه السمة

التفويض

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

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

getNextSibling()

يسترجع العنصر الشقيق التالي للعنصر.

يتضمّن الشقيق التالي العنصر الرئيسي نفسه ويتبع العنصر الحالي.

الإرجاع

Element: العنصر الشقيق التالي

التفويض

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

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

getNumChildren()

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

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

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

الإرجاع

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

التفويض

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

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

getParent()

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

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

الإرجاع

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

التفويض

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

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

getPreviousSibling()

يسترجع العنصر الشقيق السابق للعنصر.

يتضمّن العنصر الشقيق السابق العنصر الرئيسي نفسه ويسبق العنصر الحالي.

الإرجاع

Element: العنصر الشقيق السابق

التفويض

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

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

getText()

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

الإرجاع

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

التفويض

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

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

getTextAlignment()

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

الإرجاع

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

التفويض

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

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

getType()

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

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

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

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

const firstChild = body.getChild(0);

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

الإرجاع

ElementType: نوع العنصر

التفويض

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

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

isAtDocumentEnd()

لتحديد ما إذا كان العنصر في نهاية Document

الإرجاع

Boolean — ما إذا كان العنصر في نهاية علامة التبويب

التفويض

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

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

merge()

دمج العنصر مع العنصر الشقيق السابق من النوع نفسه

لا يمكن دمج سوى عناصر ElementType نفسها. يتم نقل أي عناصر فرعية مضمّنة في العنصر الحالي إلى العنصر الشقيق السابق.

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

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

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

الإرجاع

ContainerElement: العنصر المدمج

التفويض

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

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

removeFromParent()

تزيل العنصر من العنصر الرئيسي.

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

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

الإرجاع

ContainerElement: العنصر الذي تمّت إزالته

التفويض

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

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

replaceText(searchPattern, replacement)

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

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

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

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

setAttributes(attributes)

تُستخدَم لضبط سمات العنصر.

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

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

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

setLinkUrl(url)

لضبط عنوان URL للرابط

المعلمات

الاسمالنوعالوصف
urlStringعنوان URL للرابط

الإرجاع

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

التفويض

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

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

setTextAlignment(textAlignment)

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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