Class ListItem

ListItem

Un elemento che rappresenta un elemento dell'elenco. Un ListItem è un Paragraph associato a un ID elenco. Un elemento ListItem può contenere elementi Equation, Footnote, HorizontalRule, InlineDrawing, InlineImage, PageBreak e Text. Per ulteriori informazioni sulla struttura del documento, consulta la guida all'estensione di Documenti Google.

ListItems non può contenere caratteri di nuova riga. I caratteri di nuova riga ("\n") vengono convertiti in caratteri di interruzione riga ("\r").

ListItems con lo stesso ID elenco appartengono allo stesso elenco e sono numerati di conseguenza. Gli elementi ListItems di un determinato elenco non devono essere adiacenti nella scheda o avere lo stesso elemento principale. Due elementi appartenenti allo stesso elenco possono trovarsi in qualsiasi punto della scheda mantenendo la numerazione consecutiva, come illustrato nell'esempio seguente:

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Append a new list item to the body.
const item1 = body.appendListItem('Item 1');

// Log the new list item's list ID.
Logger.log(item1.getListId());

// Append a table after the list item.
body.appendTable([['Cell 1', 'Cell 2']]);

// Append a second list item with the same list ID. The two items are treated as
// the same list, despite not being consecutive.
const item2 = body.appendListItem('Item 2');
item2.setListId(item1);

Metodi

