Questa pagina è stata tradotta dall'API Cloud Translation.

Class Body

I contenuti di una scheda in un documento Google. L'elemento Body può contenere gli elementi ListItem, Paragraph, Table e TableOfContents. Per saperne di più sulla struttura dei documenti, consulta la guida all'estensione di Google Docs.

L'elemento Body in genere contiene tutti i contenuti della scheda, ad eccezione degli elementi HeaderSection, FooterSection e FootnoteSection.

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

// Append a paragraph and a page break to the tab's body section directly.
body.appendParagraph('A paragraph.');
body.appendPageBreak();

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 dell'immagine specificato.
`appendImage(image)`	`InlineImage`	Aggiunge l'elemento `InlineImage` specificato.
`appendListItem(listItem)`	`ListItem`	Aggiunge l'elemento `ListItem` specificato.
`appendListItem(text)`	`ListItem`	Crea e aggiunge un nuovo `ListItem` contenente i contenuti di testo specificati.
`appendPageBreak()`	`PageBreak`	Crea e aggiunge un nuovo `PageBreak`.
`appendPageBreak(pageBreak)`	`PageBreak`	Aggiunge l'elemento `PageBreak` specificato.
`appendParagraph(paragraph)`	`Paragraph`	Aggiunge l'elemento `Paragraph` specificato.
`appendParagraph(text)`	`Paragraph`	Crea e aggiunge un nuovo `Paragraph` contenente i contenuti di testo specificati.
`appendTable()`	`Table`	Crea e aggiunge un nuovo `Table`.
`appendTable(cells)`	`Table`	Aggiunge un nuovo `Table` contenente un `TableCell` per ogni valore stringa specificato.
`appendTable(table)`	`Table`	Aggiunge l'elemento `Table` specificato.
`clear()`	`Body`	Cancella i contenuti dell'elemento.
`copy()`	`Body`	Restituisce una copia indipendente e completa dell'elemento corrente.
`editAsText()`	`Text`	Ottiene una versione `Text` dell'elemento corrente per la modifica.
`findElement(elementType)`	`RangeElement\|null`	Cerca nei contenuti dell'elemento un discendente del tipo specificato.
`findElement(elementType, from)`	`RangeElement\|null`	Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal `RangeElement` specificato.
`findText(searchPattern)`	`RangeElement\|null`	Cerca nei contenuti dell'elemento il pattern di testo specificato utilizzando le espressioni regolari.
`findText(searchPattern, from)`	`RangeElement\|null`	Cerca nel contenuto 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 all'indice secondario specificato.
`getChildIndex(child)`	`Integer`	Recupera l'indice figlio per l'elemento figlio specificato.
`getHeadingAttributes(paragraphHeading)`	`Object`	Recupera l'insieme di attributi per il `ParagraphHeading` fornito.
`getImages()`	`InlineImage[]\|null`	Recupera tutti i `InlineImages` contenuti nella sezione.
`getListItems()`	`ListItem[]\|null`	Recupera tutti i `ListItems` contenuti nella sezione.
`getMarginBottom()`	`Number\|null`	Recupera il margine inferiore, in punti.
`getMarginLeft()`	`Number\|null`	Recupera il margine sinistro, in punti.
`getMarginRight()`	`Number\|null`	Recupera il margine destro.
`getMarginTop()`	`Number\|null`	Recupera il margine superiore.
`getNumChildren()`	`Integer`	Recupera il numero di figli.
`getPageHeight()`	`Number\|null`	Recupera l'altezza della pagina in punti.
`getPageWidth()`	`Number\|null`	Recupera la larghezza della pagina, in punti.
`getParagraphs()`	`Paragraph[]\|null`	Recupera tutti i `Paragraphs` contenuti nella sezione (inclusi i `ListItems`).
`getParent()`	`ContainerElement\|null`	Recupera l'elemento principale dell'elemento.
`getTables()`	`Table[]\|null`	Recupera tutti i `Tables` contenuti nella sezione.
`getText()`	`String`	Recupera i contenuti dell'elemento come stringa di testo.
`getTextAlignment()`	`TextAlignment\|null`	Ottiene l'allineamento del testo.
`getType()`	`ElementType`	Recupera `ElementType` dell'elemento.
`insertHorizontalRule(childIndex)`	`HorizontalRule`	Crea e inserisce un nuovo `HorizontalRule` all'indice specificato.
`insertImage(childIndex, image)`	`InlineImage`	Crea e inserisce un `InlineImage` dal blob dell'immagine specificato, all'indice specificato.
`insertImage(childIndex, image)`	`InlineImage`	Inserisce il `InlineImage` specificato all'indice indicato.
`insertListItem(childIndex, listItem)`	`ListItem`	Inserisce il `ListItem` specificato all'indice indicato.
`insertListItem(childIndex, text)`	`ListItem`	Crea e inserisce un nuovo `ListItem` all'indice specificato, contenente i contenuti di testo specificati.
`insertPageBreak(childIndex)`	`PageBreak`	Crea e inserisce un nuovo `PageBreak` all'indice specificato.
`insertPageBreak(childIndex, pageBreak)`	`PageBreak`	Inserisce il `PageBreak` specificato all'indice indicato.
`insertParagraph(childIndex, paragraph)`	`Paragraph`	Inserisce il `Paragraph` specificato all'indice indicato.
`insertParagraph(childIndex, text)`	`Paragraph`	Crea e inserisce un nuovo `Paragraph` all'indice specificato, contenente i contenuti di testo specificati.
`insertTable(childIndex)`	`Table`	Crea e inserisce un nuovo `Table` all'indice specificato.
`insertTable(childIndex, cells)`	`Table`	Crea e inserisce un nuovo `Table` contenente le celle specificate, all'indice specificato.
`insertTable(childIndex, table)`	`Table`	Inserisce il `Table` specificato all'indice indicato.
`removeChild(child)`	`Body`	Rimuove l'elemento figlio specificato.
`replaceText(searchPattern, replacement)`	`Element`	Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa di sostituzione, utilizzando espressioni regolari.
`setAttributes(attributes)`	`Body`	Imposta gli attributi dell'elemento.
`setHeadingAttributes(paragraphHeading, attributes)`	`Body`	Imposta gli attributi per `ParagraphHeading` fornito.
`setMarginBottom(marginBottom)`	`Body`	Imposta il margine inferiore, in punti.
`setMarginLeft(marginLeft)`	`Body`	Imposta il margine sinistro, in punti.
`setMarginRight(marginRight)`	`Body`	Imposta il margine destro, in punti.
`setMarginTop(marginTop)`	`Body`	Imposta il margine superiore.
`setPageHeight(pageHeight)`	`Body`	Imposta l'altezza della pagina in punti.
`setPageWidth(pageWidth)`	`Body`	Imposta la larghezza della pagina, in punti.
`setText(text)`	`Body`	Imposta i contenuti come testo normale.
`setTextAlignment(textAlignment)`	`Body`	Imposta l'allineamento del testo.

