Class ListItem

ListItem

عنصر يمثّل عنصر قائمة ListItem هو Paragraph مرتبط بمعرّف قائمة. قد يحتوي ListItem على عناصر Equation وFootnote وHorizontalRule وInlineDrawing وInlineImage وPageBreak وText. لمزيد من المعلومات حول بنية المستند، يُرجى الاطّلاع على دليل توسيع "مستندات Google".

لا يمكن أن يحتوي ListItems على أحرف سطر جديد. يتم تحويل أحرف السطر الجديد ("\n") إلى أحرف فاصل الأسطر ("\r").

ListItems التي تحمل رقم تعريف القائمة نفسه تنتمي إلى القائمة نفسها ويتم ترقيمها وفقًا لذلك. ليس من الضروري أن تكون ListItems لقائمة معيّنة متجاورة في علامة التبويب أو حتى أن يكون لها العنصر الرئيسي نفسه. يمكن أن يظهر عنصران ينتميان إلى القائمة نفسها في أي مكان ضمن علامة التبويب مع الحفاظ على الترقيم المتسلسل، كما يوضّح المثال التالي:

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

// Append a new list item to the body.
const item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([['Cell 1', 'Cell 2']]);

// Append a second list item with the same list ID. The two items are treated as
// the same list, despite not being consecutive.
const item2 = body.appendListItem('Item 2');
item2.setListId(item1);

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
addPositionedImage(image)PositionedImageتنشئ هذه الدالة PositionedImage جديدًا وتُدرجه من كائن ثنائي كبير الحجم للصورة المحدّدة.
appendHorizontalRule()HorizontalRuleتنشئ هذه السمة HorizontalRule جديدة وتلحقها.
appendInlineImage(image)InlineImageتنشئ هذه الطريقة InlineImage جديدًا وتضيفه من كائن ثنائي كبير الحجم للصورة المحدّدة.
appendInlineImage(image)InlineImageتُلحق هذه السمة InlineImage المحدّدة.
appendPageBreak()PageBreakتنشئ هذه السمة PageBreak جديدة وتلحقها.
appendPageBreak(pageBreak)PageBreakتُلحق هذه السمة PageBreak المحدّدة.
appendText(text)Textتنشئ هذه الطريقة عنصر Text جديدًا وتضيفه إلى نهاية المستند مع المحتوى المحدّد.
appendText(text)Textتُلحق هذه السمة العنصر Text المحدّد.
clear()ListItemيمحو محتوى العنصر.
copy()ListItemتعرض نسخة منفصلة وعميقة من العنصر الحالي.
editAsText()Textيحصل على نسخة Text من العنصر الحالي لتعديلها.
findElement(elementType)RangeElement|nullيبحث في محتوى العنصر عن عنصر فرعي من النوع المحدّد.
findElement(elementType, from)RangeElement|nullيبحث في محتويات العنصر عن عنصر فرعي من النوع المحدّد، بدءًا من RangeElement المحدّد.
findText(searchPattern)RangeElement|nullيبحث في محتوى العنصر عن نمط النص المحدّد باستخدام التعبيرات العادية.
findText(searchPattern, from)RangeElement|nullيبحث في محتوى العنصر عن نمط النص المحدّد، بدءًا من نتيجة بحث معيّنة.
getAlignment()HorizontalAlignment|nullيستردّ HorizontalAlignment.
getAttributes()Objectيستردّ سمات العنصر.
getChild(childIndex)Elementيستردّ العنصر الفرعي في فهرس العنصر الفرعي المحدّد.
getChildIndex(child)Integerيستردّ هذا الإجراء فهرس العنصر الفرعي للعنصر الفرعي المحدّد.
getGlyphType()GlyphType|nullيسترد هذا الإجراء GlyphType عنصر القائمة.
getHeading()ParagraphHeading|nullيستردّ ParagraphHeading.
getIndentEnd()Number|nullتعرض هذه السمة المسافة البادئة في نهاية الفقرة، بالنقاط.
getIndentFirstLine()Number|nullتعرض هذه السمة المسافة البادئة للسطر الأول، بالنقاط.
getIndentStart()Number|nullتعرض هذه الطريقة مسافة البادئة في بداية السطر.
getLineSpacing()Number|nullتعرض هذه السمة تباعد الأسطر بالنقاط.
getLinkUrl()String|nullتعرض هذه السمة عنوان URL للرابط.
getListId()String|nullيستردّ معرّف القائمة.
getNestingLevel()Integerتعرض هذه السمة مستوى الدمج لعنصر القائمة.
getNextSibling()Element|nullيستردّ العنصر الشقيق التالي للعنصر.
getNumChildren()Integerتعرض هذه السمة عدد الأطفال.
getParent()ContainerElement|nullتعرض هذه السمة العنصر الرئيسي للعنصر الحالي.
getPositionedImage(id)PositionedImageتعرض هذه الطريقة PositionedImage حسب رقم تعريف الصورة.
getPositionedImages()PositionedImage[]تعرض هذه الدالة جميع عناصر PositionedImage المرتبطة بالفقرة.
getPreviousSibling()Element|nullيستردّ هذا الإجراء العنصر الشقيق السابق للعنصر.
getSpacingAfter()Number|nullتعرض هذه السمة المسافة بعد العنصر، بالنقاط.
getSpacingBefore()Number|nullتعرض هذه السمة المسافة قبل العنصر، بوحدة النقاط.
getText()Stringتعرض محتوى العنصر كسلسلة نصية.
getTextAlignment()TextAlignment|nullتعرض هذه السمة محاذاة النص.
getType()ElementTypeيستردّ ElementType العنصر.
insertHorizontalRule(childIndex)HorizontalRuleتنشئ هذه الدالة HorizontalRule وتُدرجه في الفهرس المحدّد.
insertInlineImage(childIndex, image)InlineImageتنشئ هذه الدالة InlineImage جديدًا وتُدرجه من كائن ثنائي كبير الحجم للصورة المحددة، وذلك في الفهرس المحدد.
insertInlineImage(childIndex, image)InlineImageتُدرِج هذه الدالة القيمة InlineImage المحدّدة في الفهرس المحدّد.
insertPageBreak(childIndex)PageBreakتُنشئ هذه الطريقة عنصر PageBreak جديدًا وتُدرجه في الفهرس المحدّد.
insertPageBreak(childIndex, pageBreak)PageBreakتُدرِج هذه الدالة القيمة PageBreak المحدّدة في الفهرس المحدّد.
insertText(childIndex, text)Textتُنشئ هذه الطريقة عنصر نص جديدًا وتُدرجه في الفهرس المحدّد.
insertText(childIndex, text)Textتُدرج هذه الطريقة عنصر Text المحدّد في الفهرس المحدّد، مع محتوى النص المحدّد.
isAtDocumentEnd()Booleanتحدّد هذه السمة ما إذا كان العنصر في نهاية Document.
isLeftToRight()Boolean|nullتعرض هذه السمة إعدادات الكتابة من اليسار إلى اليمين.
merge()ListItem|nullيدمج العنصر مع العنصر الشقيق السابق من النوع نفسه.
removeChild(child)ListItemيزيل العنصر الفرعي المحدّد.
removeFromParent()ListItem|nullيزيل العنصر من العنصر الأصل.
removePositionedImage(id)Booleanيزيل PositionedImage حسب رقم تعريف الصورة.
replaceText(searchPattern, replacement)Elementلاستبدال جميع تكرارات نمط نصي معيّن بسلسلة استبدال معيّنة، باستخدام التعبيرات العادية.
setAlignment(alignment)ListItemتضبط هذه السمة قيمة HorizontalAlignment.
setAttributes(attributes)ListItemتضبط هذه السمة سمات العنصر.
setGlyphType(glyphType)ListItemتضبط هذه السمة GlyphType لعنصر القائمة.
setHeading(heading)ListItemتضبط هذه السمة قيمة ParagraphHeading.
setIndentEnd(indentEnd)ListItemتضبط هذه السمة المسافة البادئة للنهاية بالنقاط.
setIndentFirstLine(indentFirstLine)ListItemتضبط هذه السمة المسافة البادئة للسطر الأول، بالنقاط.
setIndentStart(indentStart)ListItemتضبط هذه السمة المسافة البادئة في البداية، بالنقاط.
setLeftToRight(leftToRight)ListItemتضبط هذه السمة الإعداد من اليسار إلى اليمين.
setLineSpacing(multiplier)ListItemتضبط هذه السمة تباعد الأسطر، ككمية تشير إلى عدد الأسطر المطلوب استخدامها للتباعد.
setLinkUrl(url)ListItemيضبط عنوان URL للرابط.
setListId(listItem)ListItemتضبط هذه السمة رقم تعريف القائمة.
setNestingLevel(nestingLevel)ListItemتضبط هذه السمة مستوى الدمج لعنصر القائمة.
setSpacingAfter(spacingAfter)ListItemتضبط هذه السمة التباعد بعد العنصر، بالنقاط.
setSpacingBefore(spacingBefore)ListItemتضبط هذه السمة المسافة قبل العنصر بالنقاط.
setText(text)voidتضبط هذه السمة محتوى عنصر القائمة كنص.
setTextAlignment(textAlignment)ListItemتضبط هذه السمة محاذاة النص.

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