Metodo	Tipo restituito	Breve descrizione
addPositionedImage(image)	PositionedImage	Crea e inserisce un nuovo PositionedImage dal blob immagine specificato.
appendHorizontalRule()	HorizontalRule	Crea e aggiunge un nuovo HorizontalRule.
appendInlineImage(image)	InlineImage	Crea e aggiunge un nuovo InlineImage dal blob immagine specificato.
appendInlineImage(image)	InlineImage	Aggiunge il InlineImage specificato.
appendPageBreak()	PageBreak	Crea e aggiunge un nuovo PageBreak.
appendPageBreak(pageBreak)	PageBreak	Aggiunge il PageBreak specificato.
appendText(text)	Text	Crea e aggiunge un nuovo elemento Text con i contenuti specificati.
appendText(text)	Text	Collega l'elemento Text specificato.
clear()	ListItem	Cancella i contenuti dell'elemento.
copy()	ListItem	Restituisce una copia approfondita e scollegata dell'elemento corrente.
editAsText()	Text	Consente di ottenere una versione Text dell'elemento corrente da modificare.
findElement(elementType)	RangeElement	Cerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)	RangeElement	Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal RangeElement specificato.
findText(searchPattern)	RangeElement	Cerca, nei contenuti dell'elemento, il pattern di testo specificato utilizzando le espressioni regolari.
findText(searchPattern, from)	RangeElement	Cerca il pattern di testo specificato nei contenuti dell'elemento, a partire da un determinato risultato di ricerca.
getAlignment()	HorizontalAlignment	Recupera il HorizontalAlignment.
getAttributes()	Object	Recupera gli attributi dell'elemento.
getChild(childIndex)	Element	Recupera l'elemento figlio all'indice figlio specificato.
getChildIndex(child)	Integer	Recupera l'indice dell'elemento secondario per l'elemento secondario specificato.
getGlyphType()	GlyphType	Recupera il GlyphType dell'elemento dell'elenco.
getHeading()	ParagraphHeading	Recupera il ParagraphHeading.
getIndentEnd()	Number	Recupera il rientro finale in punti.
getIndentFirstLine()	Number	Recupera il rientro della prima riga, in punti.
getIndentStart()	Number	Recupera l'indentation iniziale.
getLineSpacing()	Number	Recupera l'interlinea in punti.
getLinkUrl()	String	Recupera l'URL del link.
getListId()	String	Recupera l'ID elenco.
getNestingLevel()	Integer	Recupera il livello di nidificazione dell'elemento dell'elenco.
getNextSibling()	Element	Recupera l'elemento successivo associato all'elemento.
getNumChildren()	Integer	Recupera il numero di bambini.
getParent()	ContainerElement	Recupera l'elemento principale dell'elemento.
getPositionedImage(id)	PositionedImage	Recupera un PositionedImage in base all'ID dell'immagine.
getPositionedImages()	PositionedImage[]	Recupera tutti gli oggetti PositionedImage ancorati al paragrafo.
getPreviousSibling()	Element	Recupera l'elemento precedente associato all'elemento.
getSpacingAfter()	Number	Recupera la spaziatura dopo l'elemento, in punti.
getSpacingBefore()	Number	Recupera la spaziatura prima dell'elemento, in punti.
getText()	String	Recupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()	TextAlignment	Restituisce l'allineamento del testo.
getType()	ElementType	Recupera il ElementType dell'elemento.
insertHorizontalRule(childIndex)	HorizontalRule	Crea e inserisce un HorizontalRule nell'indice specificato.
insertInlineImage(childIndex, image)	InlineImage	Crea e inserisce un nuovo InlineImage dal blob immagine specificato nell'indice specificato.
insertInlineImage(childIndex, image)	InlineImage	Inserisce il valore InlineImage specificato nell'indice specificato.
insertPageBreak(childIndex)	PageBreak	Crea e inserisce un nuovo PageBreak nell'indice specificato.
insertPageBreak(childIndex, pageBreak)	PageBreak	Inserisce il valore PageBreak specificato nell'indice specificato.
insertText(childIndex, text)	Text	Crea e inserisce un nuovo elemento di testo nell'indice specificato.
insertText(childIndex, text)	Text	Inserisce l'elemento Text specificato nell'indice specificato, con i contenuti di testo specificati.
isAtDocumentEnd()	Boolean	Determina se l'elemento è alla fine del Document.
isLeftToRight()	Boolean	Recupera l'impostazione da sinistra a destra.
merge()	ListItem	Unisce l'elemento all'elemento precedente dello stesso tipo.
removeChild(child)	ListItem	Rimuove l'elemento figlio specificato.
removeFromParent()	ListItem	Rimuove l'elemento dal relativo elemento principale.
removePositionedImage(id)	Boolean	Rimuove un PositionedImage dall'ID immagine.
replaceText(searchPattern, replacement)	Element	Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa di sostituzione, utilizzando espressioni regolari.
setAlignment(alignment)	ListItem	Imposta HorizontalAlignment.
setAttributes(attributes)	ListItem	Imposta gli attributi dell'elemento.
setGlyphType(glyphType)	ListItem	Imposta GlyphType dell'elemento dell'elenco.
setHeading(heading)	ListItem	Imposta ParagraphHeading.
setIndentEnd(indentEnd)	ListItem	Imposta il rientro finale in punti.
setIndentFirstLine(indentFirstLine)	ListItem	Imposta il rientro della prima riga in punti.
setIndentStart(indentStart)	ListItem	Imposta il rientro iniziale in punti.
setLeftToRight(leftToRight)	ListItem	Imposta l'impostazione da sinistra a destra.
setLineSpacing(multiplier)	ListItem	Imposta lo spazio interlinea, come una quantità che indica il numero di righe da utilizzare per lo spazio.
setLinkUrl(url)	ListItem	Imposta l'URL del link.
setListId(listItem)	ListItem	Imposta l'ID elenco.
setNestingLevel(nestingLevel)	ListItem	Imposta il livello di nidificazione dell'elemento dell'elenco.
setSpacingAfter(spacingAfter)	ListItem	Imposta la spaziatura dopo l'elemento, in punti.
setSpacingBefore(spacingBefore)	ListItem	Imposta la spaziatura prima dell'elemento in punti.
setText(text)	void	Imposta i contenuti dell'elemento dell'elenco come testo.
setTextAlignment(textAlignment)	ListItem	Imposta l'allineamento del testo.

Documentazione dettagliata

addPositionedImage(image)

Crea e inserisce un nuovo PositionedImage dal blob immagine specificato.

Parametri

Nome	Tipo	Descrizione
image	BlobSource	i dati immagine

Invio

PositionedImage: la nuova immagine posizionata

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

---

appendHorizontalRule()

Crea e aggiunge un nuovo HorizontalRule.

Invio

HorizontalRule: il nuovo righello orizzontale

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

---

appendInlineImage(image)

Crea e aggiunge un nuovo InlineImage dal blob immagine specificato.

Parametri

Nome	Tipo	Descrizione
image	BlobSource	i dati immagine

