Class HeaderSection

IntestazioneSezione

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

Metodi

MetodoTipo restituitoBreve descrizione
appendHorizontalRule()HorizontalRuleCrea e aggiunge un nuovo HorizontalRule.
appendImage(image)InlineImageCrea e aggiunge un nuovo InlineImage dal blob immagine specificato.
appendImage(image)InlineImageAggiunge il InlineImage specificato.
appendListItem(listItem)ListItemAggiunge il ListItem specificato.
appendListItem(text)ListItemCrea e aggiunge un nuovo ListItem contenente i contenuti di testo specificati.
appendParagraph(paragraph)ParagraphAggiunge il Paragraph specificato.
appendParagraph(text)ParagraphCrea e aggiunge un nuovo Paragraph contenente i contenuti di testo specificati.
appendTable()TableCrea e aggiunge un nuovo Table.
appendTable(cells)TableAggiunge un nuovo Table contenente un TableCell per ogni valore di stringa specificato.
appendTable(table)TableAggiunge il Table specificato.
clear()HeaderSectionCancella i contenuti dell'elemento.
copy()HeaderSectionRestituisce una copia approfondita e scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente da modificare.
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 RangeElement specificato.
findText(searchPattern)RangeElementCerca, nei contenuti dell'elemento, il pattern di testo specificato utilizzando le espressioni regolari.
findText(searchPattern, from)RangeElementCerca il pattern di testo specificato nei contenuti dell'elemento, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio all'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice dell'elemento secondario per l'elemento secondario specificato.
getImages()InlineImage[]Recupera tutti i InlineImages contenuti nella sezione.
getListItems()ListItem[]Recupera tutti i ListItems contenuti nella sezione.
getNumChildren()IntegerRecupera il numero di bambini.
getParagraphs()Paragraph[]Recupera tutti i Paragraphs contenuti nella sezione (incluso ListItems).
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getTables()Table[]Recupera tutti i Tables contenuti nella sezione.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentRestituisce l'allineamento del testo.
getType()ElementTypeRecupera il ElementType dell'elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserisce un nuovo HorizontalRule nell'indice specificato.
insertImage(childIndex, image)InlineImageCrea e inserisce un InlineImage dal blob 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 ListItem nell'indice specificato, contenente i contenuti di testo specificati.
insertParagraph(childIndex, paragraph)ParagraphInserisce il valore Paragraph specificato nell'indice specificato.
insertParagraph(childIndex, text)ParagraphCrea e inserisce un nuovo Paragraph nell'indice specificato, contenente i contenuti di testo specificati.
insertTable(childIndex)TableCrea e inserisce un nuovo 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)HeaderSectionRimuove l'elemento figlio specificato.
removeFromParent()HeaderSectionRimuove l'elemento dal relativo elemento principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa di sostituzione, utilizzando espressioni regolari.
setAttributes(attributes)HeaderSectionImposta gli attributi dell'elemento.
setText(text)HeaderSectionImposta i contenuti come testo normale.
setTextAlignment(textAlignment)HeaderSectionImposta l'allineamento del testo.

Documentazione dettagliata

appendHorizontalRule()

Crea e aggiunge un nuovo HorizontalRule.

Il HorizontalRule sarà contenuto in un nuovo Paragraph.

Invio

HorizontalRule: il nuovo righello orizzontale.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

appendImage(image)

Crea e aggiunge un nuovo InlineImage dal blob immagine specificato.

L'immagine sarà contenuta in un nuovo Paragraph.

Parametri

NomeTipoDescrizione
imageBlobSourceI dati immagine.

Invio

InlineImage: l'immagine aggiunta.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

appendImage(image)

Aggiunge il InlineImage specificato.

Il InlineImage sarà contenuto in un nuovo Paragraph.

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

Parametri

NomeTipoDescrizione
imageInlineImageI dati immagine.

Invio

InlineImage: l'immagine aggiunta.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

appendListItem(listItem)

Aggiunge il ListItem specificato.

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

Parametri

NomeTipoDescrizione
listItemListItemL'elemento dell'elenco da accodare.

Invio

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

NomeTipoDescrizione
textStringI contenuti di testo dell'elemento dell'elenco.

Invio

ListItem: la nuova voce dell'elenco.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

appendParagraph(paragraph)

Aggiunge il Paragraph specificato.

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

Parametri

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

appendParagraph(text)

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

Parametri

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

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.

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

appendTable(cells)

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

appendTable(table)

Aggiunge il 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 di Documenti Google non possono terminare con una tabella.

Parametri

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

Cancella i contenuti dell'elemento.

Invio

HeaderSection: l'elemento corrente.

copy()

Restituisce una copia approfondita e scollegata dell'elemento corrente.

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

Invio

HeaderSection: la nuova copia.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

editAsText()

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

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

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

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

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

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

Invio

