Questa pagina è stata tradotta dall'API Cloud Translation.

Class HeaderSection

Un elemento che rappresenta una sezione di intestazione. In genere, un Document contiene al massimo un HeaderSection. HeaderSection può contenere elementi ListItem, Paragraph e Table. Per ulteriori informazioni sulla struttura dei documenti, consulta la guida all'estensione di Documenti Google.

Metodi

Metodo	Tipo restituito	Breve descrizione
`appendHorizontalRule()`	`HorizontalRule`	Crea e aggiunge un nuovo `HorizontalRule`.
`appendImage(image)`	`InlineImage`	Crea e aggiunge un nuovo `InlineImage` dal blob di immagine specificato.
`appendImage(image)`	`InlineImage`	Accoda il valore `InlineImage` specificato.
`appendListItem(listItem)`	`ListItem`	Accoda il valore `ListItem` specificato.
`appendListItem(text)`	`ListItem`	Crea e aggiunge un nuovo `ListItem` con i contenuti di testo specificati.
`appendParagraph(paragraph)`	`Paragraph`	Accoda il valore `Paragraph` specificato.
`appendParagraph(text)`	`Paragraph`	Crea e aggiunge un nuovo `Paragraph` con i contenuti di testo specificati.
`appendTable()`	`Table`	Crea e aggiunge un nuovo `Table`.
`appendTable(cells)`	`Table`	Accoda un nuovo `Table` contenente un `TableCell` per ogni valore di stringa specificato.
`appendTable(table)`	`Table`	Accoda il valore `Table` specificato.
`clear()`	`HeaderSection`	Consente di cancellare i contenuti dell'elemento.
`copy()`	`HeaderSection`	Restituisce una copia separata e approfondita dell'elemento corrente.
`editAsText()`	`Text`	Consente di ottenere una versione `Text` dell'elemento corrente, per la modifica.
`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 valore `RangeElement` specificato.
`findText(searchPattern)`	`RangeElement`	Cerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
`findText(searchPattern, from)`	`RangeElement`	Cerca nei contenuti dell'elemento il pattern di testo specificato, a partire da un determinato risultato di ricerca.
`getAttributes()`	`Object`	Recupera gli attributi dell'elemento.
`getChild(childIndex)`	`Element`	Recupera l'elemento secondario nell'indice figlio specificato.
`getChildIndex(child)`	`Integer`	Recupera l'indice figlio per l'elemento secondario specificato.
`getImages()`	`InlineImage[]`	Recupera tutti i valori `InlineImages` contenuti nella sezione.
`getListItems()`	`ListItem[]`	Recupera tutti i valori `ListItems` contenuti nella sezione.
`getNumChildren()`	`Integer`	Recupera il numero di bambini.
`getParagraphs()`	`Paragraph[]`	Recupera tutti i `Paragraphs` contenuti nella sezione (incluso `ListItems`).
`getParent()`	`ContainerElement`	Recupera l'elemento principale dell'elemento.
`getTables()`	`Table[]`	Recupera tutti i valori `Tables` contenuti nella sezione.
`getText()`	`String`	Recupera i contenuti dell'elemento come stringa di testo.
`getTextAlignment()`	`TextAlignment`	Consente di acquisire l'allineamento del testo.
`getType()`	`ElementType`	Recupera l'elemento `ElementType` dell'elemento.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	Crea e inserisce un nuovo valore `HorizontalRule` nell'indice specificato.
`insertImage(childIndex, image)`	`InlineImage`	Crea e inserisce un `InlineImage` dal blob di immagine specificato, nell'indice specificato.
`insertImage(childIndex, image)`	`InlineImage`	Inserisce il valore `InlineImage` specificato nell'indice specificato.
`insertListItem(childIndex, listItem)`	`ListItem`	Inserisce il valore `ListItem` specificato nell'indice specificato.
`insertListItem(childIndex, text)`	`ListItem`	Crea e inserisce un nuovo valore `ListItem` nell'indice specificato, contenente i contenuti di testo specificati.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	Inserisce il valore `Paragraph` specificato nell'indice specificato.
`insertParagraph(childIndex, text)`	`Paragraph`	Crea e inserisce un nuovo valore `Paragraph` nell'indice specificato, contenente i contenuti di testo specificati.
`insertTable(childIndex)`	`Table`	Crea e inserisce un nuovo valore `Table` nell'indice specificato.
`insertTable(childIndex, cells)`	`Table`	Crea e inserisce un nuovo `Table` contenente le celle specificate, nell'indice specificato.
`insertTable(childIndex, table)`	`Table`	Inserisce il valore `Table` specificato nell'indice specificato.
`removeChild(child)`	`HeaderSection`	Rimuove l'elemento secondario specificato.
`removeFromParent()`	`HeaderSection`	Rimuove l'elemento dal relativo elemento principale.
`replaceText(searchPattern, replacement)`	`Element`	Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando le espressioni regolari.
`setAttributes(attributes)`	`HeaderSection`	Imposta gli attributi dell'elemento.
`setText(text)`	`HeaderSection`	Imposta i contenuti come testo normale.
`setTextAlignment(textAlignment)`	`HeaderSection`	Imposta l'allineamento del testo.

Metodi deprecati

Metodo	Tipo restituito	Breve descrizione
`getFootnotes()`	`Footnote[]`	Recupera tutti i valori `Footnotes` contenuti nella sezione.
`getLinkUrl()`	`String`	Recupera l'URL del link.
`getNextSibling()`	`Element`	Recupera l'elemento di pari livello successivo dell'elemento.
`getPreviousSibling()`	`Element`	Recupera l'elemento di pari livello precedente dell'elemento.
`isAtDocumentEnd()`	`Boolean`	Determina se l'elemento si trova alla fine di `Document`.
`setLinkUrl(url)`	`HeaderSection`	Imposta l'URL del link.

Documentazione dettagliata

`appendHorizontalRule()`

Crea e aggiunge un nuovo HorizontalRule.

Il HorizontalRule verrà contenuto in un nuovo Paragraph.

Ritorni

HorizontalRule: la nuova riga 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

`appendImage(image)`

Crea e aggiunge un nuovo InlineImage dal blob di immagine specificato.

L'immagine verrà contenuta in un nuovo file Paragraph.

Parametri

Nome	Tipo	Descrizione
`image`	`BlobSource`	i dati dell'immagine

Ritorni

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

`appendImage(image)`

Accoda il valore InlineImage specificato.

Il InlineImage verrà contenuto in un nuovo Paragraph.

Usa questa versione di appendImage per aggiungere una copia di un InlineImage esistente.

Parametri

Nome	Tipo	Descrizione
`image`	`InlineImage`	i dati dell'immagine

Ritorni

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

`appendListItem(listItem)`

Accoda il valore ListItem specificato.

Usa questa versione di appendListItem per aggiungere una copia di un ListItem esistente.

Parametri

Nome	Tipo	Descrizione
`listItem`	`ListItem`	l'elemento dell'elenco da aggiungere

Ritorni

ListItem: la voce dell'elenco 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

`appendListItem(text)`

Crea e aggiunge un nuovo ListItem con i contenuti di testo specificati.

Le voci consecutive di un elenco vengono aggiunte come parte dello stesso elenco.

Parametri

Nome	Tipo	Descrizione
`text`	`String`	i contenuti testuali dell'elemento dell'elenco

Ritorni

ListItem: la nuova voce dell'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

`appendParagraph(paragraph)`

Accoda il valore Paragraph specificato.

Usa questa versione di appendParagraph per aggiungere una copia di un Paragraph esistente.

Parametri

Nome	Tipo	Descrizione
`paragraph`	`Paragraph`	il paragrafo da aggiungere

Ritorni

Paragraph: paragrafo 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

`appendParagraph(text)`

Crea e aggiunge un nuovo Paragraph con i contenuti di testo specificati.

Parametri

Nome	Tipo	Descrizione
`text`	`String`	i contenuti testuali del paragrafo

Ritorni

Paragraph: il nuovo paragrafo

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

`appendTable()`

Crea e aggiunge un nuovo Table.

Questo metodo aggiungerà anche un paragrafo vuoto dopo la tabella, poiché i documenti di Documenti Google non possono terminare con una tabella.

Ritorni

Table: la nuova tabella

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

`appendTable(cells)`

Accoda un nuovo Table contenente un TableCell per ogni valore di stringa specificato.

Questo metodo aggiungerà anche un paragrafo vuoto dopo la tabella, poiché i documenti di Documenti Google non possono terminare con una tabella.

Parametri

Nome	Tipo	Descrizione
`cells`	`String[][]`	i contenuti testuali delle celle della tabella da aggiungere alla nuova tabella

Ritorni

Table: tabella 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

`appendTable(table)`

Accoda il valore Table specificato.

Usa questa versione di appendTable per aggiungere una copia di un Table esistente. Questo metodo aggiungerà anche un paragrafo vuoto dopo la tabella, poiché i documenti di Documenti Google non possono terminare con una tabella.

Parametri

Nome	Tipo	Descrizione
`table`	`Table`	la tabella da aggiungere

Ritorni

Table: tabella 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

`clear()`

Consente di cancellare i contenuti dell'elemento.

Ritorni

HeaderSection: l'elemento corrente

`copy()`

Restituisce una copia separata e approfondita dell'elemento corrente.

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

Ritorni

HeaderSection: 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, per la modifica.

Utilizza editAsText per manipolare i contenuti degli elementi in formato RTF. La modalità editAsText ignora gli elementi non testuali (come InlineImage e HorizontalRule).

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

var body = DocumentApp.getActiveDocument().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);

Ritorni

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

Ritorni

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 valore RangeElement specificato.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Define the search parameters.
var searchType = DocumentApp.ElementType.PARAGRAPH;
var searchHeading = DocumentApp.ParagraphHeading.HEADING1;
var searchResult = null;

// Search until the paragraph is found.
while (searchResult = body.findElement(searchType, searchResult)) {
  var par = searchResult.getElement().asParagraph();
  if (par.getHeading() == searchHeading) {
    // Found one, update and stop.
    par.setText('This is the first header.');
    return;
  }
}

Parametri

Nome	Tipo	Descrizione
`elementType`	`ElementType`	il tipo di elemento da cercare
`from`	`RangeElement`	il risultato di ricerca da cui eseguire la ricerca

Ritorni

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 espressioni regolari.

Un sottoinsieme delle funzionalità di espressione regolare JavaScript non è completamente supportato, ad esempio gruppi di acquisizione e modificatori di modalità.

Il modello di espressione regolare fornito viene confrontato in modo indipendente con ciascun blocco di testo contenuto nell'elemento corrente.

Parametri

Nome	Tipo	Descrizione
`searchPattern`	`String`	lo schema da cercare

Ritorni

RangeElement: un risultato di ricerca che indica la posizione del testo di ricerca o un valore nullo in assenza di 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 nei contenuti dell'elemento il pattern di testo specificato, a partire da un determinato risultato di ricerca.

Un sottoinsieme delle funzionalità di espressione regolare JavaScript non è completamente supportato, ad esempio gruppi di acquisizione e modificatori di modalità.

Il modello di espressione regolare fornito viene confrontato in modo indipendente con ciascun 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 eseguire la ricerca

Ritorni

RangeElement: un risultato di ricerca che indica la posizione successiva del testo di ricerca o un valore nullo in assenza di 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

`getAttributes()`

Recupera gli attributi dell'elemento.

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

var body = DocumentApp.getActiveDocument().getBody();

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

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

// Log the paragraph attributes.
for (var att in atts) {
  Logger.log(att + ":" + atts[att]);
}

Ritorni

Object: 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 secondario nell'indice figlio specificato.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document.
var 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 figlio da recuperare

Ritorni

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 figlio per l'elemento secondario specificato.

Parametri

Nome	Tipo	Descrizione
`child`	`Element`	l'elemento figlio per il quale recuperare l'indice

Ritorni

Integer: l'indice figlio

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

`getImages()`

Recupera tutti i valori InlineImages contenuti nella sezione.

Ritorni

InlineImage[]: le immagini della sezione

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

`getListItems()`

Recupera tutti i valori ListItems contenuti nella sezione.

Ritorni

ListItem[]: le voci dell'elenco delle sezioni

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.

// Get the body section of the active document.
var body = DocumentApp.getActiveDocument().getBody();

// Log the number of elements in the document.
Logger.log("There are " + body.getNumChildren() +
    " elements in the document body.");

Ritorni

Integer: il numero di figli

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

`getParagraphs()`

Recupera tutti i Paragraphs contenuti nella sezione (incluso ListItems).

Ritorni

Paragraph[]: i paragrafi della sezione

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.

Ritorni

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

`getTables()`

Recupera tutti i valori Tables contenuti nella sezione.

Ritorni

Table[]: le tabelle delle sezioni

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.

Ritorni

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()`

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