Invio

InlineImage: l'immagine aggiunta

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

---

appendInlineImage(image)

Aggiunge il InlineImage specificato.

Parametri

Nome	Tipo	Descrizione
image	InlineImage	i dati immagine

Invio

InlineImage: l'immagine aggiunta

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

---

appendPageBreak()

Crea e aggiunge un nuovo PageBreak.

Nota: PageBreaks potrebbe non essere contenuto in TableCells. Se l'elemento corrente è contenuto in una cella di tabella, verrà lanciata un'eccezione.

Invio

PageBreak: il nuovo elemento di interruzione di pagina

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

---

appendPageBreak(pageBreak)

Aggiunge il PageBreak specificato.

Nota: PageBreaks potrebbe non essere contenuto in TableCells. Se l'elemento corrente è contenuto in una cella di tabella, verrà lanciata un'eccezione.

Parametri

Nome	Tipo	Descrizione
pageBreak	PageBreak	l'interruzione di pagina da aggiungere

Invio

PageBreak: l'elemento di interruzione di pagina aggiunto

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

---

appendText(text)

Crea e aggiunge un nuovo elemento Text con i contenuti specificati.

Parametri

Nome	Tipo	Descrizione
text	String	i contenuti del testo

Invio

Text: il nuovo elemento di testo

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

---

appendText(text)

Collega l'elemento Text specificato.

Parametri

Nome	Tipo	Descrizione
text	Text	l'elemento di testo da accodare

Invio

Text: l'elemento di testo aggiunto

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

---

clear()

Cancella i contenuti dell'elemento.

Invio

ListItem: l'elemento corrente.

---

copy()

Restituisce una copia approfondita e scollegata dell'elemento corrente.

Vengono copiati anche gli eventuali elementi secondari presenti nell'elemento. Il nuovo elemento non ha un elemento primario.

Invio

ListItem: la nuova copia.

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

---

editAsText()

Consente di ottenere una versione Text dell'elemento corrente da modificare.

Utilizza editAsText per manipolare i contenuti degli elementi come testo avanzato. La modalità editAsText ignora gli elementi non di testo (come InlineImage e HorizontalRule).

Gli elementi secondari completamente contenuti in un intervallo di testo eliminato vengono rimossi dall'elemento.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Insert two paragraphs separated by a paragraph containing an
// horizontal rule.
body.insertParagraph(0, 'An editAsText sample.');
body.insertHorizontalRule(0);
body.insertParagraph(0, 'An example.');

// Delete " sample.\n\n An" removing the horizontal rule in the process.
body.editAsText().deleteText(14, 25);

Invio

Text: una versione di testo dell'elemento corrente

---

findElement(elementType)

Cerca nei contenuti dell'elemento un discendente del tipo specificato.

Parametri

Nome	Tipo	Descrizione
elementType	ElementType	Il tipo di elemento da cercare.

Invio

RangeElement: un risultato di ricerca che indica la posizione dell'elemento di ricerca.

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

---

findElement(elementType, from)

Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal RangeElement specificato.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Define the search parameters.

let searchResult = null;

// Search until the paragraph is found.
while (
    (searchResult = body.findElement(
         DocumentApp.ElementType.PARAGRAPH,
         searchResult,
         ))) {
  const par = searchResult.getElement().asParagraph();
  if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    break;
  }
}

Parametri

Nome	Tipo	Descrizione
elementType	ElementType	Il tipo di elemento da cercare.
from	RangeElement	Il risultato di ricerca da cui effettuare la ricerca.

Invio

RangeElement: un risultato di ricerca che indica la posizione successiva dell'elemento di ricerca.

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

---

findText(searchPattern)

Cerca, nei contenuti dell'elemento, il pattern di testo specificato utilizzando le espressioni regolari.

Un sottoinsieme delle funzionalità delle espressioni regolari di JavaScript non è completamente supportato, ad esempio i gruppi di cattura e i modificatori di modalità.

Il pattern di espressione regolare fornito viene abbinato in modo indipendente a ogni blocco di testo contenuto nell'elemento corrente.

Parametri

Nome	Tipo	Descrizione
searchPattern	String	lo schema da cercare

Invio

