Class RangeElement

RangeElement

Başlangıç ve bitiş ofseti olabilen bir Element öğesinin etrafındaki sarmalayıcı. Bu kaydırmalar, Text öğesindeki bir karakter aralığının arama sonuçlarında, doküman seçimlerinde ve adlandırılmış aralıklarda gösterilmesine olanak tanır.

Yöntemler

YöntemDönüş türüKısa açıklama
getElement()ElementBu RangeElement ile eşleşen Element değerini alır.
getEndOffsetInclusive()IntegerAralık öğesi içindeki kısmi aralığın sonunun konumunu alır.
getStartOffset()IntegerAralık öğesi içindeki kısmi bir aralığın başlangıç konumunu alır.
isPartial()BooleanBu aralık öğesinin, öğenin tamamını mı yoksa öğe karakterlerinin kısmi bir seçimini mi kapsadığını belirler.

Ayrıntılı belgeler

getElement()

Bu RangeElement ile eşleşen Element değerini alır. 

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.');
}

Return

Element: Bu RangeElement öğesine karşılık gelen öğe

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan 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 aralığın sonunun konumunu alır. Öğe bir Text öğesiyse ve isPartial(), true değerini döndürüyorsa aralıktaki son karakterden önceki karakterlerin sayısı (yani aralıktaki son karakterin dizini) uzaklık olur. Diğer tüm durumlarda bu yöntem -1 değerini 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 kapsamlardan 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üyorsa kaydırma, aralığın başlangıcından önceki karakter sayısıdır (yani aralıktaki ilk karakterin dizini). Diğer tüm durumlarda bu yöntem -1 değerini döndürür.

Return

Integer: Text öğe için aralığın başlangıcından önceki karakter sayısı; diğer öğeler için -1

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan 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 kısmi bir seçimini mi kapsadığını belirler. Kısmi aralık öğesinin 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, dahil edilmemişse false

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan biri veya daha fazlasıyla yetkilendirme gerektirir:

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