Class RangeBuilder

RangeBuilder

يشير ذلك المصطلح إلى أداة تُستخدَم لإنشاء عناصر Range من عناصر المستند.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

الطُرق

الطريقةنوع القيمة التي يتم إرجاعهاوصف قصير
addElement(element)RangeBuilderإضافة Element بالكامل إلى RangeBuilder
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderلإضافة عنصر Text جزئي إلى عنصر RangeBuilder هذا.
addElementsBetween(startElement, endElementInclusive)RangeBuilderلإضافة عنصرين كاملين، وجميع العناصر بينهما، إلى هذا RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderلإضافة عنصرَي Text جزئي وكل العناصر بينهما إلى RangeBuilder.
addRange(range)RangeBuilderإضافة محتوى Range آخر إلى هذه RangeBuilder.
build()Rangeتنشئ هذه الدالة Range من الإعدادات المطبّقة على أداة الإنشاء.
getRangeElements()RangeElement[]للحصول على جميع العناصر في Range هذا، بما في ذلك أي عناصر Text جزئية (على سبيل المثال، في حال اختيار يتضمن جزءًا فقط من Text).

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

addElement(element)

إضافة Element بالكامل إلى RangeBuilder

المَعلمات

الاسمTypeالوصف
elementElementالعنصر المراد إضافته

استرجاع الكرة

RangeBuilder: أداة إنشاء السلاسل

التفويض

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

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

addElement(textElement, startOffset, endOffsetInclusive)

لإضافة عنصر Text جزئي إلى عنصر RangeBuilder هذا.

المَعلمات

الاسمTypeالوصف
textElementTextالعنصر النصي المراد إضافته جزئيًا
startOffsetIntegerعدد الأحرف قبل الحرف الأول المطلوب تضمينه (أي فهرس الحرف الأول في النطاق)
endOffsetInclusiveIntegerعدد الأحرف قبل الحرف الأخير المطلوب تضمينه (أي فهرس آخر حرف في النطاق)

استرجاع الكرة

RangeBuilder: أداة إنشاء السلاسل

التفويض

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

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

addElementsBetween(startElement, endElementInclusive)

لإضافة عنصرين كاملين، وجميع العناصر بينهما، إلى هذا RangeBuilder.

المَعلمات

الاسمTypeالوصف
startElementElementالعنصر الأول الذي تتم إضافته
endElementInclusiveElementالعنصر الأخير الذي تتم إضافته

استرجاع الكرة

RangeBuilder: أداة إنشاء السلاسل

التفويض

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

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

لإضافة عنصرَي Text جزئي وكل العناصر بينهما إلى RangeBuilder.

المَعلمات

الاسمTypeالوصف
startTextElementTextالعنصر النصي الأول الذي ستتم إضافته جزئيًا
startOffsetIntegerعدد الأحرف قبل الحرف الأول من startTextElement المراد تضمينه (أي فهرس الحرف الأول في النطاق)
endTextElementInclusiveTextالعنصر النصي الأخير الذي ستتم إضافته جزئيًا
endOffsetInclusiveIntegerعدد الأحرف قبل الحرف الأخير من endTextElementInclusive المراد تضمينه (أي فهرس الحرف الأخير في النطاق)

استرجاع الكرة

RangeBuilder: أداة إنشاء السلاسل

التفويض

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

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

addRange(range)

إضافة محتوى Range آخر إلى هذه RangeBuilder.

المَعلمات

الاسمTypeالوصف
rangeRangeالنطاق الذي يجب إضافة عناصره

استرجاع الكرة

RangeBuilder: أداة إنشاء السلاسل

التفويض

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

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

build()

تنشئ هذه الدالة Range من الإعدادات المطبّقة على أداة الإنشاء.

استرجاع الكرة

Range - النطاق الذي تم إنشاؤه حديثًا


getRangeElements()

للحصول على جميع العناصر في Range هذا، بما في ذلك أي عناصر Text جزئية (على سبيل المثال، في حال اختيار يتضمن جزءًا فقط من Text). لتحديد ما إذا كان العنصر Text مضمَّنًا بشكل جزئي في النطاق، يمكنك الاطّلاع على RangeElement.isPartial().

استرجاع الكرة

RangeElement[]: مصفوفة من العناصر بالترتيب الذي تظهر به في المستند

التفويض

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

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

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