Un elemento generico. I contenuti di Document sono rappresentati come elementi. Ad esempio, List, Paragraph e Table sono elementi e ereditano tutti i metodi definiti da Element, come get.
Implementazione di classi
| Nome | Breve descrizione |
|---|---|
Body | I contenuti di una scheda in un documento di Documenti Google. |
Container | Un elemento generico che può contenere altri elementi. |
Date | Un elemento che rappresenta una data formattata |
Equation | Un elemento che rappresenta un'espressione matematica. |
Equation | Un elemento che rappresenta una funzione in un Equation matematico. |
Equation | Un elemento che rappresenta un separatore di funzioni in un Equation matematico. |
Equation | Un elemento che rappresenta un simbolo in un Equation matematico. |
Footer | Un elemento che rappresenta una sezione del piè di pagina. |
Footnote | Un elemento che rappresenta una nota a piè di pagina. |
Footnote | Un elemento che rappresenta una sezione di note a piè di pagina. |
Header | Un elemento che rappresenta una sezione di intestazione. |
Horizontal | Un elemento che rappresenta una linea orizzontale. |
Inline | Un elemento che rappresenta un disegno incorporato. |
Inline | Un elemento che rappresenta un'immagine incorporata. |
List | Un elemento che rappresenta un elemento dell'elenco. |
Page | Un elemento che rappresenta un'interruzione di pagina. |
Paragraph | Un elemento che rappresenta un paragrafo. |
Person | Un elemento che rappresenta un link a una persona. |
Rich | Un elemento che rappresenta un link a una risorsa Google, ad esempio un file di Drive o un video di YouTube. |
Table | Un elemento che rappresenta una tabella. |
Table | Un elemento che rappresenta una cella di tabella. |
Table | Un elemento contenente un sommario. |
Table | Un elemento che rappresenta una riga di una tabella. |
Text | Un elemento che rappresenta una regione di testo avanzato. |
Unsupported | Un elemento che rappresenta una regione sconosciuta o che non può essere interessata da uno script, ad esempio un numero di pagina. |
Metodi
| Metodo | Tipo restituito | Breve descrizione |
|---|---|---|
as | Body | Restituisce l'elemento corrente come Body. |
as | Date | Restituisce l'elemento corrente come Date. |
as | Equation | Restituisce l'elemento corrente come Equation. |
as | Equation | Restituisce l'elemento corrente come Equation. |
as | Equation | Restituisce l'elemento corrente come Equation. |
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 | Footnote | Restituisce l'elemento corrente come Footnote. |
as | Header | Restituisce l'elemento corrente come Header. |
as | Horizontal | Restituisce l'elemento corrente come Horizontal. |
as | Inline | Restituisce l'elemento corrente come Inline. |
as | Inline | Restituisce l'elemento corrente come Inline. |
as | List | Restituisce l'elemento corrente come List. |
as | Page | Restituisce l'elemento corrente come Page. |
as | Paragraph | Restituisce l'elemento corrente come Paragraph. |
as | Person | Restituisce l'elemento corrente come Person. |
as | Rich | Restituisce l'elemento corrente come Rich, ad esempio un link a un file di Fogli Google. |
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. |
as | Text | Restituisce l'elemento corrente come Text. |
copy() | Element | Restituisce una copia approfondita e scollegata dell'elemento corrente. |
get | Object | Recupera gli attributi dell'elemento. |
get | Element | Recupera l'elemento successivo associato all'elemento. |
get | Container | Recupera l'elemento principale dell'elemento. |
get | Element | Recupera l'elemento precedente associato all'elemento. |
get | Element | Recupera il Element dell'elemento. |
is | Boolean | Determina se l'elemento è alla fine del Document. |
merge() | Element | Unisce l'elemento all'elemento precedente dello stesso tipo. |
remove | Element | Rimuove l'elemento dal relativo elemento principale. |
set | Element | Imposta gli attributi dell'elemento. |
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 Date()
Restituisce l'elemento corrente come Date.
Quando sai che un elemento è un Date, utilizza questo metodo per impostarne il tipo come Date. In questo modo, il completamento automatico nell'editor di Apps Script mostra i metodi che puoi utilizzare con un Date.
Invio
Date: l'elemento corrente con il tipo impostato su Date.
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 Equation Function()
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 Equation Function Argument Separator()
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 Equation Symbol()
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()
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 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 Horizontal Rule()
Restituisce l'elemento corrente come Horizontal.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Horizontal: 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 Inline Drawing()
Restituisce l'elemento corrente come Inline.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Inline: 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 Inline Image()
Restituisce l'elemento corrente come Inline.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Inline: 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 Page Break()
Restituisce l'elemento corrente come Page.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Page: 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 Person()
Restituisce l'elemento corrente come Person.
Quando sai che un elemento è un Person, utilizza questo metodo per impostarne il tipo come persona.
In questo modo, il completamento automatico nell'editor di Apps Script mostra i metodi che puoi utilizzare con un elemento person.
Invio
Person: l'elemento corrente con il tipo impostato su Person.
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 Rich Link()
Restituisce l'elemento corrente come Rich, ad esempio un link a un file di Fogli Google.
Quando sai che un elemento è un Rich, utilizza questo metodo per impostarne il tipo come Rich. In questo modo, il completamento automatico nell'editor di Apps Script mostra i metodi che puoi utilizzare con un Rich.
Invio
Rich: l'elemento corrente con il tipo impostato su Rich.
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
as Text()
Restituisce l'elemento corrente come Text.
Utilizza questo metodo per facilitare il completamento automatico ogni volta che è noto che un determinato elemento appartiene a un tipo specifico.
Invio
Text: 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
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
Element: 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
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 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 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 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
Element: 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
Element: 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
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
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