Class RangeElement

RangeElement

Olası bir başlangıç ve bitiş ofseti içeren bir Element sarmalayıcısı. Bu ofsetler, bir Text öğesindeki 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'a karşılık gelen Element değerini alır.
getEndOffsetInclusive()IntegerAralık öğesindeki kısmi bir aralığın sonunun konumunu alır.
getStartOffset()IntegerAralık öğesindeki kısmi 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ı dokümanlar

getElement()

Bu RangeElement'a karşılık gelen 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getEndOffsetInclusive()

Aralık öğesindeki kısmi bir aralığın sonunun konumunu alır. Öğe bir Text öğesiyse ve isPartial() true döndürüyorsa ofset, aralıktaki son karakterden önceki karakter sayısıdır (yani aralıktaki son karakterin dizini). Diğer durumlarda bu yöntem -1 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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

getStartOffset()

Aralık öğesindeki kısmi aralığın başlangıç konumunu alır. Öğe bir Text öğesiyse ve isPartial() true döndürüyorsa ofset, aralığın başlangıcından önceki karakter sayısıdır (yani aralıkta ilk karakterin dizini). Diğer durumlarda bu yöntem -1 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ının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

  • 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 sonu sırasıyla getStartOffset() ve getEndOffsetInclusive() kullanılarak belirlenebilir.

Return

Boolean: Öğe kısmen dahil edilmişse true, dahil edilmemişse false değerini döndürür.

Yetkilendirme

Bu yöntemi kullanan komut dosyalarının aşağıdaki kapsamlardan bir veya daha fazlası için yetkilendirilmesi gerekir:

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