Text: una versione di testo dell'elemento corrente

findElement(elementType)

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

Parametri

NomeTipoDescrizione
elementTypeElementTypeIl tipo di elemento da cercare.

Invio

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

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

findElement(elementType, from)

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

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

// Define the search parameters.

let searchResult = null;

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

Parametri

NomeTipoDescrizione
elementTypeElementTypeIl tipo di elemento da cercare.
fromRangeElementIl risultato di ricerca da cui effettuare la ricerca.

Invio

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

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

findText(searchPattern)

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

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

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

Parametri

NomeTipoDescrizione
searchPatternStringlo schema da cercare

Invio

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

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

findText(searchPattern, from)

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

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

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

Parametri

NomeTipoDescrizione
searchPatternStringlo schema da cercare
fromRangeElementil risultato di ricerca da cui effettuare la ricerca

Invio

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

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getAttributes()

Recupera gli attributi dell'elemento.

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

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

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

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

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

Invio

Object: gli attributi dell'elemento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getChild(childIndex)

Recupera l'elemento figlio all'indice figlio specificato. 

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

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

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

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice dell'elemento secondario da recuperare.

Invio

Element: l'elemento secondario nell'indice specificato.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getChildIndex(child)

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

Parametri

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

getImages()

Recupera tutti i InlineImages contenuti nella sezione.

Invio

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

Invio

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

getNumChildren()

Recupera il numero di bambini. 

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

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

Invio

Integer: il numero di bambini.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getParagraphs()

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

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

getParent()

Recupera l'elemento principale dell'elemento.

L'elemento principale contiene l'elemento corrente.

Invio

ContainerElement: l'elemento principale.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTables()

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

getText()

Recupera i contenuti dell'elemento come stringa di testo.

Invio

String: i contenuti dell'elemento come stringa di testo

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getTextAlignment()

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

Invio

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

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

getType()

Recupera il ElementType dell'elemento.

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

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

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

const firstChild = body.getChild(0);

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

Invio

ElementType: il tipo di elemento.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertHorizontalRule(childIndex)

Crea e inserisce un nuovo HorizontalRule nell'indice specificato.

Il HorizontalRule sarà contenuto in un nuovo Paragraph.

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice in cui inserire l'elemento.

Invio

HorizontalRule: il nuovo righello orizzontale.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertImage(childIndex, image)

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

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice in cui inserire l'elemento.
imageBlobSourceI dati immagine.

Invio

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 sarà contenuta in un nuovo Paragraph.

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice in cui inserire l'elemento.
imageInlineImageL'immagine da inserire.

Invio

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 eseguire l'inserimento.
listItemListItemL'elemento dell'elenco da inserire.

Invio

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

insertListItem(childIndex, text)

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

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice in cui eseguire l'inserimento.
textStringI contenuti di testo dell'elemento dell'elenco.

Invio

ListItem: la nuova voce dell'elenco.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

insertParagraph(childIndex, paragraph)

Inserisce il valore Paragraph specificato nell'indice specificato.

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice in cui eseguire l'inserimento.
paragraphParagraphIl 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

insertParagraph(childIndex, text)

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

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice in cui eseguire l'inserimento.
textStringI 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

insertTable(childIndex)

Crea e inserisce un nuovo Table nell'indice specificato.

Parametri

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

insertTable(childIndex, cells)

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

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice in cui eseguire l'inserimento.
cellsString[][]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

insertTable(childIndex, table)

Inserisce il valore Table specificato nell'indice specificato.

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice in cui eseguire l'inserimento.
tableTableLa 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

removeChild(child)

Rimuove l'elemento figlio specificato.

Parametri

NomeTipoDescrizione
childElementL'elemento secondario da rimuovere.

Invio

HeaderSection: l'elemento corrente.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

removeFromParent()

Rimuove l'elemento dal relativo elemento principale. 

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

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

Invio

HeaderSection: l'elemento rimosso.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

replaceText(searchPattern, replacement)

Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa 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

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

setAttributes(attributes)

Imposta gli attributi dell'elemento.

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

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

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

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

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

Parametri

NomeTipoDescrizione
attributesObjectGli attributi dell'elemento.

Invio

HeaderSection: l'elemento corrente.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setText(text)

Imposta i contenuti come testo normale.

Nota: i contenuti esistenti vengono cancellati.

Parametri

NomeTipoDescrizione
textStringI nuovi contenuti di testo.

Invio

HeaderSection: l'elemento corrente.

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

setTextAlignment(textAlignment)

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

// Make the entire first paragraph 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

NomeTipoDescrizione
textAlignmentTextAlignmentil tipo di allineamento del testo da applicare

Invio

HeaderSection: l'elemento corrente

Autorizzazione

Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:

  • https://www.googleapis.com/auth/documents.currentonly
  • https://www.googleapis.com/auth/documents

Metodi ritirati