Metodi ritirati

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

Documentazione dettagliata

`appendHorizontalRule()`

Crea e aggiunge un nuovo HorizontalRule.

Il HorizontalRule sarà contenuto in un nuovo Paragraph.

Indietro

HorizontalRule: la nuova regola 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 dell'immagine specificato.

L'immagine sarà contenuta in un nuovo Paragraph.

Parametri

Nome	Tipo	Descrizione
`image`	`BlobSource`	I dati immagine.

Indietro

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

Aggiunge l'elemento InlineImage specificato.

Il InlineImage sarà contenuto in un nuovo Paragraph.

Utilizza questa versione di appendImage quando aggiungi una copia di un InlineImage esistente.

Parametri

Nome	Tipo	Descrizione
`image`	`InlineImage`	I dati immagine.

Indietro

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

Aggiunge l'elemento ListItem specificato.

Utilizza questa versione di appendListItem quando aggiungi una copia di un ListItem esistente.

Parametri

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

Indietro

ListItem: l'elemento dell'elenco 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

`appendListItem(text)`

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

Gli elementi di elenco consecutivi vengono aggiunti come parte dello stesso elenco.

Parametri

Nome	Tipo	Descrizione
`text`	`String`	I contenuti di testo della voce di elenco.

Indietro

ListItem: il nuovo elemento 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

`appendPageBreak()`

Crea e aggiunge un nuovo PageBreak.

Il PageBreak sarà contenuto in un nuovo Paragraph.

