Class RangeBuilder

RangeBuilder

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

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

Ayrıntılı belgeler

addElement(element)

Bu RangeBuilder öğesine tüm Element 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 bir 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
startOffsetIntegereklenecek 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 için bu oluşturucu

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir 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 bunların arasındaki tüm öğeleri bu RangeBuilder öğesine ekler.

Parametreler

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

Return

RangeBuilder — zincirleme için bu oluşturucu

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir 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 ilk startTextElement karakterinden önceki karakter sayısı (yani aralıktaki ilk karakterin dizini)
endTextElementInclusiveTextkısmen eklenecek son metin öğesi
endOffsetInclusiveIntegerdahil edilecek son endTextElementInclusive karakterinden önceki karakter sayısı (yani aralık)

Return

RangeBuilder — zincirleme için bu oluşturucu

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir 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 içeriğini bu RangeBuilder öğesine ekler.

Parametreler

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

Return

RangeBuilder — zincirleme için bu oluşturucu

Yetkilendirme

Bu yöntemi kullanan komut dosyaları, aşağıdaki kapsamlardan bir 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 dahil olmak üzere bu Range içindeki tüm öğeleri alır (örneğin, Text öğesinin yalnızca bir kısmını içeren bir seçimin). Bir projenin Text öğesi aralığa yalnızca kısmen dahil edilmiş, bkz. RangeElement.isPartial().

Return

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

Yetkilendirme

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

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

Desteği sonlandırılan yöntemler