I contenuti di una scheda in un documento di Documenti Google. L'elemento Body
può contenere elementi List
,
Paragraph
, Table
e Table
. Per ulteriori informazioni sulla struttura del documento, consulta la guida all'estensione di Documenti Google.
In genere, Body
contiene i contenuti completi della scheda, ad eccezione degli elementi Header
, Footer
e di eventuali elementi Footnote
.
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 |
---|---|---|
append | Horizontal | Crea e aggiunge un nuovo Horizontal . |
append | Inline | Crea e aggiunge un nuovo Inline dal blob immagine specificato. |
append | Inline | Aggiunge il Inline specificato. |
append | List | Aggiunge il List specificato. |
append | List | Crea e aggiunge un nuovo List contenente i contenuti di testo specificati. |
append | Page | Crea e aggiunge un nuovo Page . |
append | Page | Aggiunge il Page specificato. |
append | Paragraph | Aggiunge il Paragraph specificato. |
append | Paragraph | Crea e aggiunge un nuovo Paragraph contenente i contenuti di testo specificati. |
append | Table | Crea e aggiunge un nuovo Table . |
append | Table | Aggiunge un nuovo Table contenente un Table per ogni valore di stringa specificato. |
append | Table | Aggiunge il Table specificato. |
clear() | Body | Cancella i contenuti dell'elemento. |
copy() | Body | Restituisce una copia approfondita e scollegata dell'elemento corrente. |
edit | Text | Consente di ottenere una versione Text dell'elemento corrente da modificare. |
find | Range | Cerca nei contenuti dell'elemento un discendente del tipo specificato. |
find | Range | Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal Range specificato. |
find | Range | Cerca, nei contenuti dell'elemento, il pattern di testo specificato utilizzando le espressioni regolari. |
find | Range | Cerca il pattern di testo specificato nei contenuti dell'elemento, a partire da un determinato risultato di ricerca. |
get | Object | Recupera gli attributi dell'elemento. |
get | Element | Recupera l'elemento figlio all'indice figlio specificato. |
get | Integer | Recupera l'indice dell'elemento secondario per l'elemento secondario specificato. |
get | Object | Recupera l'insieme di attributi per il Paragraph fornito. |
get | Inline | Recupera tutti i Inline contenuti nella sezione. |
get | List | Recupera tutti i List contenuti nella sezione. |
get | Number | Recupera il margine inferiore in punti. |
get | Number | Recupera il margine sinistro in punti. |
get | Number | Recupera il margine destro. |
get | Number | Recupera il margine superiore. |
get | Integer | Recupera il numero di bambini. |
get | Number | Recupera l'altezza della pagina in punti. |
get | Number | Recupera la larghezza della pagina in punti. |
get | Paragraph[] | Recupera tutti i Paragraphs contenuti nella sezione (incluso List ). |
get | Container | Recupera l'elemento principale dell'elemento. |
get | Table[] | Recupera tutti i Tables contenuti nella sezione. |
get | String | Recupera i contenuti dell'elemento come stringa di testo. |
get | Text | Restituisce l'allineamento del testo. |
get | Element | Recupera il Element dell'elemento. |
insert | Horizontal | Crea e inserisce un nuovo Horizontal nell'indice specificato. |
insert | Inline | Crea e inserisce un Inline dal blob immagine specificato nell'indice specificato. |
insert | Inline | Inserisce il valore Inline specificato nell'indice specificato. |
insert | List | Inserisce il valore List specificato nell'indice specificato. |
insert | List | Crea e inserisce un nuovo List nell'indice specificato, contenente i contenuti di testo specificati. |
insert | Page | Crea e inserisce un nuovo Page nell'indice specificato. |
insert | Page | Inserisce il valore Page specificato nell'indice specificato. |
insert | Paragraph | Inserisce il valore Paragraph specificato nell'indice specificato. |
insert | Paragraph | Crea e inserisce un nuovo Paragraph nell'indice specificato, contenente i contenuti di testo specificati. |
insert | Table | Crea e inserisce un nuovo Table nell'indice specificato. |
insert | Table | Crea e inserisce un nuovo Table contenente le celle specificate nell'indice specificato. |
insert | Table | Inserisce il valore Table specificato nell'indice specificato. |
remove | Body | Rimuove l'elemento figlio specificato. |
replace | Element | Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa di sostituzione, utilizzando espressioni regolari. |
set | Body | Imposta gli attributi dell'elemento. |
set | Body | Imposta gli attributi per il Paragraph fornito. |
set | Body | Imposta il margine inferiore in punti. |
set | Body | Imposta il margine sinistro in punti. |
set | Body | Imposta il margine destro in punti. |
set | Body | Imposta il margine superiore. |
set | Body | Imposta l'altezza della pagina in punti. |
set | Body | Imposta la larghezza della pagina in punti. |
set | Body | Imposta i contenuti come testo normale. |
set | Body | Imposta l'allineamento del testo. |
Documentazione dettagliata
append Horizontal Rule()
Crea e aggiunge un nuovo Horizontal
.
Il Horizontal
sarà contenuto in un nuovo Paragraph
.
Invio
Horizontal
: 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
append Image(image)
Crea e aggiunge un nuovo Inline
dal blob immagine specificato.
L'immagine sarà contenuta in un nuovo Paragraph
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
image | Blob | I dati immagine. |
Invio
Inline
: 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
append Image(image)
Aggiunge il Inline
specificato.
Il Inline
sarà contenuto in un nuovo Paragraph
.
Utilizza questa versione di append
quando aggiungi una copia di un Inline
esistente.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
image | Inline | I dati immagine. |
Invio
Inline
: 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
append List Item(listItem)
Aggiunge il List
specificato.
Utilizza questa versione di append
quando aggiungi una copia di un List
esistente.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
list | List | L'elemento dell'elenco da accodare. |
Invio
List
: 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
append List Item(text)
Crea e aggiunge un nuovo List
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 dell'elemento dell'elenco. |
Invio
List
: 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
append Page Break()
Crea e aggiunge un nuovo Page
.
Il Page
sarà contenuto in un nuovo Paragraph
.
Invio
Page
: 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
append Page Break(pageBreak)
Aggiunge il Page
specificato.
Il Page
sarà contenuto in un nuovo Paragraph
.
Utilizza questa versione di append
quando aggiungi una copia di un Page
esistente.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
page | Page | L'interruzione di pagina da aggiungere. |
Invio
Page
: 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
append Paragraph(paragraph)
Aggiunge il Paragraph
specificato.
Utilizza questa versione di append
quando aggiungi una copia di un Paragraph
esistente.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
paragraph | Paragraph | Il paragrafo da accodare. |
Invio
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
append Paragraph(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. |
Invio
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
append Table()
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.
Invio
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
append Table(cells)
Aggiunge un nuovo Table
contenente un Table
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 di testo delle celle della tabella da aggiungere alla nuova tabella. |
Invio
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
append Table(table)
Aggiunge il Table
specificato.
Utilizza questa versione di append
quando aggiungi 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 accodare. |
Invio
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()
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
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
edit As Text()
Consente di ottenere una versione Text
dell'elemento corrente da modificare.
Utilizza edit
per manipolare i contenuti degli elementi come testo avanzato. La modalità edit
ignora gli elementi non di testo (come Inline
e Horizontal
).
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
find Element(elementType)
Cerca nei contenuti dell'elemento un discendente del tipo specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
element | Element | Il tipo di elemento da cercare. |
Invio
Range
: 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
find Element(elementType, from)
Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal Range
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 |
---|---|---|
element | Element | Il tipo di elemento da cercare. |
from | Range | Il risultato di ricerca da cui effettuare la ricerca. |
Invio
Range
: 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
find Text(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 |
---|---|---|
search | String | lo schema da cercare |
Invio
Range
: 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
find Text(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 |
---|---|---|
search | String | lo schema da cercare |
from | Range | il risultato di ricerca da cui effettuare la ricerca |
Invio
Range
: 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
get Attributes()
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 Document
.
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
get Child(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 |
---|---|---|
child | 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
get Child Index(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
get Heading Attributes(paragraphHeading)
Recupera l'insieme di attributi per il Paragraph
fornito.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
paragraph | Paragraph | La voce di cui devono essere recuperati gli attributi. |
Invio
Object
: una mappa degli attributi e dei relativi valori correnti.
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
get Images()
Recupera tutti i Inline
contenuti nella sezione.
Invio
Inline
: 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
get List Items()
Recupera tutti i List
contenuti nella sezione.
Invio
List
: gli elementi dell'elenco 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
get Margin Bottom()
Recupera il margine inferiore in punti.
Invio
Number
: 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
get Margin Left()
Recupera il margine sinistro in punti.
Invio
Number
: 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
get Margin Right()
Recupera il margine destro.
Invio
Number
: 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
get Margin Top()
Recupera il margine superiore.
Invio
Number
: 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
get Num Children()
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
get Page Height()
Recupera l'altezza della pagina in punti.
Invio
Number
: 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
get Page Width()
Recupera la larghezza della pagina in punti.
Invio
Number
: 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
get Paragraphs()
Recupera tutti i Paragraphs
contenuti nella sezione (incluso List
).
Invio
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
get Parent()
Recupera l'elemento principale dell'elemento.
L'elemento principale contiene l'elemento corrente.
Invio
Container
: 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
get Tables()
Recupera tutti i Tables
contenuti nella sezione.
Invio
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
get Text()
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
get Text Alignment()
Restituisce l'allineamento del testo. I tipi di allineamento disponibili sono Document
, Document
e Document
.
Invio
Text
: 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
get Type()
Recupera il Element
dell'elemento.
Utilizza get
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
Element
: 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
insert Horizontal Rule(childIndex)
Crea e inserisce un nuovo Horizontal
nell'indice specificato.
Il Horizontal
sarà contenuto in un nuovo Paragraph
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | L'indice in cui inserire l'elemento. |
Invio
Horizontal
: 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
insert Image(childIndex, image)
Crea e inserisce un Inline
dal blob immagine specificato nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | L'indice in cui inserire l'elemento. |
image | Blob | I dati immagine. |
Invio
Inline
: 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
insert Image(childIndex, image)
Inserisce il valore Inline
specificato nell'indice specificato.
L'immagine sarà contenuta in un nuovo Paragraph
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | L'indice in cui inserire l'elemento. |
image | Inline | L'immagine da inserire. |
Invio
Inline
: 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
insert List Item(childIndex, listItem)
Inserisce il valore List
specificato nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | L'indice in cui eseguire l'inserimento. |
list | List | L'elemento dell'elenco da inserire. |
Invio
List
: l'elemento dell'elenco 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
insert List Item(childIndex, text)
Crea e inserisce un nuovo List
nell'indice specificato, contenente i contenuti di testo specificati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | L'indice in cui eseguire l'inserimento. |
text | String | I contenuti di testo dell'elemento dell'elenco. |
Invio
List
: 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
insert Page Break(childIndex)
Crea e inserisce un nuovo Page
nell'indice specificato.
Il Page
sarà contenuto in un nuovo Paragraph
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | L'indice in cui inserire l'elemento. |
Invio
Page
: 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
insert Page Break(childIndex, pageBreak)
Inserisce il valore Page
specificato nell'indice specificato.
Il Page
sarà contenuto in un nuovo Paragraph
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | L'indice in cui inserire l'elemento. |
page | Page | L'interruzione di pagina da inserire. |
Invio
Page
: 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
insert Paragraph(childIndex, paragraph)
Inserisce il valore Paragraph
specificato nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | L'indice in cui eseguire l'inserimento. |
paragraph | Paragraph | Il paragrafo da inserire. |
Invio
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
insert Paragraph(childIndex, text)
Crea e inserisce un nuovo Paragraph
nell'indice specificato, contenente i contenuti di testo specificati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | L'indice in cui eseguire l'inserimento. |
text | String | I contenuti di testo del paragrafo. |
Invio
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
insert Table(childIndex)
Crea e inserisce un nuovo Table
nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | L'indice in cui eseguire l'inserimento. |
Invio
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
insert Table(childIndex, cells)
Crea e inserisce un nuovo Table
contenente le celle specificate nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | L'indice in cui eseguire l'inserimento. |
cells | String[][] | I contenuti di testo delle celle della tabella da aggiungere alla nuova tabella. |
Invio
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
insert Table(childIndex, table)
Inserisce il valore Table
specificato nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | L'indice in cui eseguire l'inserimento. |
table | Table | La tabella da inserire. |
Invio
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
remove Child(child)
Rimuove l'elemento figlio specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Element | L'elemento secondario da rimuovere. |
Invio
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
replace Text(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 |
---|---|---|
search | 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
set Attributes(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 Document
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
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
set Heading Attributes(paragraphHeading, attributes)
Imposta gli attributi per il Paragraph
fornito.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
paragraph | Paragraph | L'intestazione di cui devono essere impostati gli attributi. |
attributes | Object | Una mappa di attributi e dei valori da impostare. |
Invio
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
set Margin Bottom(marginBottom)
Imposta il margine inferiore in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
margin | Number | Il margine inferiore, in punti. |
Invio
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
set Margin Left(marginLeft)
Imposta il margine sinistro in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
margin | Number | Il margine sinistro, in punti. |
Invio
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
set Margin Right(marginRight)
Imposta il margine destro in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
margin | Number | Il margine destro. |
Invio
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
set Margin Top(marginTop)
Imposta il margine superiore.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
margin | Number | Il margine superiore, in punti. |
Invio
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
set Page Height(pageHeight)
Imposta l'altezza della pagina in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
page | Number | L'altezza della pagina, in punti. |
Invio
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
set Page Width(pageWidth)
Imposta la larghezza della pagina in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
page | Number | La larghezza della pagina, in punti. |
Invio
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
set Text(text)
Imposta i contenuti come testo normale.
Nota: i contenuti esistenti vengono cancellati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | I nuovi contenuti di testo. |
Invio
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
set Text Alignment(textAlignment)
Imposta l'allineamento del testo. I tipi di allineamento disponibili sono Document
, Document
e Document
.
// 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 |
---|---|---|
text | Text | il tipo di allineamento del testo da applicare |
Invio
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