Class FootnoteSection

FootnoteSection

Un elemento che rappresenta una sezione di una nota a piè di pagina. Un elemento FootnoteSection contiene il testo che corrisponde a un Footnote. FootnoteSection può contenere elementi ListItem o Paragraph. Per ulteriori informazioni sulla struttura dei documenti, consulta la guida all'estensione di Documenti Google.

Metodi

MetodoTipo restituitoBreve descrizione
appendParagraph(paragraph)ParagraphAccoda il valore Paragraph specificato.
appendParagraph(text)ParagraphCrea e aggiunge un nuovo Paragraph con i contenuti di testo specificati.
clear()FootnoteSectionConsente di cancellare i contenuti dell'elemento.
copy()FootnoteSectionRestituisce 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.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getNumChildren()IntegerRecupera il numero di bambini.
getParagraphs()Paragraph[]Recupera tutti i Paragraphs contenuti nella sezione (incluso ListItems).
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
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.
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.
removeChild(child)FootnoteSectionRimuove l'elemento secondario specificato.
removeFromParent()FootnoteSectionRimuove l'elemento dal relativo elemento principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando le espressioni regolari.
setAttributes(attributes)FootnoteSectionImposta gli attributi dell'elemento.
setText(text)FootnoteSectionImposta i contenuti come testo normale.
setTextAlignment(textAlignment)FootnoteSectionImposta l'allineamento del testo.

Documentazione dettagliata

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

clear()

Consente di cancellare i contenuti dell'elemento.

Ritorni

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

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

getNextSibling()

Recupera l'elemento di pari livello successivo dell'elemento.

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

Ritorni

Element: l'elemento di pari livello successivo.

Autorizzazione

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

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

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

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

getPreviousSibling()

Recupera l'elemento di pari livello precedente dell'elemento.

L'elemento di pari livello precedente ha lo stesso elemento principale e precede l'elemento corrente.

Ritorni

Element: l'elemento di pari livello precedente.

Autorizzazione

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

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

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

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

removeChild(child)

Rimuove l'elemento secondario specificato.

Parametri

NomeTipoDescrizione
childElementl'elemento secondario da rimuovere

Ritorni

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

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

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

Ritorni

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

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

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

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