Class RangeBuilder

RangeBuilder

Belge öğelerinden Range nesneleri oluşturmak için kullanılan derleyici.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var 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 bütün bir Element ekler.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderBu RangeBuilder öğesine kısmi bir Text öğesi ekler.
addElementsBetween(startElement, endElementInclusive)RangeBuilderİki tam öğeyi ve aralarındaki tüm öğeleri bu RangeBuilder öğesine ekler.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderİki kısmi Text öğesini ve bunların arasındaki tüm öğeleri RangeBuilder öğesine ekler.
addRange(range)RangeBuilderBu RangeBuilder öğesine başka bir Range öğesinin içeriğini ekler.
build()RangeOluşturucuya uygulanan ayarlardan bir Range oluşturur.
getRangeElements()RangeElement[]Kısmi Text öğeleri de dahil olmak üzere bu Range öğesindeki tüm öğeleri alır (örneğin, bir Text öğesinin yalnızca bir kısmını içeren bir seçim durumunda).

Ayrıntılı belgeler

addElement(element)

Bu RangeBuilder öğesine bütün bir Element ekler.

Parametreler

AdTürAçıklama
elementElementeklenecek öğe

Return

RangeBuilder — zincirleme bağlantı için bu derleyici

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

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)
endOffsetInclusiveIntegereklenecek son karakterden önceki karakter sayısı (yani aralıktaki son karakterin dizini)

Return

RangeBuilder — zincirleme bağlantı için bu derleyici

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

addElementsBetween(startElement, endElementInclusive)

İki tam öğeyi ve aralarındaki tüm öğeleri bu RangeBuilder öğesine ekler.

Parametreler

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

Return

RangeBuilder — zincirleme bağlantı için bu derleyici

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

İki kısmi Text öğesini ve bunların arasındaki tüm öğeleri RangeBuilder öğesine ekler.

Parametreler

AdTürAçıklama
startTextElementTextkısmen eklenecek ilk metin öğesi
startOffsetIntegerdahil edilecek startTextElement ilk karakterinden önceki karakter sayısı (yani aralıktaki ilk karakterin dizini)
endTextElementInclusiveTextkısmen eklenecek son metin öğesi
endOffsetInclusiveIntegerdahil edilecek endTextElementInclusive öğesinin son karakterinden önceki karakter sayısı (yani aralıktaki son karakterin dizini)

Return

RangeBuilder — zincirleme bağlantı için bu derleyici

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

addRange(range)

Bu RangeBuilder öğesine başka bir Range öğesinin içeriğini ekler.

Parametreler

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

Return

RangeBuilder — zincirleme bağlantı için bu derleyici

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

build()

Oluşturucuya uygulanan ayarlardan bir Range oluşturur.

Return

Range: Yeni oluşturulan aralık


getRangeElements()

Kısmi Text öğeleri de dahil olmak üzere bu Range öğesindeki tüm öğeleri alır (örneğin, bir Text öğesinin yalnızca bir kısmını içeren bir seçim durumunda). Bir Text öğesinin yalnızca aralığa kısmen dahil olup olmadığını belirlemek için RangeElement.isPartial() konusuna bakın.

Return

RangeElement[]: Dokümanda göründükleri sırayla bir öğe dizisi

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

Kullanımdan kaldırılan yöntemler