Un elemento che rappresenta una sezione di nota a piè di pagina. Un elemento FootnoteSection
contiene il testo che
corrisponde a un Footnote
. FootnoteSection
può contenere ListItem
o
Paragraph
elementi. Per ulteriori informazioni sulla struttura dei documenti, consulta la guida all'estensione di Documenti Google.
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
appendParagraph(paragraph) | Paragraph | Aggiungi il valore Paragraph specificato. |
appendParagraph(text) | Paragraph | Crea e aggiunge un nuovo Paragraph contenente i contenuti di testo specificati. |
clear() | FootnoteSection | Cancella i contenuti dell'elemento. |
copy() | FootnoteSection | Restituisce una copia diretta scollegata dell'elemento corrente. |
editAsText() | Text | Consente di ottenere una versione Text dell'elemento corrente, da modificare. |
findElement(elementType) | RangeElement | Cerca nei contenuti dell'elemento un discendente del tipo specificato. |
findElement(elementType, from) | RangeElement | Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal
specificato RangeElement . |
findText(searchPattern) | RangeElement | Cerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari. |
findText(searchPattern, from) | RangeElement | Cerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca. |
getAttributes() | Object | Recupera gli attributi dell'elemento. |
getChild(childIndex) | Element | Recupera l'elemento figlio nell'indice figlio specificato. |
getChildIndex(child) | Integer | Recupera l'indice figlio per l'elemento figlio specificato. |
getNextSibling() | Element | Recupera l'elemento di pari livello successivo dell'elemento. |
getNumChildren() | Integer | Recupera il numero di elementi figlio. |
getParagraphs() | Paragraph[] | Recupera tutti i valori Paragraphs contenuti nella sezione (incluso ListItems ). |
getParent() | ContainerElement | Recupera l'elemento principale dell'elemento. |
getPreviousSibling() | Element | Recupera l'elemento di pari livello precedente dell'elemento. |
getText() | String | Recupera i contenuti dell'elemento come stringa di testo. |
getTextAlignment() | TextAlignment | Ottiene l'allineamento del testo. |
getType() | ElementType | Recupera il valore ElementType dell'elemento. |
insertParagraph(childIndex, paragraph) | Paragraph | Inserisce il valore Paragraph specificato nell'indice specificato. |
insertParagraph(childIndex, text) | Paragraph | Crea e inserisce un nuovo Paragraph nell'indice specificato, contenente il valore specificato
contenuti testuali. |
removeChild(child) | FootnoteSection | Rimuove l'elemento secondario specificato. |
removeFromParent() | FootnoteSection | Rimuove l'elemento da quello principale. |
replaceText(searchPattern, replacement) | Element | Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari. |
setAttributes(attributes) | FootnoteSection | Consente di impostare gli attributi dell'elemento. |
setText(text) | FootnoteSection | Imposta i contenuti come testo normale. |
setTextAlignment(textAlignment) | FootnoteSection | Imposta l'allineamento del testo. |
Documentazione dettagliata
appendParagraph(paragraph)
Aggiungi il valore Paragraph
specificato.
Usa questa versione di appendParagraph
quando aggiungi una copia di un Paragraph
esistente.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
paragraph | Paragraph | Il 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
Nome | Tipo | Descrizione |
---|---|---|
text | String | I contenuti di testo del paragrafo. |
Invio
Paragraph
: il nuovo paragrafo.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
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
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, 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
Nome | Tipo | Descrizione |
---|---|---|
elementType | ElementType | Il 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
Nome | Tipo | Descrizione |
---|---|---|
elementType | ElementType | Il tipo di elemento da cercare. |
from | RangeElement | Il 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
Nome | Tipo | Descrizione |
---|---|---|
searchPattern | String | il 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
Nome | Tipo | Descrizione |
---|---|---|
searchPattern | String | il pattern da cercare |
from | RangeElement | il 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
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'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
Nome | Tipo | Descrizione |
---|---|---|
child | Element | L'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
getNextSibling()
Recupera l'elemento di pari livello successivo dell'elemento.
L'altro elemento di pari livello ha lo stesso elemento principale e segue l'elemento corrente.
Invio
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 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
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.
Invio
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.
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
insertParagraph(childIndex, paragraph)
Inserisce il valore Paragraph
specificato nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
paragraph | Paragraph | Il paragrafo da inserire. |
Invio
Paragraph
- Il paragrafo inserito.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertParagraph(childIndex, text)
Crea e inserisce un nuovo Paragraph
nell'indice specificato, contenente il valore specificato
contenuti testuali.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | L'indice in cui inserire l'elemento. |
text | String | I contenuti di testo del paragrafo. |
Invio
Paragraph
: il nuovo paragrafo.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
Rimuove l'elemento secondario specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Element | L'elemento secondario da rimuovere. |
Invio
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 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
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 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
Nome | Tipo | Descrizione |
---|---|---|
searchPattern | String | il pattern dell'espressione regolare per cercare |
replacement | String | il 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
Nome | Tipo | Descrizione |
---|---|---|
attributes | Object | Gli attributi dell'elemento. |
Invio
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 sono stati cancellati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | I nuovi contenuti di testo. |
Invio
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 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
Nome | Tipo | Descrizione |
---|---|---|
textAlignment | TextAlignment | il tipo di allineamento del testo da applicare |
Invio
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