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.

المعلّمات

الاسمالنوعالوصف
elementElementالعنصر الذي ستتم إضافته

تذكرة ذهاب وعودة

RangeBuilder — أداة الإنشاء هذه للسلاسل

التفويض

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

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

addElement(textElement, startOffset, endOffsetInclusive)

تضيف عنصر Text جزئيًا إلى RangeBuilder.

المعلّمات

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

تذكرة ذهاب وعودة

RangeBuilder — أداة الإنشاء هذه للسلاسل

التفويض

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

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

addElementsBetween(startElement, endElementInclusive)

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

المعلّمات

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

تذكرة ذهاب وعودة

RangeBuilder — أداة الإنشاء هذه للسلاسل

التفويض

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

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

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

المعلّمات

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

تذكرة ذهاب وعودة

RangeBuilder — أداة الإنشاء هذه للسلاسل

التفويض

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

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

addRange(range)

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

المعلّمات

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

الطرق التي تم إيقافها نهائيًا