Indietro

PageBreak: la nuova 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 l'elemento PageBreak specificato.

Il PageBreak sarà contenuto in un nuovo Paragraph.

Utilizza questa versione di appendPageBreak quando aggiungi una copia di un PageBreak esistente.

Parametri

Nome	Tipo	Descrizione
`pageBreak`	`PageBreak`	L'interruzione di pagina da aggiungere.

Indietro

PageBreak: l'interruzione di pagina 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

`appendParagraph(paragraph)`

Aggiunge l'elemento Paragraph specificato.

Utilizza questa versione di appendParagraph quando aggiungi una copia di un Paragraph esistente.

Parametri

Nome	Tipo	Descrizione
`paragraph`	`Paragraph`	Il paragrafo da accodare.

Indietro

Paragraph: il 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 contenente i contenuti di testo specificati.

Parametri

Nome	Tipo	Descrizione
`text`	`String`	I contenuti di testo del paragrafo.

Indietro

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 Google Docs non possono terminare con una tabella.

Indietro

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

Aggiunge un nuovo Table contenente un TableCell per ogni valore stringa specificato.

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

Parametri

Nome	Tipo	Descrizione
`cells`	`String[][]`	I contenuti di testo delle celle della tabella da aggiungere alla nuova tabella.

Indietro

Table: la 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)`

Aggiunge l'elemento Table specificato.

Utilizza questa versione di appendTable quando aggiungi una copia di un Table esistente. Questo metodo aggiungerà anche un paragrafo vuoto dopo la tabella, poiché i documenti Google Docs non possono terminare con una tabella.

Parametri

Nome	Tipo	Descrizione
`table`	`Table`	La tabella da aggiungere.

Indietro

Table: la 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()`

Cancella i contenuti dell'elemento.

Indietro

Body: l'elemento corrente.

`copy()`

Restituisce una copia indipendente e completa dell'elemento corrente.

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

Indietro

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

Ottiene una versione Text dell'elemento corrente per la modifica.

Utilizza editAsText per manipolare i contenuti degli elementi come testo RTF. 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);

Indietro

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.

Indietro

RangeElement|null: 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.

Indietro

RangeElement|null: 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 JavaScript non è completamente supportato, ad esempio gruppi di acquisizione e modificatori di modalità.

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

Parametri

Nome	Tipo	Descrizione
`searchPattern`	`String`	il pattern da cercare

Indietro

RangeElement|null: un risultato di ricerca che indica la posizione del testo di ricerca o null se non corrisponde

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 nel contenuto dell'elemento il pattern di testo specificato, a partire da un determinato risultato di ricerca.

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

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

Parametri

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

Indietro

RangeElement|null: un risultato di ricerca che indica la posizione successiva del testo di ricerca o null se non è presente 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

`getAttributes()`

Recupera gli attributi dell'elemento.

Il risultato è un oggetto contenente una proprietà per ogni attributo dell'elemento valido, in cui ogni nome di 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]}`);
}

Indietro

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 secondario all'indice secondario 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.

Indietro

Element: l'elemento secondario all'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 figlio specificato.

Parametri

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

Indietro

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

`getHeadingAttributes(paragraphHeading)`

Recupera l'insieme di attributi per il ParagraphHeading fornito.

Parametri

Nome	Tipo	Descrizione
`paragraphHeading`	`ParagraphHeading`	L'intestazione di cui recuperare gli attributi.

Indietro

Object: una mappa degli attributi e dei relativi valori attuali.

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 InlineImages contenuti nella sezione.

Indietro

InlineImage[]|null: 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 ListItems contenuti nella sezione.

Indietro

ListItem[]|null: gli elementi 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

`getMarginBottom()`

Recupera il margine inferiore, in punti.

Indietro

Number|null: il margine inferiore, 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

`getMarginLeft()`

Recupera il margine sinistro, in punti.

Indietro

Number|null: il margine sinistro, 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

`getMarginRight()`

Recupera il margine destro.

Indietro

Number|null: il margine destro, 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

`getMarginTop()`

Recupera il margine superiore.

Indietro

Number|null: il margine superiore, 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

`getNumChildren()`