RangeElement: un risultato di ricerca che indica la posizione del testo di ricerca oppure null se non esiste alcuna corrispondenza

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

---

findText(searchPattern, from)

Cerca il pattern di testo specificato nei contenuti dell'elemento, a partire da un determinato risultato di ricerca.

Un sottoinsieme delle funzionalità delle espressioni regolari di JavaScript non è completamente supportato, ad esempio i gruppi di cattura e i modificatori di modalità.

Il pattern di espressione regolare fornito viene abbinato in modo indipendente a ogni blocco di testo contenuto nell'elemento corrente.

Parametri

Nome	Tipo	Descrizione
searchPattern	String	lo schema da cercare
from	RangeElement	il risultato di ricerca da cui effettuare la ricerca

Invio

RangeElement: un risultato di ricerca che indica la posizione successiva del testo di ricerca oppure null se non esiste alcuna corrispondenza

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

---

getAlignment()

Recupera il HorizontalAlignment.

Invio

HorizontalAlignment: l'allineamento

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

---

getAttributes()

Recupera gli attributi dell'elemento.

Il risultato è un oggetto contenente una proprietà per ogni attributo elemento valido, in cui ogni nome della proprietà corrisponde a un elemento dell'enumerazione DocumentApp.Attribute.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Append a styled paragraph.
const par = body.appendParagraph('A bold, italicized paragraph.');
par.setBold(true);
par.setItalic(true);

// Retrieve the paragraph's attributes.
const atts = par.getAttributes();

// Log the paragraph attributes.
for (const att in atts) {
  Logger.log(`${att}:${atts[att]}`);
}

Invio

Object: gli attributi dell'elemento.

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

---

getChild(childIndex)

Recupera l'elemento figlio all'indice figlio specificato.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Obtain the first element in the tab.
const firstChild = body.getChild(0);

// If it's a paragraph, set its contents.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  firstChild.asParagraph().setText('This is the first paragraph.');
}

Parametri

Nome	Tipo	Descrizione
childIndex	Integer	L'indice dell'elemento secondario da recuperare.

Invio

Element: l'elemento secondario nell'indice specificato.

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

---

getChildIndex(child)

Recupera l'indice dell'elemento secondario per l'elemento secondario specificato.

Parametri

Nome	Tipo	Descrizione
child	Element	L'elemento secondario per cui recuperare l'indice.

Invio

Integer: l'indice secondario.

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

---

getGlyphType()

Recupera il GlyphType dell'elemento dell'elenco.

Invio

GlyphType: il tipo di glifo

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

---

getHeading()

Recupera il ParagraphHeading.

Invio

ParagraphHeading: l'intestazione

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

---

getIndentEnd()

Recupera il rientro finale in punti.

Invio

Number: il rientro finale in punti

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

---

getIndentFirstLine()

Recupera il rientro della prima riga, in punti.

Invio

Number: il rientro della prima riga, in punti

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

---

getIndentStart()

Recupera l'indentation iniziale.

Invio

Number: il rientro iniziale

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

---

getLineSpacing()

Recupera l'interlinea in punti.

Invio

Number: l'interlinea in punti

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

---

getLinkUrl()

Recupera l'URL del link.

Invio

String: l'URL del link o null se l'elemento contiene più valori per questo attributo

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

---

getListId()

Recupera l'ID elenco.

Invio

String: l'ID elenco.

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

---

getNestingLevel()

Recupera il livello di nidificazione dell'elemento dell'elenco.

Per impostazione predefinita, gli elementi dell'elenco hanno un livello di nidificazione pari a zero. Il livello di nidificazione determina il carattere utilizzato dall'elemento dell'elenco.

Invio

Integer: il livello di annidamento

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

---

getNextSibling()

Recupera l'elemento successivo associato all'elemento.

L'elemento successivo ha lo stesso elemento principale e segue l'elemento corrente.

Invio

Element: l'elemento successivo associato.

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

---

getNumChildren()

Recupera il numero di bambini.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Log the number of elements in the tab.
Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);

Invio

Integer: il numero di bambini.

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

---

getParent()

Recupera l'elemento principale dell'elemento.

L'elemento principale contiene l'elemento corrente.

Invio

ContainerElement: l'elemento principale.

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

---

getPositionedImage(id)