addPositionedImage(image)

تنشئ هذه الدالة PositionedImage جديدًا وتُدرجه من كائن ثنائي كبير الحجم للصورة المحدّدة.

المعلمات

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

الإرجاع

PositionedImage: الصورة الجديدة الموضّعة

التفويض

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

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

appendHorizontalRule()

تنشئ هذه السمة HorizontalRule جديدة وتلحقها.

الإرجاع

HorizontalRule: خط التسطير الأفقي الجديد

التفويض

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

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

appendInlineImage(image)

تنشئ هذه الطريقة InlineImage جديدًا وتضيفه من كائن ثنائي كبير الحجم للصورة المحدّدة.

المعلمات

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

الإرجاع

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

التفويض

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

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

appendInlineImage(image)

تُلحق هذه السمة InlineImage المحدّدة.

المعلمات

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

الإرجاع

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

التفويض

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

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

appendPageBreak()

تنشئ هذه السمة PageBreak جديدة وتلحقها.

ملاحظة: قد لا يكون PageBreaks مضمّنًا في TableCells. سيتم إنشاء استثناء إذا كان العنصر الحالي مضمّنًا في خلية جدول.

الإرجاع

PageBreak — عنصر فاصل الصفحات الجديد

التفويض

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

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

appendPageBreak(pageBreak)