Recupera il numero di figli.

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.`);

Indietro

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

`getPageHeight()`

Recupera l'altezza della pagina in punti.

Indietro

Number|null: l'altezza della pagina, 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

`getPageWidth()`

Recupera la larghezza della pagina, in punti.

Indietro

Number|null: la larghezza della pagina, 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

`getParagraphs()`

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

Indietro

Paragraph[]|null: 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.

Indietro

ContainerElement|null: 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 Tables contenuti nella sezione.

Indietro

Table[]|null: 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.

Indietro

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

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

Indietro

TextAlignment|null: il tipo di allineamento del testo o 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 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.');
}

Indietro

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 HorizontalRule all'indice specificato.

Il HorizontalRule sarà contenuto in un nuovo Paragraph.

Parametri

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

Indietro

HorizontalRule: la nuova regola 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 dell'immagine specificato, all'indice specificato.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	L'indice in cui inserire l'elemento.
`image`	`BlobSource`	I dati immagine.

Indietro

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 InlineImage specificato all'indice indicato.

L'immagine sarà contenuta in un nuovo Paragraph.

Parametri

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

Indietro

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 ListItem specificato all'indice indicato.

Parametri

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

Indietro

ListItem: la voce di 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 ListItem all'indice specificato, contenente i contenuti di testo specificati.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	L'indice in cui inserire.
`text`	`String`	I contenuti di testo della voce di elenco.

Indietro

ListItem: il nuovo elemento 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

`insertPageBreak(childIndex)`

Crea e inserisce un nuovo PageBreak all'indice specificato.

Il PageBreak sarà contenuto in un nuovo Paragraph.

Parametri

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

Indietro

PageBreak: la nuova 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 PageBreak specificato all'indice indicato.

Il PageBreak sarà contenuto in un nuovo Paragraph.

Parametri

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

Indietro

PageBreak: l'interruzione di pagina 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

`insertParagraph(childIndex, paragraph)`

Inserisce il Paragraph specificato all'indice indicato.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	L'indice in cui inserire.
`paragraph`	`Paragraph`	Il paragrafo da inserire.

Indietro

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 Paragraph all'indice specificato, contenente i contenuti di testo specificati.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	L'indice in cui inserire.
`text`	`String`	I contenuti di testo del paragrafo.

Indietro

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 Table all'indice specificato.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	L'indice in cui inserire.

Indietro

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, all'indice specificato.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	L'indice in cui inserire.
`cells`	`String[][]`	I contenuti di testo delle celle della tabella da aggiungere alla nuova tabella.

Indietro

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 Table specificato all'indice indicato.

Parametri

Nome	Tipo	Descrizione
`childIndex`	`Integer`	L'indice in cui inserire.
`table`	`Table`	La tabella da inserire.

Indietro

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

Parametri

Nome	Tipo	Descrizione
`child`	`Element`	L'elemento secondario da rimuovere.

Indietro

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

`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 tutte le barre rovesciate nel pattern.

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

Il pattern di espressione regolare fornito viene confrontato in modo indipendente con 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`	il pattern dell'espressione regolare da cercare
`replacement`	`String`	il testo da utilizzare come sostituzione

Indietro

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 di proprietà è un elemento dell'enumerazione DocumentApp.Attribute e ogni valore di 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.

Indietro

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

`setHeadingAttributes(paragraphHeading, attributes)`

Imposta gli attributi per ParagraphHeading fornito.

Parametri

Nome	Tipo	Descrizione
`paragraphHeading`	`ParagraphHeading`	L'intestazione di cui devono essere impostati gli attributi.
`attributes`	`Object`	Una mappa degli attributi e dei valori da impostare.

Indietro

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

`setMarginBottom(marginBottom)`

Imposta il margine inferiore, in punti.

Parametri

Nome	Tipo	Descrizione
`marginBottom`	`Number`	Il margine inferiore, in punti.

Indietro

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

`setMarginLeft(marginLeft)`

Imposta il margine sinistro, in punti.

Parametri

Nome	Tipo	Descrizione
`marginLeft`	`Number`	Il margine sinistro, in punti.

Indietro

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

`setMarginRight(marginRight)`

Imposta il margine destro, in punti.

Parametri

Nome	Tipo	Descrizione
`marginRight`	`Number`	Il margine destro.

Indietro

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

`setMarginTop(marginTop)`

Imposta il margine superiore.

Parametri

Nome	Tipo	Descrizione
`marginTop`	`Number`	Il margine superiore, in punti.

Indietro

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

`setPageHeight(pageHeight)`

Imposta l'altezza della pagina in punti.

Parametri

Nome	Tipo	Descrizione
`pageHeight`	`Number`	L'altezza della pagina, in punti.

Indietro

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

`setPageWidth(pageWidth)`

Imposta la larghezza della pagina, in punti.

Parametri

Nome	Tipo	Descrizione
`pageWidth`	`Number`	La larghezza della pagina, in punti.

Indietro

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

Indietro

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

Indietro

Body: 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 ritirati

`getFootnotes()`

Deprecato. Questo elemento non può contenere un Footnote.

Recupera tutti i Footnotes contenuti nella sezione.

Indietro

Footnote[]|null: 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()`

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

