Class RangeElement

عنصر النطاق

غلاف حول Element مع إزاحة محتملة للبدء والانتهاء تسمح هذه العناصر المرجعية بتمثيل نطاق من الأحرف ضمن عنصر Text في نتائج البحث وعمليات اختيار المستندات والنطاقات المُسمّاة.

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
getElement()Elementتحصل على Element الذي يتوافق مع هذا RangeElement.
getEndOffsetInclusive()Integerتحصل على موضع نهاية نطاق جزئي ضمن عنصر النطاق.
getStartOffset()Integerتحصل على موضع بداية نطاق جزئي ضمن عنصر النطاق.
isPartial()Booleanتحدِّد ما إذا كان عنصر النطاق هذا يغطي العنصر بأكمله أو اختيارًا جزئيًا من أحرف العنصر.

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

getElement()

تحصل على Element الذي يتوافق مع هذا RangeElement. 

const rangeElement = DocumentApp.getActiveDocument().getSelection().getRangeElements()[0];

// Log debug information about a range element.
Logger.log(`Element type: ${rangeElement.getElement().getType()}`);
if (rangeElement.isPartial()) {
  Logger.log(`The character range begins at ${rangeElement.getStartOffset()}`);
  Logger.log(
      `The character range ends at ${rangeElement.getEndOffsetInclusive()}`,
  );
} else {
  Logger.log('The entire range element is included.');
}

الإرجاع

Element: العنصر الذي يتوافق مع هذا RangeElement

التفويض

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

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

getEndOffsetInclusive()

تحصل على موضع نهاية نطاق جزئي ضمن عنصر النطاق. إذا كان العنصر هو عنصر Text وعرض isPartial() القيمة true، يكون البدء هو عدد الأحرف قبل الحرف الأول في النطاق (أي فهرس الحرف الأول في النطاق). وفي أي حالة أخرى، تعرض هذه الطريقة القيمة -1.

الإرجاع

Integer — بالنسبة إلى عناصر Text، هو عدد الأحرف قبل الحرف الأخير في النطاق، وبالنسبة إلى العناصر الأخرى، هو -1

التفويض

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

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

getStartOffset()

تحصل على موضع بداية نطاق جزئي ضمن عنصر النطاق. إذا كان العنصر هو عنصر Text وعرضت isPartial() القيمة true، يكون البادئة هو عدد الأحرف قبل بداية النطاق (أي فهرس الحرف الأول في النطاق). وفي أي حالة أخرى، تعرض هذه العبارة -1.

الإرجاع

‫Integer: بالنسبة إلى عناصر Text، هو عدد الأحرف قبل بداية النطاق، وبالنسبة إلى العناصر الأخرى، هو -1

التفويض

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

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

isPartial()

تحدِّد ما إذا كان عنصر النطاق هذا يغطي العنصر بأكمله أو اختيارًا جزئيًا من أحرف العنصر. يمكن تحديد بداية ونهاية نطاق عنصر النطاق الجزئي باستخدام getStartOffset() وgetEndOffsetInclusive() على التوالي.

الإرجاع

‫Boolean: true إذا كان العنصر مضمّنًا جزئيًا، false إذا لم يكن كذلك

التفويض

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

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