تُلحق هذه السمة PageBreak المحدّدة.

ملاحظة: قد لا يكون PageBreaks مضمّنًا في TableCells. سيتم إنشاء استثناء إذا كان العنصر الحالي مضمّنًا في خلية جدول.

المعلمات

الاسمالنوعالوصف
pageBreakPageBreakفاصل الصفحة المطلوب إلحاقه

الإرجاع

PageBreak: عنصر فاصل الصفحات الملحق

التفويض

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

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

appendText(text)

تنشئ هذه الطريقة عنصر Text جديدًا وتضيفه إلى نهاية المستند مع المحتوى المحدّد.

المعلمات

الاسمالنوعالوصف
textStringمحتوى النص

الإرجاع

Text: عنصر النص الجديد

التفويض

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

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

appendText(text)

تُلحق هذه السمة العنصر Text المحدّد.

المعلمات

الاسمالنوعالوصف
textTextعنصر النص المطلوب إلحاقه

الإرجاع

Text: عنصر النص الملحق

التفويض

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

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

clear()

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

الإرجاع

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


copy()

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

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

الإرجاع

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

التفويض

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

  • 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|null: نتيجة بحث تشير إلى موضع عنصر البحث.

التفويض

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

  • 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|null: نتيجة بحث تشير إلى الموضع التالي لعنصر البحث.

التفويض

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

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

findText(searchPattern)

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

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

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

المعلمات

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

الإرجاع

RangeElement|null — نتيجة بحث تشير إلى موضع نص البحث، أو قيمة فارغة إذا لم تكن هناك أي مطابقة

التفويض

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

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

findText(searchPattern, from)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

getAlignment()

يستردّ HorizontalAlignment.

الإرجاع

HorizontalAlignment|null: المحاذاة

التفويض

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

  • 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

getGlyphType()

يسترد هذا الإجراء GlyphType عنصر القائمة.

الإرجاع

GlyphType|null: نوع الحرف الرسومي

التفويض

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

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

getHeading()

يستردّ ParagraphHeading.

الإرجاع

ParagraphHeading|null: العنوان

التفويض

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

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

getIndentEnd()

تعرض هذه السمة المسافة البادئة في نهاية الفقرة، بالنقاط.

الإرجاع

Number|null — المسافة البادئة للنهاية، بالنقاط

التفويض

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

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

getIndentFirstLine()

تعرض هذه السمة المسافة البادئة للسطر الأول، بالنقاط.

الإرجاع

Number|null: المسافة البادئة للسطر الأول، بالنقاط

