Class RangeBuilder

RangeBuilder

Un builder utilizzato per creare oggetti Range a partire da elementi di documenti. 

// 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());

Metodi

MetodoTipo restituitoBreve descrizione
addElement(element)RangeBuilderAggiunge un intero Element a questo RangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderAggiunge un elemento Text parziale a questo RangeBuilder.
addElementsBetween(startElement, endElementInclusive)RangeBuilderAggiunge due elementi interi, e tutti gli elementi tra di essi, a RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderAggiunge due elementi Text parziali e tutti gli elementi tra di loro, alla RangeBuilder.
addRange(range)RangeBuilderAggiunge i contenuti di un altro elemento Range a questo RangeBuilder.
build()RangeCrea un Range dalle impostazioni applicate al builder.
getRangeElements()RangeElement[]Recupera tutti gli elementi in questo Range, inclusi eventuali elementi Text parziali (ad esempio, nel caso di una selezione che include solo parte di un elemento Text).

Documentazione dettagliata

addElement(element)

Aggiunge un intero Element a questo RangeBuilder.

Parametri

NomeTipoDescrizione
elementElementl'elemento da aggiungere

Invio

RangeBuilder: questo builder, per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addElement(textElement, startOffset, endOffsetInclusive)

Aggiunge un elemento Text parziale a questo RangeBuilder.

Parametri

NomeTipoDescrizione
textElementTextl'elemento di testo da aggiungere parzialmente
startOffsetIntegeril numero di caratteri prima del primo carattere da includere (ossia, l'indice del primo carattere nell'intervallo)
endOffsetInclusiveIntegeril numero di caratteri prima dell'ultimo carattere da includere (vale a dire, l'indice dell'ultimo carattere dell'intervallo)

Invio

RangeBuilder: questo builder, per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addElementsBetween(startElement, endElementInclusive)

Aggiunge due elementi interi, e tutti gli elementi tra di essi, a RangeBuilder.

Parametri

NomeTipoDescrizione
startElementElementil primo elemento da aggiungere
endElementInclusiveElementl'ultimo elemento da aggiungere

Invio

RangeBuilder: questo builder, per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)

Aggiunge due elementi Text parziali e tutti gli elementi tra di loro, alla RangeBuilder.

Parametri

NomeTipoDescrizione
startTextElementTextil primo elemento di testo da aggiungere parzialmente
startOffsetIntegeril numero di caratteri prima del primo carattere di startTextElement da includere (ovvero l'indice del primo carattere nell'intervallo)
endTextElementInclusiveTextl'ultimo elemento di testo da aggiungere parzialmente
endOffsetInclusiveIntegeril numero di caratteri prima dell'ultimo carattere di endTextElementInclusive da includere (ovvero l'indice dell'ultimo carattere nella intervallo)

Invio

RangeBuilder: questo builder, per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

addRange(range)

Aggiunge i contenuti di un altro elemento Range a questo RangeBuilder.

Parametri

NomeTipoDescrizione
rangeRangel'intervallo i cui elementi devono essere aggiunti

Invio

RangeBuilder: questo builder, per il concatenamento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

build()

Crea un Range dalle impostazioni applicate al builder.

Invio

Range: l'intervallo appena creato

getRangeElements()

Recupera tutti gli elementi in questo Range, inclusi eventuali elementi Text parziali (ad esempio, nel caso di una selezione che include solo parte di un elemento Text). Per determinare se un Text elemento è incluso solo parzialmente nell'intervallo. Consulta RangeElement.isPartial().

Invio

RangeElement[]: un array di elementi, nell'ordine in cui appaiono nel documento

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

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

Metodi deprecati