Class TableCell

جدولخلية

عنصر يمثّل خلية جدول يكون عنصر TableCell مضمّنًا دائمًا في عنصر TableRow وقد يحتوي على عناصر 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 جديد يحتوي على الخلايا المحدّدة
appendTable(table)Tableإلحاق Table المحدَّد
clear()TableCellتمحو محتويات العنصر.
copy()TableCellتعرِض نسخة مفصَّلة ومُفصَّلة من العنصر الحالي.
editAsText()Textالحصول على نسخة Text من العنصر الحالي لتعديلها
findElement(elementType)RangeElementتبحث في محتوى العنصر عن سلف من النوع المحدّد.
findElement(elementType, from)RangeElementتبحث في محتويات العنصر عن عنصر فرعي من النوع المحدّد، بدءًا منRangeElement المحدّد.
findText(searchPattern)RangeElementتبحث في محتوى العنصر عن النمط النصي المحدّد باستخدام التعبيرات العادية.
findText(searchPattern, from)RangeElementالبحث في محتوى العنصر عن نمط النص المحدّد، بدءًا من نتيجة بحث معيّنة
getAttributes()Objectيسترجع سمات العنصر.
getBackgroundColor()Stringاسترداد لون الخلفية
getChild(childIndex)Elementيسترجع العنصر الفرعي في فهرس العنصر الفرعي المحدّد.
getChildIndex(child)Integerيسترجع فهرس العنصر الفرعي للعنصر الفرعي المحدّد.
getColSpan()Integerتسترجع هذه الدالة مساحة العمود، وهي عدد أعمدة خلايا الجدول التي تمتد إليها هذه الخلية.
getLinkUrl()Stringيستردّ عنوان URL للرابط.
getNextSibling()Elementيسترجع العنصر الشقيق التالي للعنصر.
getNumChildren()Integerيسترجع عدد الأطفال.
getPaddingBottom()Numberيسترجع المساحة الفارغة في أسفل العنصر، بالنقاط.
getPaddingLeft()Numberيسترجع المساحة الفارغة اليسرى، بالنقاط.
getPaddingRight()Numberيسترجع المساحة الفارغة اليمنى، بالنقاط.
getPaddingTop()Numberيسترجع المساحة الفارغة في أعلى الصفحة، بالنقاط.
getParent()ContainerElementيسترجع العنصر الرئيسي للعنصر.
getParentRow()TableRowيسترجع TableRow الذي يحتوي على TableCell الحالي.
getParentTable()Tableيسترجع Table الذي يحتوي على TableCell الحالي.
getPreviousSibling()Elementيسترجع العنصر الشقيق السابق للعنصر.
getRowSpan()Integerيسترجع نطاق الصف، وهو عدد صفوف خلايا الجدول التي تمتد إليها هذه الخلية.
getText()Stringيسترجع محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignmentالحصول على محاذاة النص
getType()ElementTypeيسترجع ElementType للعنصر.
getVerticalAlignment()VerticalAlignmentاسترجاع VerticalAlignment
getWidth()Numberيسترجع عرض العمود الذي يحتوي على الخلية، بالنقاط.
insertHorizontalRule(childIndex)HorizontalRuleلإنشاء HorizontalRule جديدة وإدراجها في الفهرس المحدّد
insertImage(childIndex, image)InlineImageتُنشئ هذه الدالة عنصر InlineImage وتُدرِجه من قطعة بيانات الصورة المحدّدة في الترتيب المحدّد.
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 المحدّدة في الفهرس المحدّد.
isAtDocumentEnd()Booleanلتحديد ما إذا كان العنصر في نهاية Document
merge()TableCellدمج العنصر مع العنصر الشقيق السابق من النوع نفسه
removeChild(child)TableCellتزيل العنصر الفرعي المحدّد.
removeFromParent()TableCellتزيل العنصر من العنصر الرئيسي.
replaceText(searchPattern, replacement)Elementلاستبدال جميع مظاهر نمط نصي معيّن بسلسلة بديل معيّنة، باستخدام تعبيرات عادية.
setAttributes(attributes)TableCellتُستخدَم لضبط سمات العنصر.
setBackgroundColor(color)TableCellلضبط لون الخلفية.
setLinkUrl(url)TableCellلضبط عنوان URL للرابط
setPaddingBottom(paddingBottom)TableCellلضبط المساحة المتروكة في أسفل العنصر، بالنقاط
setPaddingLeft(paddingLeft)TableCellلضبط المساحة الفارغة اليسرى، بالنقاط
setPaddingRight(paddingRight)TableCellلضبط المساحة الفارغة اليمنى، بالنقاط
setPaddingTop(paddingTop)TableCellلضبط المساحة المتروكة في أعلى الصفحة، بالنقاط.
setText(text)TableCellلضبط المحتوى كنص عادي
setTextAlignment(textAlignment)TableCellلضبط محاذاة النص
setVerticalAlignment(alignment)TableCellلضبط المحاذاة العمودية
setWidth(width)TableCellتُستخدَم لضبط عرض العمود الذي يحتوي على الخلية الحالية، بالنقاط.

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

