Class RangeElement

RangeElement

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

الطُرق

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

الوثائق التفصيلية

getElement()

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

// 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