التفويض

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

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

getIndentStart()

تعرض هذه الطريقة مسافة البادئة في بداية السطر.

الإرجاع

Number|null: المسافة البادئة الأولى

التفويض

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

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

getLineSpacing()

تعرض هذه السمة تباعد الأسطر بالنقاط.

الإرجاع

Number|null: تباعد الأسطر بالنقاط

التفويض

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

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

getLinkUrl()

تعرض هذه السمة عنوان URL للرابط.

الإرجاع

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

التفويض

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

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

getListId()

يستردّ معرّف القائمة.

الإرجاع

String|null: رقم تعريف القائمة

التفويض

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

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

getNestingLevel()

تعرض هذه السمة مستوى الدمج لعنصر القائمة.

تكون عناصر القائمة تلقائيًا في مستوى دمج صفر. يحدّد مستوى التداخل الرمز الرسومي الذي يستخدمه عنصر القائمة.

الإرجاع

Integer: مستوى التداخل

التفويض

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

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

getNextSibling()

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

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

الإرجاع

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

التفويض

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

  • 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|null: العنصر الرئيسي

التفويض

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

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

getPositionedImage(id)

تعرض هذه الطريقة PositionedImage حسب رقم تعريف الصورة.

المعلمات

الاسمالنوعالوصف
idStringمعرّف الصورة

الإرجاع

PositionedImage: الصورة التي تم ضبط موضعها

التفويض

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

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

getPositionedImages()

تعرض هذه الدالة جميع عناصر PositionedImage المرتبطة بالفقرة.

الإرجاع

PositionedImage[]: قائمة بالصور الموضّحة

التفويض

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

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

getPreviousSibling()

يستردّ هذا الإجراء العنصر الشقيق السابق للعنصر.

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

الإرجاع

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

التفويض

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

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

getSpacingAfter()

تعرض هذه السمة المسافة بعد العنصر، بالنقاط.

الإرجاع

Number|null: المسافة بعد العنصر، بالنقاط

التفويض

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

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

getSpacingBefore()

تعرض هذه السمة المسافة قبل العنصر، بوحدة النقاط.

الإرجاع

Number|null: المسافة قبل العنصر، بالنقاط

التفويض

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

  • 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: نوع محاذاة النص، أو 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

insertHorizontalRule(childIndex)

تنشئ هذه الدالة HorizontalRule وتُدرجه في الفهرس المحدّد.

المعلمات

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

الإرجاع

HorizontalRule: عنصر خط التسطير الأفقي الجديد

التفويض

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

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

insertInlineImage(childIndex, image)

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

المعلمات

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

الإرجاع

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

التفويض

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

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

insertInlineImage(childIndex, image)

تُدرِج هذه الدالة القيمة InlineImage المحدّدة في الفهرس المحدّد.

المعلمات

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

الإرجاع

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

التفويض

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

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

insertPageBreak(childIndex)

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

ملاحظة: قد لا يكون PageBreaks مضمّنًا في TableCells. سيتم إنشاء استثناء إذا كان العنصر الحالي مضمّنًا في خلية جدول.

المعلمات

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

الإرجاع

PageBreak — عنصر فاصل الصفحات الجديد

التفويض

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

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

insertPageBreak(childIndex, pageBreak)

تُدرِج هذه الدالة القيمة PageBreak المحدّدة في الفهرس المحدّد.

ملاحظة: قد لا يكون PageBreaks مضمّنًا في TableCells. سيتم إنشاء استثناء إذا كان العنصر الحالي مضمّنًا في خلية جدول.

المعلمات

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

الإرجاع

PageBreak: عنصر فاصل الصفحات المُدرَج

التفويض

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

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

insertText(childIndex, text)

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

المعلمات

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

الإرجاع

Text: عنصر النص الجديد

التفويض

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

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

insertText(childIndex, text)

تُدرج هذه الطريقة عنصر Text المحدّد في الفهرس المحدّد، مع محتوى النص المحدّد.

المعلمات

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

الإرجاع

Text: عنصر النص المُدرَج

التفويض

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

  • 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

isLeftToRight()

تعرض هذه السمة إعدادات الكتابة من اليسار إلى اليمين.

الإرجاع

Boolean|null: الإعداد من اليسار إلى اليمين

التفويض

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

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

الإرجاع

ListItem|null: العنصر المدمج

التفويض

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

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

removeChild(child)

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