appendHorizontalRule()

لإنشاء HorizontalRule جديد وإضافته

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

الإرجاع

HorizontalRule - الخط الأفقي الجديد

التفويض

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

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

appendImage(image)

لإنشاء InlineImage جديد وإضافته من قطعة الصورة المحدّدة

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

المعلمات

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

الإرجاع

InlineImage - الصورة الجديدة

التفويض

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

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

appendImage(image)

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

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

المعلمات

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

الإرجاع

InlineImage: الصورة المُرفَقة

التفويض

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

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

appendListItem(listItem)

إلحاق 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 المحدَّد

المعلمات

الاسمالنوعالوصف
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 جديد وإضافته

الإرجاع

Table - الجدول الجديد

التفويض

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

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

appendTable(cells)

إلحاق Table جديد يحتوي على الخلايا المحدّدة

المعلمات

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

الإرجاع

Table - الجدول المُرفَق

التفويض

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

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

appendTable(table)

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

المعلمات

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

الإرجاع

Table - الجدول المُرفَق

التفويض

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

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

clear()

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

الإرجاع

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

copy()

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

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

الإرجاع

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

التفويض

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

  • 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

getBackgroundColor()

استرداد لون الخلفية

الإرجاع

String: لون الخلفية بتنسيق صفحات الأنماط المتتالية (CSS) (مثل '#ffffff')

التفويض

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

  • 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

getColSpan()

تسترجع هذه الدالة مساحة العمود، وهي عدد أعمدة خلايا الجدول التي تمتد إليها هذه الخلية. تحتوي الخلايا غير المدمجة على نطاق عمود واحد.

الإرجاع

Integer: نطاق العمود أو 0 لخلية تم دمجها مع خلية أخرى

التفويض

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

  • 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

getPaddingBottom()

يسترجع المساحة الفارغة في أسفل العنصر، بالنقاط.

الإرجاع

Number - المساحة المتروكة في أسفل العنصر، بالنقاط

التفويض

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

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

getPaddingLeft()

يسترجع المساحة الفارغة اليسرى، بالنقاط.

الإرجاع

Number - المساحة الفارغة اليسرى، بالنقاط

التفويض

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

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

getPaddingRight()

يسترجع المساحة الفارغة اليمنى، بالنقاط.

الإرجاع

Number - المساحة الفارغة اليمنى، بالنقاط

التفويض

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

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

getPaddingTop()

يسترجع المساحة الفارغة في أعلى الصفحة، بالنقاط.

الإرجاع

‫Number - المساحة الفارغة في أعلى العنصر، بالنقاط

التفويض

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

  • 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

getParentRow()

يسترجع TableRow الذي يحتوي على TableCell الحالي.

الإرجاع