Ritorni

TextAlignment: il tipo di allineamento del testo oppure null se il testo contiene più tipi di allineamenti 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 l'elemento ElementType dell'elemento.

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

var body = DocumentApp.getActiveDocument().getBody();

// Obtain the first element in the document body.

var 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.');
}

Ritorni

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 nuovo valore HorizontalRule nell'indice specificato.

Il HorizontalRule verrà contenuto in un nuovo Paragraph.

Parametri

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

Ritorni

HorizontalRule: la nuova riga 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

`insertImage(childIndex, image)`

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

Parametri

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

Ritorni

InlineImage: l'immagine in linea inserita

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

`insertImage(childIndex, image)`

Inserisce il valore InlineImage specificato nell'indice specificato.

L'immagine verrà contenuta in un nuovo file Paragraph.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	l'indice in cui inserire l'elemento
`image`	`InlineImage`	l'immagine da inserire

Ritorni

InlineImage: l'immagine in linea inserita

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

`insertListItem(childIndex, listItem)`

Inserisce il valore ListItem specificato nell'indice specificato.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	l'indice in cui inserire
`listItem`	`ListItem`	l'elemento dell'elenco da inserire

Ritorni

ListItem: la voce dell'elenco inserita

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

`insertListItem(childIndex, text)`

Crea e inserisce un nuovo valore ListItem nell'indice specificato, contenente i contenuti di testo specificati.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	l'indice in cui inserire
`text`	`String`	i contenuti testuali dell'elemento dell'elenco

