Class 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