Class RangeBuilder

RangeBuilder

أداة إنشاء تُستخدَم لإنشاء عناصر Range من عناصر المستند.

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let 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).

الطرق المتوقّفة

الطريقة	نوع القيمة التي تم إرجاعها	وصف قصير
getSelectedElements()	RangeElement[]	تعرض هذه الطريقة جميع العناصر التي اختارها المستخدم في النسخة المفتوحة من المستند، بما في ذلك أي عناصر تم اختيارها جزئيًا.Text

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

addElement(element)

يضيف هذا الإجراء Element بالكامل إلى RangeBuilder.

المَعلمات

الاسم	النوع	الوصف
element	Element	العنصر المطلوب إضافته

الإرجاع

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

التفويض

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

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

---

addElement(textElement, startOffset, endOffsetInclusive)

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

المَعلمات

الاسم	النوع	الوصف
textElement	Text	عنصر النص المطلوب إضافته جزئيًا
startOffset	Integer	عدد الأحرف قبل الحرف الأول المطلوب تضمينه (أي فهرس الحرف الأول في النطاق)
endOffsetInclusive	Integer	عدد الأحرف قبل آخر حرف سيتم تضمينه (أي فهرس آخر حرف في النطاق)

الإرجاع

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

التفويض

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

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

---

addElementsBetween(startElement, endElementInclusive)

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

المَعلمات

الاسم	النوع	الوصف
startElement	Element	العنصر الأول الذي ستتم إضافته
endElementInclusive	Element	العنصر الأخير الذي سيتم إضافته

الإرجاع

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

التفويض

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

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

---

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

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

المَعلمات

الاسم	النوع	الوصف
startTextElement	Text	عنصر النص الأول الذي ستتم إضافته جزئيًا
startOffset	Integer	عدد الأحرف قبل الحرف الأول من startTextElement المطلوب تضمينها (أي فهرس الحرف الأول في النطاق)
endTextElementInclusive	Text	عنصر النص الأخير الذي ستتم إضافته جزئيًا
endOffsetInclusive	Integer	عدد الأحرف التي يجب تضمينها قبل الحرف الأخير من endTextElementInclusive (أي فهرس الحرف الأخير في النطاق)

الإرجاع

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

التفويض

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

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

---

addRange(range)

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

المَعلمات

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

الإرجاع

‫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

الطرق المتوقّفة

getSelectedElements()

تمّت إزالة هذا العمود. تمت إعادة التسمية إلى "getRangeElements()".

تعرض هذه الطريقة جميع العناصر التي اختارها المستخدم في النسخة المفتوحة من المستند، بما في ذلك أي عناصر تم اختيارها جزئيًا.Text

الإرجاع

‫RangeElement[]: مصفوفة من العناصر المحدّدة أو المحدّدة جزئيًا، بالترتيب الذي تظهر به في المستند

التفويض

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

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