Ritorni

ListItem: la nuova voce dell'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

`insertParagraph(childIndex, paragraph)`

Inserisce il valore Paragraph specificato nell'indice specificato.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	l'indice in cui inserire
`paragraph`	`Paragraph`	il paragrafo da inserire

Ritorni

Paragraph: il paragrafo 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

`insertParagraph(childIndex, text)`

Crea e inserisce un nuovo valore Paragraph nell'indice specificato, contenente i contenuti di testo specificati.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	l'indice in cui inserire
`text`	`String`	i contenuti testuali del paragrafo

Ritorni

Paragraph: il nuovo paragrafo

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

`insertTable(childIndex)`

Crea e inserisce un nuovo valore Table nell'indice specificato.

Parametri

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

Ritorni

Table: la nuova tabella

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

`insertTable(childIndex, cells)`

Crea e inserisce un nuovo Table contenente le celle specificate, nell'indice specificato.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	l'indice in cui inserire
`cells`	`String[][]`	i contenuti testuali delle celle della tabella da aggiungere alla nuova tabella

Ritorni

Table: la nuova tabella

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

`insertTable(childIndex, table)`

Inserisce il valore Table specificato nell'indice specificato.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	l'indice in cui inserire
`table`	`Table`	la tabella da inserire

Ritorni

