Un elemento generico. I contenuti Document
sono
rappresentati come elementi. Ad esempio, ListItem
, Paragraph
e Table
sono
elementi ed ereditano tutti i metodi definiti da Element
, come getType()
.
Implementare le classi
Nome | Breve descrizione |
---|---|
Body | Un elemento che rappresenta il corpo di un documento. |
ContainerElement | Un elemento generico che può contenere altri elementi. |
Date | Un elemento che rappresenta una data formattata |
Equation | Un elemento che rappresenta un'espressione matematica. |
EquationFunction | Un elemento che rappresenta una funzione in un elemento matematico Equation . |
EquationFunctionArgumentSeparator | Un elemento che rappresenta un separatore di funzione in un elemento matematico Equation . |
EquationSymbol | Un elemento che rappresenta un simbolo in un elemento matematico Equation . |
FooterSection | Un elemento che rappresenta una sezione del piè di pagina. |
Footnote | Un elemento che rappresenta una nota a piè di pagina. |
FootnoteSection | Un elemento che rappresenta una sezione di una nota a piè di pagina. |
HeaderSection | Un elemento che rappresenta una sezione di intestazione. |
HorizontalRule | Un elemento che rappresenta una riga orizzontale. |
InlineDrawing | Un elemento che rappresenta un disegno incorporato. |
InlineImage | Un elemento che rappresenta un'immagine incorporata. |
ListItem | Un elemento che rappresenta un elemento dell'elenco. |
PageBreak | 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. |
RichLink | 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. |
TableCell | Un elemento che rappresenta una cella di tabella. |
TableOfContents | Un elemento che contiene un sommario. |
TableRow | Un elemento che rappresenta una riga di una tabella. |
Text | Un elemento che rappresenta una regione RTF. |
UnsupportedElement | 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 |
---|---|---|
asBody() | Body | Restituisce l'elemento corrente come Body . |
asDate() | Date | Restituisce l'elemento corrente come Date . |
asEquation() | Equation | Restituisce l'elemento corrente come Equation . |
asEquationFunction() | EquationFunction | Restituisce l'elemento corrente come EquationFunction . |
asEquationFunctionArgumentSeparator() | EquationFunctionArgumentSeparator | Restituisce l'elemento corrente come EquationFunctionArgumentSeparator . |
asEquationSymbol() | EquationSymbol | Restituisce l'elemento corrente come EquationSymbol . |
asFooterSection() | FooterSection | Restituisce l'elemento corrente come FooterSection . |
asFootnote() | Footnote | Restituisce l'elemento corrente come Footnote . |
asFootnoteSection() | FootnoteSection | Restituisce l'elemento corrente come FootnoteSection . |
asHeaderSection() | HeaderSection | Restituisce l'elemento corrente come HeaderSection . |
asHorizontalRule() | HorizontalRule | Restituisce l'elemento corrente come HorizontalRule . |
asInlineDrawing() | InlineDrawing | Restituisce l'elemento corrente come InlineDrawing . |
asInlineImage() | InlineImage | Restituisce l'elemento corrente come InlineImage . |
asListItem() | ListItem | Restituisce l'elemento corrente come ListItem . |
asPageBreak() | PageBreak | Restituisce l'elemento corrente come PageBreak . |
asParagraph() | Paragraph | Restituisce l'elemento corrente come Paragraph . |
asPerson() | Person | Restituisce l'elemento corrente come Person . |
asRichLink() | RichLink | Restituisce l'elemento corrente come RichLink , ad esempio un link a un file di Fogli Google. |
asTable() | Table | Restituisce l'elemento corrente come Table . |
asTableCell() | TableCell | Restituisce l'elemento corrente come TableCell . |
asTableOfContents() | TableOfContents | Restituisce l'elemento corrente come TableOfContents . |
asTableRow() | TableRow | Restituisce l'elemento corrente come TableRow . |
asText() | Text | Restituisce l'elemento corrente come Text . |
copy() | Element | Restituisce una copia separata e approfondita dell'elemento corrente. |
getAttributes() | Object | Recupera gli attributi dell'elemento. |
getNextSibling() | Element | Recupera l'elemento di pari livello successivo dell'elemento. |
getParent() | ContainerElement | Recupera l'elemento principale dell'elemento. |
getPreviousSibling() | Element | Recupera l'elemento di pari livello precedente dell'elemento. |
getType() | ElementType | Recupera l'elemento ElementType dell'elemento. |
isAtDocumentEnd() | Boolean | Determina se l'elemento si trova alla fine di Document . |
merge() | Element | Unisce l'elemento con l'elemento di pari livello precedente dello stesso tipo. |
removeFromParent() | Element | Rimuove l'elemento dal relativo elemento principale. |
setAttributes(attributes) | Element | Imposta gli attributi dell'elemento. |
Documentazione dettagliata
asBody()
Restituisce l'elemento corrente come Body
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
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
asDate()
Restituisce l'elemento corrente come Date
.
Quando sai che un elemento è Date
, utilizza questo metodo per impostarne il tipo come Date
. In questo modo il completamento automatico nell'editor di Apps Script ti mostra i metodi che puoi utilizzare
con un elemento Date
.
Ritorni
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
asEquation()
Restituisce l'elemento corrente come Equation
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
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
asEquationFunction()
Restituisce l'elemento corrente come EquationFunction
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
EquationFunction
: 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
asEquationFunctionArgumentSeparator()
Restituisce l'elemento corrente come EquationFunctionArgumentSeparator
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
EquationFunctionArgumentSeparator
: 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
asEquationSymbol()
Restituisce l'elemento corrente come EquationSymbol
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
EquationSymbol
: 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
asFootnote()
Restituisce l'elemento corrente come Footnote
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
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
asFootnoteSection()
Restituisce l'elemento corrente come FootnoteSection
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
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
asHeaderSection()
Restituisce l'elemento corrente come HeaderSection
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
HeaderSection
: 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
asHorizontalRule()
Restituisce l'elemento corrente come HorizontalRule
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
HorizontalRule
: 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
asInlineDrawing()
Restituisce l'elemento corrente come InlineDrawing
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
InlineDrawing
: 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
asInlineImage()
Restituisce l'elemento corrente come InlineImage
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
InlineImage
: 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
asListItem()
Restituisce l'elemento corrente come ListItem
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
ListItem
: 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
asPageBreak()
Restituisce l'elemento corrente come PageBreak
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
PageBreak
: 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
asParagraph()
Restituisce l'elemento corrente come Paragraph
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
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
asPerson()
Restituisce l'elemento corrente come Person
.
Quando sai che un elemento è Person
, utilizza questo metodo per impostarne il tipo come persona.
In questo modo il completamento automatico nell'editor di Apps Script ti mostra i metodi che puoi utilizzare con un
elemento persona.
Ritorni
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
asRichLink()
Restituisce l'elemento corrente come RichLink
, ad esempio un link a un file di Fogli Google.
Quando sai che un elemento è RichLink
, utilizza questo metodo per impostarne il tipo come RichLink
. In questo modo il completamento automatico nell'editor di Apps Script ti mostra i metodi che puoi
utilizzare con un RichLink
.
Ritorni
RichLink
: l'elemento corrente con il tipo impostato su RichLink
.
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
asTable()
Restituisce l'elemento corrente come Table
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
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
asTableCell()
Restituisce l'elemento corrente come TableCell
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
TableCell
: 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
asTableOfContents()
Restituisce l'elemento corrente come TableOfContents
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
TableOfContents
: 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
asTableRow()
Restituisce l'elemento corrente come TableRow
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
TableRow
: 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
asText()
Restituisce l'elemento corrente come Text
.
Utilizza questo metodo per favorire il completamento automatico ogni volta che è noto che un determinato elemento è di un tipo specifico.
Ritorni
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 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
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
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
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
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
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
isAtDocumentEnd()
Determina se l'elemento si trova alla fine di Document
.
Ritorni
Boolean
: indica se l'elemento si trova alla fine del documento.
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 con l'elemento di pari livello precedente dello stesso tipo.
È possibile unire solo gli elementi dello stesso ElementType
. Tutti gli elementi secondari contenuti nell'elemento corrente vengono spostati nell'elemento di pari livello precedente.
L'elemento corrente viene rimosso dal documento.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var 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. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Ritorni
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
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
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
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
Nome | Tipo | Descrizione |
---|---|---|
attributes | Object | Gli attributi dell'elemento. |
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