Un elemento generico che può contenere altri elementi. Tutti gli elementi che possono contenere elementi secondari, come Paragraph
, ereditano da Container
.
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
as | Body | Restituisce l'elemento corrente come Body . |
as | Equation | Restituisce l'elemento corrente come Equation . |
as | Footer | Restituisce l'elemento corrente come Footer . |
as | Footnote | Restituisce l'elemento corrente come Footnote . |
as | Header | Restituisce l'elemento corrente come Header . |
as | List | Restituisce l'elemento corrente come List . |
as | Paragraph | Restituisce l'elemento corrente come Paragraph . |
as | Table | Restituisce l'elemento corrente come Table . |
as | Table | Restituisce l'elemento corrente come Table . |
as | Table | Restituisce l'elemento corrente come Table . |
as | Table | Restituisce l'elemento corrente come Table . |
clear() | Container | Cancella i contenuti dell'elemento. |
copy() | Container | Restituisce una copia approfondita e scollegata dell'elemento corrente. |
edit | Text | Consente di ottenere una versione Text dell'elemento corrente da modificare. |
find | Range | Cerca nei contenuti dell'elemento un discendente del tipo specificato. |
find | Range | Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal Range specificato. |
find | Range | Cerca, nei contenuti dell'elemento, il pattern di testo specificato utilizzando le espressioni regolari. |
find | Range | Cerca il pattern di testo specificato nei contenuti dell'elemento, a partire da un determinato risultato di ricerca. |
get | Object | Recupera gli attributi dell'elemento. |
get | Element | Recupera l'elemento figlio all'indice figlio specificato. |
get | Integer | Recupera l'indice dell'elemento secondario per l'elemento secondario specificato. |
get | String | Recupera l'URL del link. |
get | Element | Recupera l'elemento successivo associato all'elemento. |
get | Integer | Recupera il numero di bambini. |
get | Container | Recupera l'elemento principale dell'elemento. |
get | Element | Recupera l'elemento precedente associato all'elemento. |
get | String | Recupera i contenuti dell'elemento come stringa di testo. |
get | Text | Restituisce l'allineamento del testo. |
get | Element | Recupera il Element dell'elemento. |
is | Boolean | Determina se l'elemento è alla fine del Document . |
merge() | Container | Unisce l'elemento all'elemento precedente dello stesso tipo. |
remove | Container | Rimuove l'elemento dal relativo elemento principale. |
replace | Element | Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa di sostituzione, utilizzando espressioni regolari. |
set | Container | Imposta gli attributi dell'elemento. |
set | Container | Imposta l'URL del link. |
set | Container | Imposta l'allineamento del testo. |
Documentazione dettagliata
as Body()
Restituisce l'elemento corrente come Body
.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Body
: l'elemento corrente.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
as Equation()
Restituisce l'elemento corrente come Equation
.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Equation
: 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
as Footnote Section()
Restituisce l'elemento corrente come Footnote
.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Footnote
: 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
as Header Section()
Restituisce l'elemento corrente come Header
.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Header
: 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
as List Item()
Restituisce l'elemento corrente come List
.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
List
: 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
as Paragraph()
Restituisce l'elemento corrente come Paragraph
.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Paragraph
: 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
as Table()
Restituisce l'elemento corrente come Table
.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Table
: 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
as Table Cell()
Restituisce l'elemento corrente come Table
.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Table
: 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
as Table Of Contents()
Restituisce l'elemento corrente come Table
.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Table
: 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
as Table Row()
Restituisce l'elemento corrente come Table
.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Table
: 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
clear()
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
Container
: 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
edit As Text()
Consente di ottenere una versione Text
dell'elemento corrente da modificare.
Utilizza edit
per manipolare i contenuti degli elementi come testo avanzato. La modalità edit
ignora gli elementi non di testo (come Inline
e Horizontal
).
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
find Element(elementType)
Cerca nei contenuti dell'elemento un discendente del tipo specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
element | Element | Il tipo di elemento da cercare. |
Invio
Range
: 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
find Element(elementType, from)
Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal Range
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
Nome | Tipo | Descrizione |
---|---|---|
element | Element | Il tipo di elemento da cercare. |
from | Range | Il risultato di ricerca da cui effettuare la ricerca. |
Invio
Range
: 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
find Text(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
Nome | Tipo | Descrizione |
---|---|---|
search | String | lo schema da cercare |
Invio
Range
: 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
find Text(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
Nome | Tipo | Descrizione |
---|---|---|
search | String | lo schema da cercare |
from | Range | il risultato di ricerca da cui effettuare la ricerca |
Invio
Range
: 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
get Attributes()
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 Document
.
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
get Child(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
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | L'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
get ChildIndex(child)
Recupera l'indice dell'elemento secondario per l'elemento secondario specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Element | L'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
get Link Url()
Recupera l'URL del link.
Invio
String
: l'URL del link o null se l'elemento contiene più valori per questo attributo
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
get Next Sibling()
Recupera l'elemento successivo associato all'elemento.
L'elemento successivo ha lo stesso elemento principale e segue l'elemento corrente.
Invio
Element
: l'elemento successivo associato.
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
get Num Children()
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
get Parent()
Recupera l'elemento principale dell'elemento.
L'elemento principale contiene l'elemento corrente.
Invio
Container
: 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
get Previous Sibling()
Recupera l'elemento precedente associato all'elemento.
L'elemento precedente associato ha lo stesso elemento principale e precede l'elemento corrente.
Invio
Element
: l'elemento precedente associato.
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
get Text()
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
get Text Alignment()
Restituisce l'allineamento del testo. I tipi di allineamento disponibili sono Document
, Document
e Document
.
Invio
Text
: 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
get Type()
Recupera il Element
dell'elemento.
Utilizza get
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
Element
: 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
is At Document End()
Determina se l'elemento è alla fine del Document
.
Invio
Boolean
: indica se l'elemento si trova alla fine della scheda.
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
merge()
Unisce l'elemento all'elemento precedente dello stesso tipo.
È possibile unire solo elementi dello stesso Element
. Tutti gli elementi secondari contenuti nell'elemento corrente vengono spostati nell'elemento precedente associato.
L'elemento corrente viene rimosso dal documento.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. const par1 = body.appendParagraph('Paragraph 1.'); const par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. const cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'], ]; // Build a table from the array. const table = body.appendTable(cells); // Get the first row in the table. const row = table.getRow(0); // Get the two cells in this row. const cell1 = row.getCell(0); const cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. const merged = cell2.merge();
Invio
Container
: l'elemento unito.
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
remove From Parent()
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
Container
: 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
replace Text(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
Nome | Tipo | Descrizione |
---|---|---|
search | String | lo schema regex da cercare |
replacement | String | Il 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
set Attributes(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 Document
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
Nome | Tipo | Descrizione |
---|---|---|
attributes | Object | Gli attributi dell'elemento. |
Invio
Container
: 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
set Link Url(url)
Imposta l'URL del link.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
url | String | l'URL del link |
Invio
Container
: 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
set Text Alignment(textAlignment)
Imposta l'allineamento del testo. I tipi di allineamento disponibili sono Document
, Document
e Document
.
// 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
Nome | Tipo | Descrizione |
---|---|---|
text | Text | il tipo di allineamento del testo da applicare |
Invio
Container
: 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