Class Body

Body

Un elemento che rappresenta il corpo di un documento. Body può contenere elementi ListItem, Paragraph, Table e TableOfContents. Per ulteriori informazioni sulla struttura dei documenti, consulta la guida all'estensione di Documenti Google.

In genere Body contiene i contenuti completi del documento, tranne HeaderSection, FooterSection e gli eventuali elementi FootnoteSection. 

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

// Append a paragraph and a page break to the document body section directly.
body.appendParagraph("A paragraph.");
body.appendPageBreak();

Metodi

MetodoTipo restituitoBreve descrizione
appendHorizontalRule()HorizontalRuleCrea e aggiunge un nuovo HorizontalRule.
appendImage(image)InlineImageCrea e aggiunge un nuovo InlineImage dal blob di immagine specificato.
appendImage(image)InlineImageAccoda il valore InlineImage specificato.
appendListItem(listItem)ListItemAccoda il valore ListItem specificato.
appendListItem(text)ListItemCrea e aggiunge un nuovo ListItem con i contenuti di testo specificati.
appendPageBreak()PageBreakCrea e aggiunge un nuovo PageBreak.
appendPageBreak(pageBreak)PageBreakAccoda il valore PageBreak specificato.
appendParagraph(paragraph)ParagraphAccoda il valore Paragraph specificato.
appendParagraph(text)ParagraphCrea e aggiunge un nuovo Paragraph con i contenuti di testo specificati.
appendTable()TableCrea e aggiunge un nuovo Table.
appendTable(cells)TableAccoda un nuovo Table contenente un TableCell per ogni valore di stringa specificato.
appendTable(table)TableAccoda il valore Table specificato.
clear()BodyConsente di cancellare i contenuti dell'elemento.
copy()BodyRestituisce una copia separata e approfondita dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, per la modifica.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal valore RangeElement specificato.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento secondario nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento secondario specificato.
getHeadingAttributes(paragraphHeading)ObjectRecupera l'insieme di attributi per l'elemento ParagraphHeading fornito.
getImages()InlineImage[]Recupera tutti i valori InlineImages contenuti nella sezione.
getListItems()ListItem[]Recupera tutti i valori ListItems contenuti nella sezione.
getMarginBottom()NumberRecupera il margine inferiore, in punti.
getMarginLeft()NumberRecupera il margine sinistro, in punti.
getMarginRight()NumberRecupera il margine destro.
getMarginTop()NumberRecupera il margine superiore.
getNumChildren()IntegerRecupera il numero di bambini.
getPageHeight()NumberRecupera l'altezza della pagina in punti.
getPageWidth()NumberRecupera la larghezza della pagina, in punti.
getParagraphs()Paragraph[]Recupera tutti i Paragraphs contenuti nella sezione (incluso ListItems).
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getTables()Table[]Recupera tutti i valori Tables contenuti nella sezione.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentConsente di acquisire l'allineamento del testo.
getType()ElementTypeRecupera l'elemento ElementType dell'elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserisce un nuovo valore HorizontalRule nell'indice specificato.
insertImage(childIndex, image)InlineImageCrea e inserisce un InlineImage dal blob di immagine specificato, nell'indice specificato.
insertImage(childIndex, image)InlineImageInserisce il valore InlineImage specificato nell'indice specificato.
insertListItem(childIndex, listItem)ListItemInserisce il valore ListItem specificato nell'indice specificato.
insertListItem(childIndex, text)ListItemCrea e inserisce un nuovo valore ListItem nell'indice specificato, contenente i contenuti di testo specificati.
insertPageBreak(childIndex)PageBreakCrea e inserisce un nuovo valore PageBreak nell'indice specificato.
insertPageBreak(childIndex, pageBreak)PageBreakInserisce il valore PageBreak specificato nell'indice specificato.
insertParagraph(childIndex, paragraph)ParagraphInserisce il valore Paragraph specificato nell'indice specificato.
insertParagraph(childIndex, text)ParagraphCrea e inserisce un nuovo valore Paragraph nell'indice specificato, contenente i contenuti di testo specificati.
insertTable(childIndex)TableCrea e inserisce un nuovo valore Table nell'indice specificato.
insertTable(childIndex, cells)TableCrea e inserisce un nuovo Table contenente le celle specificate, nell'indice specificato.
insertTable(childIndex, table)TableInserisce il valore Table specificato nell'indice specificato.
removeChild(child)BodyRimuove l'elemento secondario specificato.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando le espressioni regolari.
setAttributes(attributes)BodyImposta gli attributi dell'elemento.
setHeadingAttributes(paragraphHeading, attributes)BodyImposta gli attributi per l'oggetto ParagraphHeading fornito.
setMarginBottom(marginBottom)BodyImposta il margine inferiore in punti.
setMarginLeft(marginLeft)BodyImposta il margine sinistro in punti.
setMarginRight(marginRight)BodyImposta il margine destro in punti.
setMarginTop(marginTop)BodyImposta il margine superiore.
setPageHeight(pageHeight)BodyConsente di impostare l'altezza della pagina in punti.
setPageWidth(pageWidth)BodyImposta la larghezza della pagina in punti.
setText(text)BodyImposta i contenuti come testo normale.
setTextAlignment(textAlignment)BodyImposta l'allineamento del testo.

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