Recupera un PositionedImage in base all'ID dell'immagine.

Parametri

Nome	Tipo	Descrizione
id	String	l'ID immagine

Invio

PositionedImage: l'immagine posizionata

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

---

getPositionedImages()

Recupera tutti gli oggetti PositionedImage ancorati al paragrafo.

Invio

PositionedImage[]: un elenco di immagini posizionate

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

---

getPreviousSibling()

Recupera l'elemento precedente associato all'elemento.

L'elemento precedente associato ha lo stesso elemento principale e precede l'elemento corrente.

Invio

Element: l'elemento precedente associato.

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

---

getSpacingAfter()

Recupera la spaziatura dopo l'elemento, in punti.

Invio

Number: la spaziatura dopo l'elemento, in punti

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

---

getSpacingBefore()

Recupera la spaziatura prima dell'elemento, in punti.

Invio

Number: la spaziatura prima dell'elemento, in punti

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

---

getText()

Recupera i contenuti dell'elemento come stringa di testo.

Invio

String: i contenuti dell'elemento come stringa di testo

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

---

getTextAlignment()

Restituisce l'allineamento del testo. I tipi di allineamento disponibili sono DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT e DocumentApp.TextAlignment.SUPERSCRIPT.

Invio

TextAlignment: il tipo di allineamento del testo oppure null se il testo contiene più tipi di allineamento del testo o se l'allineamento del testo non è mai stato impostato

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

---

getType()

Recupera il ElementType dell'elemento.

Utilizza getType() per determinare il tipo esatto di un determinato elemento.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Obtain the first element in the active tab's body.

const firstChild = body.getChild(0);

// Use getType() to determine the element's type.
if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) {
  Logger.log('The first element is a paragraph.');
} else {
  Logger.log('The first element is not a paragraph.');
}

Invio

ElementType: il tipo di elemento.

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

---

insertHorizontalRule(childIndex)

Crea e inserisce un HorizontalRule nell'indice specificato.

Parametri

Nome	Tipo	Descrizione
childIndex	Integer	l'indice in cui inserire l'elemento

Invio

HorizontalRule: il nuovo elemento righello orizzontale

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

---

insertInlineImage(childIndex, image)

Crea e inserisce un nuovo InlineImage dal blob immagine specificato nell'indice specificato.

Parametri

Nome	Tipo	Descrizione
childIndex	Integer	l'indice in cui inserire l'elemento
image	BlobSource	i dati immagine

Invio

InlineImage: l'elemento immagine in linea inserito

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

---

insertInlineImage(childIndex, image)

Inserisce il valore InlineImage specificato nell'indice specificato.

Parametri

Nome	Tipo	Descrizione
childIndex	Integer	l'indice in cui inserire l'elemento
image	InlineImage	i dati immagine

Invio

InlineImage: l'elemento immagine in linea inserito

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

---

insertPageBreak(childIndex)

Crea e inserisce un nuovo PageBreak nell'indice specificato.

Nota: PageBreaks potrebbe non essere contenuto in TableCells. Se l'elemento corrente è contenuto in una cella di tabella, verrà lanciata un'eccezione.

Parametri

Nome	Tipo	Descrizione
childIndex	Integer	l'indice in cui inserire l'elemento

Invio

PageBreak: il nuovo elemento di interruzione di pagina

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

---

insertPageBreak(childIndex, pageBreak)

Inserisce il valore PageBreak specificato nell'indice specificato.

Nota: PageBreaks potrebbe non essere contenuto in TableCells. Se l'elemento corrente è contenuto in una cella di tabella, verrà lanciata un'eccezione.

Parametri

Nome	Tipo	Descrizione
childIndex	Integer	l'indice in cui inserire l'elemento
pageBreak	PageBreak	l'interruzione di pagina da inserire

Invio

PageBreak: l'elemento di interruzione di pagina inserito

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

---

insertText(childIndex, text)

Crea e inserisce un nuovo elemento di testo nell'indice specificato.

Parametri

Nome	Tipo	Descrizione
childIndex	Integer	l'indice in cui inserire l'elemento
text	String	i contenuti del testo

Invio

Text: il nuovo elemento di testo

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

---

insertText(childIndex, text)

Inserisce l'elemento Text specificato nell'indice specificato, con i contenuti di testo specificati.

