Class RangeBuilder

RangeBuilder

Un generatore utilizzato per creare Range oggetti dagli elementi del documento. 

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

Metodi

MetodoTipo restituitoBreve descrizione
addElement(element)RangeBuilderAggiunge un'intera entità Element a questo RangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderAggiunge un elemento Text parziale a questo elemento RangeBuilder.
addElementsBetween(startElement, endElementInclusive)RangeBuilderAggiunge due interi elementi e tutti gli elementi separati a questo RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderAggiunge due elementi Text parziali e tutti gli elementi compresi in RangeBuilder.
addRange(range)RangeBuilderAggiunge i contenuti di un altro Range a questo RangeBuilder.
build()RangeCrea un elemento Range dalle impostazioni applicate al generatore.
getRangeElements()RangeElement[]Recupera tutti gli elementi in questo elemento 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'intera entità Element a questo RangeBuilder.

Parametri

NomeTipoDescrizione
elementElementl'elemento da aggiungere

Ritorni

RangeBuilder - questo generatore, 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 elemento RangeBuilder.

Parametri

NomeTipoDescrizione
textElementTextl'elemento di testo da aggiungere parzialmente
startOffsetIntegerIl numero di caratteri che precede il primo carattere da includere (ovvero l'indice del primo carattere dell'intervallo)
endOffsetInclusiveIntegeril numero di caratteri prima dell'ultimo carattere da includere (vale a dire l'indice dell'ultimo carattere dell'intervallo)

Ritorni

RangeBuilder - questo generatore, 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 interi elementi e tutti gli elementi separati a questo RangeBuilder.

Parametri

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

Ritorni

RangeBuilder - questo generatore, 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 compresi in RangeBuilder.

Parametri

NomeTipoDescrizione
startTextElementTextil primo elemento di testo da aggiungere parzialmente
startOffsetIntegerIl numero di caratteri che precede il primo carattere di startTextElement da includere (vale a dire l'indice del primo carattere dell'intervallo)
endTextElementInclusiveTextl'ultimo elemento di testo da aggiungere parzialmente
endOffsetInclusiveIntegeril numero di caratteri prima dell'ultimo carattere di endTextElementInclusive da includere (vale a dire l'indice dell'ultimo carattere dell'intervallo)

Ritorni

RangeBuilder - questo generatore, 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 Range a questo RangeBuilder.

Parametri

NomeTipoDescrizione
rangeRangel'intervallo di cui aggiungere gli elementi

Ritorni

RangeBuilder - questo generatore, 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 elemento Range dalle impostazioni applicate al generatore.

Ritorni

Range: l'intervallo appena creato

getRangeElements()

Recupera tutti gli elementi in questo elemento 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 elemento Text è incluso solo parzialmente nell'intervallo, consulta RangeElement.isPartial().

Ritorni

RangeElement[]: un array di elementi, nell'ordine in cui sono visualizzati 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