المعلمات

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

الإرجاع

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

التفويض

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

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

الإرجاع

ListItem|null: العنصر الذي تمت إزالته

التفويض

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

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

removePositionedImage(id)

يزيل PositionedImage حسب رقم تعريف الصورة.

المعلمات

الاسمالنوعالوصف
idString

الإرجاع

Boolean: ما إذا تمت إزالة الصورة المحدّدة أم لا

التفويض

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

  • 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

setAlignment(alignment)

تضبط هذه السمة قيمة HorizontalAlignment.

المعلمات

الاسمالنوعالوصف
alignmentHorizontalAlignmentالمحاذاة الأفقية

الإرجاع

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

التفويض

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

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

الإرجاع

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

التفويض

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

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

setGlyphType(glyphType)

تضبط هذه السمة GlyphType لعنصر القائمة.

المعلمات

الاسمالنوعالوصف
glyphTypeGlyphTypeنوع الحرف الرسومي

الإرجاع

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

التفويض

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

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

setHeading(heading)

تضبط هذه السمة قيمة ParagraphHeading.

المعلمات

الاسمالنوعالوصف
headingParagraphHeadingالعنوان

الإرجاع

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

التفويض

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

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

setIndentEnd(indentEnd)

تضبط هذه السمة المسافة البادئة للنهاية بالنقاط.

المعلمات

الاسمالنوعالوصف
indentEndNumberالمسافة البادئة للنهاية، بالنقاط

الإرجاع

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

التفويض

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

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

setIndentFirstLine(indentFirstLine)

تضبط هذه السمة المسافة البادئة للسطر الأول، بالنقاط.

المعلمات

الاسمالنوعالوصف
indentFirstLineNumberالمسافة البادئة للسطر الأول، بالنقاط

الإرجاع

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

التفويض

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

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

setIndentStart(indentStart)

تضبط هذه السمة المسافة البادئة في البداية، بالنقاط.

المعلمات

الاسمالنوعالوصف
indentStartNumberالمسافة البادئة الأولى، بالنقاط

الإرجاع

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

التفويض

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

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

setLeftToRight(leftToRight)

تضبط هذه السمة الإعداد من اليسار إلى اليمين.

المعلمات

الاسمالنوعالوصف
leftToRightBooleanالإعداد من اليسار إلى اليمين

الإرجاع

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

التفويض

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

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

setLineSpacing(multiplier)

تضبط هذه السمة تباعد الأسطر، ككمية تشير إلى عدد الأسطر المطلوب استخدامها للتباعد.

المعلمات

الاسمالنوعالوصف
multiplierNumberعدد الأسطر

الإرجاع

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

التفويض

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

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

setLinkUrl(url)

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

المعلمات

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

الإرجاع

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

التفويض

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

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

setListId(listItem)

تضبط هذه السمة رقم تعريف القائمة.

يتم ضبط رقم تعريف القائمة على القيمة نفسها ListItem المحدّدة. سيتم التعامل مع ListItems على أنّهما عنصران في القائمة نفسها.

المعلمات

الاسمالنوعالوصف
listItemListItemعنصر القائمة الذي سيتم استخدام رقم تعريف القائمة الخاص به

الإرجاع

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

التفويض

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

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

setNestingLevel(nestingLevel)

تضبط هذه السمة مستوى الدمج لعنصر القائمة.

تكون عناصر القائمة تلقائيًا في مستوى دمج صفر. يحدّد مستوى التداخل الرمز الرسومي الذي يستخدمه عنصر القائمة.

المعلمات

الاسمالنوعالوصف
nestingLevelIntegerمستوى التداخل

الإرجاع

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

التفويض

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

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

setSpacingAfter(spacingAfter)

تضبط هذه السمة التباعد بعد العنصر، بالنقاط.

المعلمات

الاسمالنوعالوصف
spacingAfterNumberالمسافة بعد العنصر، بالنقاط

الإرجاع

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

التفويض

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

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

setSpacingBefore(spacingBefore)

تضبط هذه السمة المسافة قبل العنصر بالنقاط.

المعلمات

الاسمالنوعالوصف
spacingBeforeNumberالمسافة قبل العنصر، بالنقاط

الإرجاع

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

التفويض

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

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

setText(text)

تضبط هذه السمة محتوى عنصر القائمة كنص.

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

المعلمات

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

التفويض

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

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

الإرجاع

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

التفويض

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

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