Element öğesinin etrafında, olası bir başlangıç ve bitiş ofseti olan bir sarmalayıcı. Bu ofsetler, Text öğesi içindeki bir karakter aralığının arama sonuçlarında, belge seçimlerinde ve adlandırılmış aralıklarda temsil edilmesine olanak tanır.
Yöntemler
| Yöntem | Dönüş türü | Kısa açıklama |
|---|---|---|
getElement() | Element | Bu RangeElement öğesine karşılık gelen Element değerini alır. |
getEndOffsetInclusive() | Integer | Aralık öğesi içindeki kısmi bir aralığın bitişinin konumunu alır. |
getStartOffset() | Integer | Aralık öğesi içindeki kısmi bir aralığın başlangıç konumunu alır. |
isPartial() | Boolean | Bu aralık öğesinin, öğenin tamamını mı yoksa öğe karakterlerinin bir kısmını mı kapsayacağını belirler. |
Ayrıntılı belgeler
getElement()
Bu RangeElement öğesine karşılık gelen Element değerini alır.
// 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.');
}
Return
Element: Bu RangeElement'a karşılık gelen öğe
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getEndOffsetInclusive()
Aralık öğesi içindeki kısmi bir aralığın bitişinin konumunu alır. Öğe bir Text öğesiyse ve isPartial() true değerini döndürürse uzaklık, aralıktaki son karakterden (yani aralıktaki son karakterin dizini) önceki karakter sayısıdır. Diğer tüm durumlarda bu yöntem -1 sonucunu döndürür.
Return
Integer — Text öğeleri için aralıktaki son karakterden önceki karakter sayısı; diğer öğeler için -1
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
getStartOffset()
Aralık öğesi içindeki kısmi bir aralığın başlangıç konumunu alır. Öğe bir Text öğesiyse ve isPartial() true değerini döndürürse uzaklık, aralığın başlangıcından (yani aralıktaki ilk karakterin dizini) önceki karakter sayısıdır. Diğer tüm durumlarda bu yöntem -1 değerini döndürür.
Return
Integer — Text öğeleri için aralık başlangıcından önceki karakter sayısı; diğer öğeler için -1
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents
isPartial()
Bu aralık öğesinin, öğenin tamamını mı yoksa öğe karakterlerinin bir kısmını mı kapsayacağını belirler. Kısmi aralık öğesi aralığının başlangıcı ve bitişi, sırasıyla getStartOffset() ve getEndOffsetInclusive() kullanılarak belirlenebilir.
Return
Boolean: Öğe kısmen dahil edilmişse true; yoksa false
Yetkilendirme
Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamların biri veya daha fazlasıyla yetkilendirme gerektirir:
-
https://www.googleapis.com/auth/documents.currentonly -
https://www.googleapis.com/auth/documents