Class RangeElement

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