یک لفاف در اطراف یک 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
را برمی گرداند، offset تعداد کاراکترهای قبل از آخرین کاراکتر در محدوده (یعنی شاخص آخرین کاراکتر در محدوده) است. در هر حالت دیگری، این روش -1
را برمی گرداند.
بازگشت
Integer
- برای عناصر Text
، تعداد کاراکتر قبل از آخرین نویسه در محدوده. برای سایر عناصر، -1
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getStartOffset()
موقعیت شروع یک محدوده جزئی را در عنصر محدوده بدست می آورد. اگر عنصر یک عنصر Text
باشد و isPartial()
true
را برمی گرداند، offset تعداد کاراکترهای قبل از شروع محدوده است (یعنی شاخص اولین کاراکتر در محدوده). در هر حالت دیگری، این روش -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