Class FooterSection

FooterSection

Un elemento che rappresenta una sezione a piè di pagina. Un Document solitamente contiene al massimo un FooterSection. FooterSection può contenere ListItem, Paragraph e Table elementi. Per ulteriori informazioni sulla struttura dei documenti, 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 dell'immagine specificato.
appendImage(image)InlineImageAggiungi il valore InlineImage specificato.
appendListItem(listItem)ListItemAggiungi il valore ListItem specificato.
appendListItem(text)ListItemCrea e aggiunge un nuovo ListItem contenente i contenuti di testo specificati.
appendParagraph(paragraph)ParagraphAggiungi il valore 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)TableAggiungi il valore Table specificato.
clear()FooterSectionCancella i contenuti dell'elemento.
copy()FooterSectionRestituisce una copia diretta 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 specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getImages()InlineImage[]Recupera tutti i valori InlineImages contenuti nella sezione.
getListItems()ListItem[]Recupera tutti i valori ListItems contenuti nella sezione.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getParagraphs()Paragraph[]Recupera tutti i valori 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()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserisce un nuovo HorizontalRule nell'indice specificato.
insertImage(childIndex, image)InlineImageCrea e inserisce un InlineImage dal blob dell'immagine specificato, nel punto specificato indice.
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 il valore specificato contenuti testuali.
insertParagraph(childIndex, paragraph)ParagraphInserisce il valore Paragraph specificato nell'indice specificato.
insertParagraph(childIndex, text)ParagraphCrea e inserisce un nuovo Paragraph nell'indice specificato, contenente il valore specificato contenuti testuali.
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)FooterSectionRimuove l'elemento secondario specificato.
removeFromParent()FooterSectionRimuove l'elemento da quello principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAttributes(attributes)FooterSectionConsente di impostare gli attributi dell'elemento.
setText(text)FooterSectionImposta i contenuti come testo normale.
setTextAlignment(textAlignment)FooterSectionImposta l'allineamento del testo.

Documentazione dettagliata

appendHorizontalRule()

Crea e aggiunge un nuovo HorizontalRule.

HorizontalRule sarà contenuto in un nuovo Paragraph.

Invio

HorizontalRule: la nuova regola orizzontale.

Autorizzazione

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

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

appendImage(image)

Crea e aggiunge un nuovo InlineImage dal blob dell'immagine specificato.

L'immagine sarà contenuta in un nuovo Paragraph.

Parametri

NomeTipoDescrizione
imageBlobSourceI dati dell'immagine.

Invio

InlineImage: 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)

Aggiungi il valore InlineImage specificato.

InlineImage sarà contenuto in un nuovo Paragraph.

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

Parametri

NomeTipoDescrizione
imageInlineImageI dati dell'immagine.

Invio

InlineImage: 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)

Aggiungi il valore ListItem specificato.

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

Parametri

NomeTipoDescrizione
listItemListItemLa voce dell'elenco da aggiungere.

Invio

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

Gli elementi 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)

Aggiungi il valore Paragraph specificato.

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

Parametri

NomeTipoDescrizione
paragraphParagraphIl paragrafo da aggiungere.

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 può 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 può terminare con una tabella.

Parametri

NomeTipoDescrizione
cellsString[][]I contenuti testuali delle celle della tabella da aggiungere alla nuova tabella.

Invio

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)

Aggiungi il valore Table specificato.

Usa 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 può terminare con una tabella.

Parametri

NomeTipoDescrizione
tableTableLa tabella da aggiungere.

Invio

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

Cancella i contenuti dell'elemento.

Invio

FooterSection: l'elemento corrente.


copy()

Restituisce una copia diretta scollegata dell'elemento corrente.

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

Invio

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

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

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

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

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

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

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

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

Parametri

NomeTipoDescrizione
searchPatternStringil pattern da cercare

Invio

RangeElement: un risultato di ricerca che indica la posizione del testo di ricerca o nullo in caso contrario compensare

Autorizzazione

Gli script che utilizzano questo 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 i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.

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

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

Parametri

NomeTipoDescrizione
searchPatternStringil pattern da cercare
fromRangeElementil risultato di ricerca da cui eseguire la ricerca

Invio

RangeElement: un risultato di ricerca che indica la posizione successiva del testo di ricerca o nullo se non è presente compensare

Autorizzazione

Gli script che utilizzano questo 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 di elemento valido in cui nome della proprietà corrisponde a un elemento nell'enumerazione DocumentApp.Attribute.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.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]);
}

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

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

// Obtain the first element in the tab.
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.

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

Parametri

NomeTipoDescrizione
childElementL'elemento figlio per il quale 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 valori InlineImages contenuti nella sezione.

Invio

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

Invio

ListItem[]: le voci dell'elenco delle sezioni.

Autorizzazione

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

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

getNumChildren()

Recupera il numero di elementi figlio.

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

Ottiene 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 o null se il testo contiene più tipi di testo 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 il valore ElementType dell'elemento.

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

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

// Obtain the first element in the active tab's 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.');
}

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.

HorizontalRule sarà contenuto in un nuovo Paragraph.

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice in cui inserire l'elemento.

Invio

HorizontalRule: la nuova regola orizzontale.

Autorizzazione

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

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

insertImage(childIndex, image)

Crea e inserisce un InlineImage dal blob dell'immagine specificato, nel punto specificato indice.

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice in cui inserire l'elemento.
imageBlobSourceI dati dell'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 inserire l'elemento.
listItemListItemLa voce 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 il valore specificato contenuti testuali.

Parametri

NomeTipoDescrizione
childIndexIntegerL'indice in cui inserire l'elemento.
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 inserire l'elemento.
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 il valore specificato contenuti testuali.

Parametri

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

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 inserire l'elemento.
cellsString[][]I contenuti testuali 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 inserire l'elemento.
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 secondario specificato.

Parametri

NomeTipoDescrizione
childElementL'elemento secondario da rimuovere.

Invio

FooterSection: 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 da quello principale.

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

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

Invio

FooterSection: l'elemento rimosso.

Autorizzazione

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

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

replaceText(searchPattern, replacement)

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

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

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

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

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

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

Parametri

NomeTipoDescrizione
searchPatternStringil pattern dell'espressione regolare per cercare
replacementStringil testo da utilizzare come sostituzione

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)

Consente di impostare gli attributi dell'elemento.

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

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

Invio

FooterSection: 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 sono stati cancellati.

Parametri

NomeTipoDescrizione
textStringI nuovi contenuti di testo.

Invio

FooterSection: 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.
var documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab();
var text = documentTab.getBody().getParagraphs()[0].editAsText();
text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);

Parametri

NomeTipoDescrizione
textAlignmentTextAlignmentil tipo di allineamento del testo da applicare

Invio

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