Class RangeBuilder

RangeBuilder

Doküman öğelerinden Range nesneleri oluşturmak için kullanılan bir oluşturucudur.

// Change the user's selection to a range that includes every table in the
// active tab.
const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const rangeBuilder = documentTab.newRange();
const tables = documentTab.getBody().getTables();
for (let i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Yöntemler

YöntemDönüş türüKısa açıklama
addElement(element)RangeBuilderBu RangeBuilder öğesine Element öğesinin tamamını ekler.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderBu RangeBuilder öğesine kısmi bir Text öğesi ekler.
addElementsBetween(startElement, endElementInclusive)RangeBuilderBu RangeBuilder öğesine iki öğenin tamamını ve aralarındaki tüm öğeleri ekler.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderText öğesinin iki bölümünü ve aralarındaki tüm öğeleri RangeBuilder öğesine ekler.
addRange(range)RangeBuilderBaşka bir Range dosyasının içeriğini bu RangeBuilder dosyasına ekler.
build()RangeOluşturucuya uygulanan ayarlardan Range oluşturur.
getRangeElements()RangeElement[]Bu Range içindeki tüm öğeleri (kısmi Text öğeleri dahil) alır (örneğin, yalnızca bir Text öğesinin bir kısmını içeren bir seçim söz konusu olduğunda).

Ayrıntılı belgeler

addElement(element)

Bu RangeBuilder öğesine Element öğesinin tamamını ekler.

Parametreler

AdTürAçıklama
elementElementEklenecek öğe

Return

RangeBuilder: Zincirleme için bu oluşturucu

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

addElement(textElement, startOffset, endOffsetInclusive)

Bu RangeBuilder öğesine kısmi bir Text öğesi ekler.

Parametreler

AdTürAçıklama
textElementTextKısmen eklenecek metin öğesi
startOffsetIntegerDahil edilecek ilk karakterden önceki karakter sayısı (yani, aralıktaki ilk karakterin dizini)
endOffsetInclusiveIntegerDahil edilecek son karakterden önceki karakter sayısı (yani aralıktaki son karakterin dizini)

Return

RangeBuilder: Zincirleme için bu oluşturucu

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

addElementsBetween(startElement, endElementInclusive)

Bu RangeBuilder öğesine iki öğenin tamamını ve aralarındaki tüm öğeleri ekler.

Parametreler

AdTürAçıklama
startElementElementeklenecek ilk öğe
endElementInclusiveElementeklenen son öğe

Return

RangeBuilder: Zincirleme için bu oluşturucu

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

Text öğesinin iki bölümünü ve aralarındaki tüm öğeleri RangeBuilder öğesine ekler.

Parametreler

AdTürAçıklama
startTextElementTextKısmen eklenecek ilk metin öğesi
startOffsetIntegerstartTextElement öğesinin ilk karakterinden önce eklenecek karakter sayısı (yani aralıktaki ilk karakterin dizini)
endTextElementInclusiveTextKısmen eklenen son metin öğesi
endOffsetInclusiveIntegerendTextElementInclusive öğesinin son karakterinden önce eklenecek karakter sayısı (yani aralıktaki son karakterin dizini)

Return

RangeBuilder: Zincirleme için bu oluşturucu

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

addRange(range)

Başka bir Range dosyasının içeriğini bu RangeBuilder dosyasına ekler.

Parametreler

AdTürAçıklama
rangeRangeöğeleri eklenecek aralık

Return

RangeBuilder: Zincirleme için bu oluşturucu

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

build()

Oluşturucuya uygulanan ayarlardan Range oluşturur.

Return

Range: Yeni oluşturulan aralık


getRangeElements()

Bu Range içindeki tüm öğeleri (kısmi Text öğeleri dahil) alır (örneğin, yalnızca bir Text öğesinin bir kısmını içeren bir seçim söz konusu olduğunda). Text öğesinin aralığa yalnızca kısmen dahil olup olmadığını belirlemek için RangeElement.isPartial() bölümüne bakın.

Return

RangeElement[]: Öğelerin, dokümanda göründükleri sırayla yer aldığı bir dizi

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

Kullanımdan kaldırılan yöntemler