Class RangeBuilder

RangeBuilder

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

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

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