Parametri

Nome	Tipo	Descrizione
childIndex	Integer	l'indice in cui inserire l'elemento
text	Text	l'elemento di testo da inserire

Invio

Text: l'elemento di testo inserito

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

---

isAtDocumentEnd()

Determina se l'elemento è alla fine del Document.

Invio

Boolean: indica se l'elemento si trova alla fine della scheda.

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

---

isLeftToRight()

Recupera l'impostazione da sinistra a destra.

Invio

Boolean: l'impostazione da sinistra a destra

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

---

merge()

Unisce l'elemento all'elemento precedente dello stesso tipo.

È possibile unire solo elementi dello stesso ElementType. Tutti gli elementi secondari contenuti nell'elemento corrente vengono spostati nell'elemento precedente associato.

L'elemento corrente viene rimosso dal documento.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
const par1 = body.appendParagraph('Paragraph 1.');
const par2 = body.appendParagraph('Paragraph 2.');
// Merge the newly added paragraphs into a single paragraph.
par2.merge();

// Example 2: Merge table cells
// Create a two-dimensional array containing the table's cell contents.
const cells = [
  ['Row 1, Cell 1', 'Row 1, Cell 2'],
  ['Row 2, Cell 1', 'Row 2, Cell 2'],
];
// Build a table from the array.
const table = body.appendTable(cells);
// Get the first row in the table.
const row = table.getRow(0);
// Get the two cells in this row.
const cell1 = row.getCell(0);
const cell2 = row.getCell(1);
// Merge the current cell into its preceding sibling element.
const merged = cell2.merge();

Invio

ListItem: l'elemento unito.

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

---

removeChild(child)

Rimuove l'elemento figlio specificato.

Parametri

Nome	Tipo	Descrizione
child	Element	l'elemento secondario da rimuovere

Invio

ListItem: l'elemento corrente

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

---

removeFromParent()

Rimuove l'elemento dal relativo elemento principale.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Remove all images in the active tab's body.
const imgs = body.getImages();
for (let i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Invio

ListItem: l'elemento rimosso.

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

---

removePositionedImage(id)

Rimuove un PositionedImage dall'ID immagine.

Parametri

Nome	Tipo	Descrizione
id	String

Invio

Boolean: indica se l'immagine specificata è stata rimossa o meno

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

---

replaceText(searchPattern, replacement)

Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa di sostituzione, utilizzando espressioni regolari.

Il pattern di ricerca viene passato come stringa, non come oggetto espressione regolare JavaScript. Per questo motivo, dovrai eseguire l'escape di eventuali barre rovesciate nello schema.

Questi metodi utilizzano la libreria di espressioni regolari RE2 di Google, che limita la sintassi supportata.

Il pattern di espressione regolare fornito viene abbinato in modo indipendente a ogni blocco di testo contenuto nell'elemento corrente.

const body =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody();

// Clear the text surrounding "Apps Script", with or without text.
body.replaceText('^.*Apps ?Script.*$', 'Apps Script');

Parametri

Nome	Tipo	Descrizione
searchPattern	String	lo schema regex da cercare
replacement	String	Il testo da utilizzare come sostituto

Invio

Element: l'elemento corrente

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

---

setAlignment(alignment)

Imposta HorizontalAlignment.

Parametri

Nome	Tipo	Descrizione
alignment	HorizontalAlignment	l'allineamento orizzontale

Invio

ListItem: l'elemento corrente

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

---

setAttributes(attributes)

Imposta gli attributi dell'elemento.

Il parametro degli attributi specificato deve essere un oggetto in cui ogni nome della proprietà è un elemento dell'enumerazione DocumentApp.Attribute e ogni valore della proprietà è il nuovo valore da applicare.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();
const body = documentTab.getBody();

// Define a custom paragraph style.
const style = {};
style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] =
    DocumentApp.HorizontalAlignment.RIGHT;
style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri';
style[DocumentApp.Attribute.FONT_SIZE] = 18;
style[DocumentApp.Attribute.BOLD] = true;

// Append a plain paragraph.
const par = body.appendParagraph('A paragraph with custom style.');

// Apply the custom style.
par.setAttributes(style);

Parametri