NomeTipoDescrizione
imageBlobSourcei 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

NomeTipoDescrizione
imageInlineImagei 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

NomeTipoDescrizione
listItemListIteml'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

NomeTipoDescrizione
textStringi 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

appendPageBreak()

Crea e aggiunge un nuovo PageBreak.

Il PageBreak verrà contenuto in un nuovo Paragraph.

Ritorni

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)

Accoda il valore PageBreak specificato.

Il PageBreak verrà contenuto in un nuovo Paragraph.

Usa questa versione di appendPageBreak per aggiungere una copia di un PageBreak esistente.

Parametri

NomeTipoDescrizione
pageBreakPageBreakl'interruzione di pagina da aggiungere

Ritorni

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)

Accoda il valore Paragraph specificato.

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

Parametri

NomeTipoDescrizione
paragraphParagraphil 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

NomeTipoDescrizione
textStringi 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

NomeTipoDescrizione
cellsString[][]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

NomeTipoDescrizione
tableTablela 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

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

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

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

NomeTipoDescrizione
elementTypeElementTypeil 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

NomeTipoDescrizione
elementTypeElementTypeil tipo di elemento da cercare
fromRangeElementil 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

NomeTipoDescrizione
searchPatternStringlo 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

NomeTipoDescrizione
searchPatternStringlo schema da cercare
fromRangeElementil 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

NomeTipoDescrizione
childIndexIntegerl'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

NomeTipoDescrizione
childElementl'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

getHeadingAttributes(paragraphHeading)

Recupera l'insieme di attributi per l'elemento ParagraphHeading fornito.

Parametri

NomeTipoDescrizione
paragraphHeadingParagraphHeadingl'intestazione di cui verranno recuperati gli attributi

Ritorni

Object: una mappa degli attributi e dei loro 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 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

getMarginBottom()

Recupera il margine inferiore, in punti.

Ritorni

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

Ritorni

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

Ritorni

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

Ritorni

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

getPageHeight()

Recupera l'altezza della pagina in punti.

Ritorni

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

getPageWidth()

Recupera la larghezza della pagina, in punti.

Ritorni

Number: 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 (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

NomeTipoDescrizione
childIndexIntegerl'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

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento
imageBlobSourcei 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

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento
imageInlineImagel'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

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire
listItemListIteml'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

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire
textStringi 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

insertPageBreak(childIndex)

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

Il PageBreak verrà contenuto in un nuovo Paragraph.

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento

Ritorni

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

Il PageBreak verrà contenuto in un nuovo Paragraph.

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire l'elemento
pageBreakPageBreakla pausa p[age da inserire

Ritorni

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

Parametri

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire
paragraphParagraphil 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

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire
textStringi 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

NomeTipoDescrizione
childIndexIntegerl'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

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire
cellsString[][]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

NomeTipoDescrizione
childIndexIntegerl'indice in cui inserire
tableTablela 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

NomeTipoDescrizione
childElementl'elemento secondario da rimuovere

Ritorni

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

NomeTipoDescrizione
searchPatternStringil pattern regex per cercare
replacementStringil 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

NomeTipoDescrizione
attributesObjectGli attributi dell'elemento.

Ritorni

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 l'oggetto ParagraphHeading fornito.

Parametri

NomeTipoDescrizione
paragraphHeadingParagraphHeadingl'intestazione di cui verranno impostati gli attributi
attributesObjectuna mappa degli attributi e dei valori a cui impostarli

Ritorni

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

NomeTipoDescrizione
marginBottomNumbermargine inferiore, in punti

Ritorni

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

NomeTipoDescrizione
marginLeftNumbermargine sinistro, in punti

Ritorni

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

NomeTipoDescrizione
marginRightNumbermargine destro

Ritorni

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

NomeTipoDescrizione
marginTopNumbermargine superiore, in punti

Ritorni

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)

Consente di impostare l'altezza della pagina in punti.

Parametri

NomeTipoDescrizione
pageHeightNumberl'altezza della pagina, in punti

Ritorni

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

NomeTipoDescrizione
pageWidthNumberLa larghezza della pagina, in punti

Ritorni

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

NomeTipoDescrizione
textStringi nuovi contenuti testuali

Ritorni

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

Parametri

NomeTipoDescrizione
textAlignmentTextAlignmentil tipo di allineamento del testo da applicare

Ritorni

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 deprecati