Table: la tabella inserita

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 secondario specificato.

Parametri

Nome	Tipo	Descrizione
`child`	`Element`	l'elemento secondario da rimuovere

Ritorni

HeaderSection: 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.

var body = DocumentApp.getActiveDocument().getBody();

// Remove all images in the document body.
var imgs = body.getImages();
for (var i = 0; i < imgs.length; i++) {
  imgs[i].removeFromParent();
}

Ritorni

HeaderSection: 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

`replaceText(searchPattern, replacement)`

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

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

Questo metodo utilizza la libreria di espressioni regolari RE2 di Google, che limita la sintassi supportata.

Il modello di espressione regolare fornito viene confrontato in modo indipendente con ciascun blocco di testo contenuto nell'elemento corrente.

var body = DocumentApp.getActiveDocument().getBody();

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

Parametri

Nome	Tipo	Descrizione
`searchPattern`	`String`	il pattern regex per cercare
`replacement`	`String`	il testo da utilizzare come sostituzione

Ritorni

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

`setAttributes(attributes)`

Imposta gli attributi dell'elemento.

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

var body = DocumentApp.getActiveDocument().getBody();

// Define a custom paragraph style.
var 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.
var 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.

Ritorni

HeaderSection: 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 come testo normale.

Nota: i contenuti esistenti vengono cancellati.

Parametri

Nome	Tipo	Descrizione
`text`	`String`	i nuovi contenuti testuali

Ritorni

HeaderSection: 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

`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 be superscript.
var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parametri

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

Ritorni

HeaderSection: 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

Metodi deprecati

`getFootnotes()`

Obsoleta. Questo elemento non può contenere un elemento Footnote.

Recupera tutti i valori Footnotes contenuti nella sezione.

Ritorni

Footnote[]: le note a piè di pagina della sezione

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()`

Obsoleta. Anziché applicare un link a un'intera sezione, applicalo a un elemento all'interno della sezione.

Recupera l'URL del link.

Ritorni

String: URL del link oppure 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

`getNextSibling()`

Obsoleta. Questo elemento non ha elementi di pari livello.

Recupera l'elemento di pari livello successivo dell'elemento.

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

Ritorni

Element: l'elemento di pari livello successivo.

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()`

Obsoleta. Questo elemento non ha elementi di pari livello.

Recupera l'elemento di pari livello precedente dell'elemento.

L'elemento di pari livello precedente ha lo stesso elemento principale e precede l'elemento corrente.

Ritorni

Element: l'elemento di pari livello precedente.

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()`

Obsoleta. Questo metodo non è affidabile per HeaderSection.

Determina se l'elemento si trova alla fine di Document.

Ritorni

Boolean: indica se l'elemento si trova alla fine del 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

`setLinkUrl(url)`

Obsoleta. Anziché applicare un link a un'intera sezione, applicalo a un elemento all'interno della sezione.

Imposta l'URL del link.

Parametri

Nome	Tipo	Descrizione
`url`	`String`	URL del link

Ritorni

HeaderSection: 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