Recupera l'URL del link.

Indietro

String|null: 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

`getNextSibling()`

Deprecato. Questo elemento non ha elementi di pari livello.

Recupera l'elemento successivo associato all'elemento.

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

Indietro

Element|null: l'elemento associato 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()`

Deprecato. Questo elemento non ha elementi di pari livello.

Recupera l'elemento precedente associato all'elemento.

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

Indietro

Element|null: l'elemento associato 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()`

Deprecato. Questo metodo non è affidabile per HeaderSection.

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

Indietro

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

`setLinkUrl(url)`

Deprecato. 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`	l'URL del link

Indietro

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

Class Body Mantieni tutto organizzato con le raccolte Salva e classifica i contenuti in base alle tue preferenze.

Metodi

Metodi ritirati

Documentazione dettagliata

appendHorizontalRule()

Indietro

Autorizzazione

appendImage(image)

Parametri

Indietro

Autorizzazione

appendImage(image)

Parametri

Indietro

Autorizzazione

appendListItem(listItem)

Parametri

Indietro

Autorizzazione

appendListItem(text)

Parametri

Indietro

Autorizzazione

appendPageBreak()

Indietro

Autorizzazione

appendPageBreak(pageBreak)

Parametri

Indietro

Autorizzazione

appendParagraph(paragraph)

Parametri

Indietro

Autorizzazione

appendParagraph(text)

Parametri

Indietro

Autorizzazione

appendTable()

Indietro

Autorizzazione

appendTable(cells)

Parametri

Indietro

Autorizzazione

appendTable(table)

Parametri

Indietro

Autorizzazione

clear()

Indietro

copy()

Indietro

Autorizzazione

editAsText()

Indietro

findElement(elementType)

Parametri

Indietro

Autorizzazione

findElement(elementType, from)

Parametri

Indietro

Autorizzazione

findText(searchPattern)

Parametri

Indietro

Autorizzazione

findText(searchPattern, from)

Parametri

Indietro

Autorizzazione

getAttributes()

Indietro

Autorizzazione

getChild(childIndex)

Parametri

Indietro

Autorizzazione

getChildIndex(child)

Class Body

`appendHorizontalRule()`

`appendImage(image)`

`appendImage(image)`

`appendListItem(listItem)`

`appendListItem(text)`

`appendPageBreak()`

`appendPageBreak(pageBreak)`

`appendParagraph(paragraph)`

`appendParagraph(text)`

`appendTable()`

`appendTable(cells)`

`appendTable(table)`

`clear()`

`copy()`

`editAsText()`

`findElement(elementType)`

`findElement(elementType, from)`

`findText(searchPattern)`

`findText(searchPattern, from)`

`getAttributes()`

`getChild(childIndex)`

`getChildIndex(child)`

`getHeadingAttributes(paragraphHeading)`

`getImages()`

`getListItems()`

`getMarginBottom()`

`getMarginLeft()`

`getMarginRight()`

`getMarginTop()`

`getNumChildren()`

`getPageHeight()`

`getPageWidth()`

`getParagraphs()`

`getParent()`

`getTables()`

`getText()`

`getTextAlignment()`

`getType()`

`insertHorizontalRule(childIndex)`

`insertImage(childIndex, image)`

`insertImage(childIndex, image)`

`insertListItem(childIndex, listItem)`

`insertListItem(childIndex, text)`