TableRow - صف الجدول الذي يحتوي على الخلية الحالية

التفويض

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

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

getParentTable()

يسترجع Table الذي يحتوي على TableCell الحالي.

الإرجاع

Table: الجدول الذي يحتوي على الخلية الحالية

التفويض

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

  • 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

getRowSpan()

يسترجع نطاق الصف، وهو عدد صفوف خلايا الجدول التي تمتد إليها هذه الخلية. تحتوي الخلايا غير المدمجة على نطاق صف واحد.

الإرجاع

Integer: نطاق الصف أو 0 لخلية تم دمجها مع خلية أخرى

التفويض

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

  • 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

getVerticalAlignment()

استرجاع VerticalAlignment

الإرجاع

VerticalAlignment — المحاذاة العمودية

التفويض

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

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

getWidth()

يسترجع عرض العمود الذي يحتوي على الخلية، بالنقاط.

الإرجاع

Number: عرض العمود بالنقاط

التفويض

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

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

insertHorizontalRule(childIndex)

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

سيتم تضمين الخط الأفقي في Paragraph جديد.

المعلمات

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

الإرجاع

HorizontalRule - الخط الأفقي الجديد

التفويض

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

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

insertImage(childIndex, image)

تُنشئ هذه الدالة عنصر InlineImage وتُدرِجه من قطعة بيانات الصورة المحدّدة في الترتيب المحدّد.

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

المعلمات

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

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();

الإرجاع

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

التفويض

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

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

removeChild(child)

تزيل العنصر الفرعي المحدّد.

المعلمات

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

الإرجاع

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

التفويض

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

  • 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();
}

الإرجاع

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

التفويض

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

  • 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سمات العنصر

الإرجاع

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

التفويض

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

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

setBackgroundColor(color)

لضبط لون الخلفية.

المعلمات

الاسمالنوعالوصف
colorStringلون الخلفية بتنسيق رمز CSS (مثل '#ffffff')

الإرجاع

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

التفويض

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

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

setLinkUrl(url)

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

المعلمات

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

الإرجاع

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

التفويض

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

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

setPaddingBottom(paddingBottom)

لضبط المساحة المتروكة في أسفل العنصر، بالنقاط

المعلمات

الاسمالنوعالوصف
paddingBottomNumberالمساحة المتروكة في أسفل العنصر، بالنقاط

الإرجاع

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

التفويض

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

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

setPaddingLeft(paddingLeft)

لضبط المساحة الفارغة اليسرى، بالنقاط

المعلمات

الاسمالنوعالوصف
paddingLeftNumberالمساحة الفارغة على يمين العنصر، بالنقاط

الإرجاع

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

التفويض

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

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

setPaddingRight(paddingRight)

لضبط المساحة الفارغة اليمنى، بالنقاط

المعلمات

الاسمالنوعالوصف
paddingRightNumberالمساحة الفارغة اليمنى، بالنقاط

الإرجاع

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

التفويض

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

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

setPaddingTop(paddingTop)

لضبط المساحة المتروكة في أعلى الصفحة، بالنقاط.

المعلمات

الاسمالنوعالوصف
paddingTopNumberسمك الحشو العلوي، بالنقاط

الإرجاع

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

التفويض

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

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

setText(text)

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

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

المعلمات

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

الإرجاع

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

التفويض

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

  • 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نوع محاذاة النص المطلوب تطبيقها

الإرجاع

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

التفويض

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

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

setVerticalAlignment(alignment)

لضبط المحاذاة العمودية

المعلمات

الاسمالنوعالوصف
alignmentVerticalAlignmentالمحاذاة العمودية

الإرجاع

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

التفويض

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

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

setWidth(width)

تُستخدَم لضبط عرض العمود الذي يحتوي على الخلية الحالية، بالنقاط.

المعلمات

الاسمالنوعالوصف
widthNumberعرض العمود، بالنقاط

الإرجاع

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

التفويض

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

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