Nome	Tipo	Descrizione
attributes	Object	Gli attributi dell'elemento.

Invio

ListItem: l'elemento corrente.

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

---

setGlyphType(glyphType)

Imposta GlyphType dell'elemento dell'elenco.

Parametri

Nome	Tipo	Descrizione
glyphType	GlyphType	il tipo di glifo

Invio

ListItem: l'elemento corrente

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

---

setHeading(heading)

Imposta ParagraphHeading.

Parametri

Nome	Tipo	Descrizione
heading	ParagraphHeading	l'intestazione

Invio

ListItem: l'elemento corrente

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

---

setIndentEnd(indentEnd)

Imposta il rientro finale in punti.

Parametri

Nome	Tipo	Descrizione
indentEnd	Number	il rientro finale, in punti

Invio

ListItem: l'elemento corrente

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

---

setIndentFirstLine(indentFirstLine)

Imposta il rientro della prima riga in punti.

Parametri

Nome	Tipo	Descrizione
indentFirstLine	Number	il rientro della prima riga, in punti

Invio

ListItem: l'elemento corrente

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

---

setIndentStart(indentStart)

Imposta il rientro iniziale in punti.

Parametri

Nome	Tipo	Descrizione
indentStart	Number	il rientro iniziale, in punti

Invio

ListItem: l'elemento corrente

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

---

setLeftToRight(leftToRight)

Imposta l'impostazione da sinistra a destra.

Parametri

Nome	Tipo	Descrizione
leftToRight	Boolean	l'impostazione da sinistra a destra

Invio

ListItem: l'elemento corrente

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

---

setLineSpacing(multiplier)

Imposta lo spazio interlinea, come una quantità che indica il numero di righe da utilizzare per lo spazio.

Parametri

Nome	Tipo	Descrizione
multiplier	Number	il numero di righe

Invio

ListItem: l'elemento corrente

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

---

setLinkUrl(url)

Imposta l'URL del link.

Parametri

Nome	Tipo	Descrizione
url	String	l'URL del link

Invio

ListItem: l'elemento corrente

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

---

setListId(listItem)

Imposta l'ID elenco.

L'ID elenco è impostato sullo stesso valore per ListItem specificato. I due ListItems verranno considerati membri dello stesso elenco.

Parametri

Nome	Tipo	Descrizione
listItem	ListItem	L'elemento dell'elenco di cui utilizzare l'ID elenco

Invio

ListItem: l'elemento corrente

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

---

setNestingLevel(nestingLevel)

Imposta il livello di nidificazione dell'elemento dell'elenco.

Per impostazione predefinita, gli elementi dell'elenco hanno un livello di nidificazione pari a zero. Il livello di nidificazione determina il carattere utilizzato dall'elemento dell'elenco.

Parametri

Nome	Tipo	Descrizione
nestingLevel	Integer	il livello di nidificazione

Invio

ListItem: l'elemento corrente

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

---

setSpacingAfter(spacingAfter)

Imposta la spaziatura dopo l'elemento, in punti.

Parametri

Nome	Tipo	Descrizione
spacingAfter	Number	la spaziatura dopo l'elemento, in punti

Invio

ListItem: l'elemento corrente

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

---

setSpacingBefore(spacingBefore)

Imposta la spaziatura prima dell'elemento in punti.

Parametri

Nome	Tipo	Descrizione
spacingBefore	Number	la spaziatura prima dell'elemento, in punti

Invio

ListItem: l'elemento corrente

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

---

setText(text)

Imposta i contenuti dell'elemento dell'elenco come testo.

Nota: i contenuti esistenti vengono cancellati.

Parametri

Nome	Tipo	Descrizione
text	String	i nuovi contenuti del testo

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

---

setTextAlignment(textAlignment)

Imposta l'allineamento del testo. I tipi di allineamento disponibili sono DocumentApp.TextAlignment.NORMAL, DocumentApp.TextAlignment.SUBSCRIPT e DocumentApp.TextAlignment.SUPERSCRIPT.

// Make the entire first paragraph in the active tab be superscript.
const documentTab =
    DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
const text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parametri

Nome	Tipo	Descrizione
textAlignment	TextAlignment	il tipo di allineamento del testo da applicare

Invio

ListItem: l'elemento corrente

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