Interface Element

Elemento

Un elemento generico. Document contenuto è rappresentati come elementi. Ad esempio, ListItem, Paragraph e Table sono ed ereditare tutti i metodi definiti da Element, ad esempio getType().

Classi di implementazione

NomeBreve descrizione
BodyI contenuti di una scheda in un documento di Documenti Google.
ContainerElementUn elemento generico che può contenere altri elementi.
DateUn elemento che rappresenta una data formattata
EquationElemento che rappresenta un'espressione matematica.
EquationFunctionUn elemento che rappresenta una funzione in un Equation matematico.
EquationFunctionArgumentSeparatorUn elemento che rappresenta un separatore di funzione in un elemento matematico Equation.
EquationSymbolUn elemento che rappresenta un simbolo in un Equation matematico.
FooterSectionUn elemento che rappresenta una sezione a piè di pagina.
FootnoteUn elemento che rappresenta una nota a piè di pagina.
FootnoteSectionUn elemento che rappresenta una sezione di nota a piè di pagina.
HeaderSectionUn elemento che rappresenta una sezione di intestazione.
HorizontalRuleElemento che rappresenta una regola orizzontale.
InlineDrawingUn elemento che rappresenta un disegno incorporato.
InlineImageUn elemento che rappresenta un'immagine incorporata.
ListItemUn elemento che rappresenta un elemento dell'elenco.
PageBreakUn elemento che rappresenta un'interruzione di pagina.
ParagraphUn elemento che rappresenta un paragrafo.
PersonUn elemento che rappresenta un link a una persona.
RichLinkUn elemento che rappresenta un link a una risorsa Google, ad esempio un file di Drive o un video di YouTube.
TableUn elemento che rappresenta una tabella.
TableCellUn elemento che rappresenta una cella di tabella.
TableOfContentsUn elemento contenente un sommario.
TableRowUn elemento che rappresenta una riga di tabella.
TextUn elemento che rappresenta una regione RTF.
UnsupportedElementUn elemento che rappresenta una regione sconosciuta o che non può essere interessata da uno script, ad esempio un numero di pagina.

Metodi

MetodoTipo restituitoBreve descrizione
asBody()BodyRestituisce l'elemento corrente come Body.
asDate()DateRestituisce l'elemento corrente come Date.
asEquation()EquationRestituisce l'elemento corrente come Equation.
asEquationFunction()EquationFunctionRestituisce l'elemento corrente come EquationFunction.
asEquationFunctionArgumentSeparator()EquationFunctionArgumentSeparatorRestituisce l'elemento corrente come EquationFunctionArgumentSeparator.
asEquationSymbol()EquationSymbolRestituisce l'elemento corrente come EquationSymbol.
asFooterSection()FooterSectionRestituisce l'elemento corrente come FooterSection.
asFootnote()FootnoteRestituisce l'elemento corrente come Footnote.
asFootnoteSection()FootnoteSectionRestituisce l'elemento corrente come FootnoteSection.
asHeaderSection()HeaderSectionRestituisce l'elemento corrente come HeaderSection.
asHorizontalRule()HorizontalRuleRestituisce l'elemento corrente come HorizontalRule.
asInlineDrawing()InlineDrawingRestituisce l'elemento corrente come InlineDrawing.
asInlineImage()InlineImageRestituisce l'elemento corrente come InlineImage.
asListItem()ListItemRestituisce l'elemento corrente come ListItem.
asPageBreak()PageBreakRestituisce l'elemento corrente come PageBreak.
asParagraph()ParagraphRestituisce l'elemento corrente come Paragraph.
asPerson()PersonRestituisce l'elemento corrente come Person.
asRichLink()RichLinkRestituisce l'elemento corrente come RichLink, ad esempio un link a un file di Fogli Google.
asTable()TableRestituisce l'elemento corrente come Table.
asTableCell()TableCellRestituisce l'elemento corrente come TableCell.
asTableOfContents()TableOfContentsRestituisce l'elemento corrente come TableOfContents.
asTableRow()TableRowRestituisce l'elemento corrente come TableRow.
asText()TextRestituisce l'elemento corrente come Text.
copy()ElementRestituisce una copia diretta scollegata dell'elemento corrente.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
merge()ElementUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()ElementRimuove l'elemento da quello principale.
setAttributes(attributes)ElementConsente di impostare gli attributi dell'elemento.

Documentazione dettagliata

asBody()

Restituisce l'elemento corrente come Body.

Utilizza questo metodo per favorire il completamento automatico ogni volta che un determinato elemento è noto per essere di una specifica di testo.

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

asDate()

Restituisce l'elemento corrente come Date.

Quando sai che un elemento è un Date, utilizza questo metodo per impostare il tipo come Date. In questo modo, il completamento automatico nell'editor di Apps Script ti 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

asEquation()

Restituisce l'elemento corrente come Equation.

Utilizza questo metodo per favorire il completamento automatico ogni volta che un determinato elemento è noto per essere di una specifica di testo.

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

asEquationFunction()

Restituisce l'elemento corrente come EquationFunction.

Utilizza questo metodo per favorire il completamento automatico ogni volta che un determinato elemento è noto per essere di una specifica di testo.

Invio

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 un determinato elemento è noto per essere di una specifica di testo.

Invio

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 un determinato elemento è noto per essere di una specifica di testo.

Invio

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

asFooterSection()

Restituisce l'elemento corrente come FooterSection.

Utilizza questo metodo per favorire il completamento automatico ogni volta che un determinato elemento è noto per essere di una specifica di testo.

Invio

FooterSection: 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 un determinato elemento è noto per essere di una specifica di testo.

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

asFootnoteSection()

Restituisce l'elemento corrente come FootnoteSection.

Utilizza questo metodo per favorire il completamento automatico ogni volta che un determinato elemento è noto per essere di una specifica 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

asHeaderSection()

Restituisce l'elemento corrente come HeaderSection.

Utilizza questo metodo per favorire il completamento automatico ogni volta che un determinato elemento è noto per essere di una specifica di testo.

Invio

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 un determinato elemento è noto per essere di una specifica di testo.

Invio

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 un determinato elemento è noto per essere di una specifica di testo.

Invio

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 un determinato elemento è noto per essere di una specifica di testo.

Invio

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 un determinato elemento è noto per essere di una specifica di testo.

Invio

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 un determinato elemento è noto per essere di una specifica di testo.

Invio

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 un determinato elemento è noto per essere di una specifica di testo.

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

asPerson()

Restituisce l'elemento corrente come Person.

Quando sai che un elemento è un Person, usa questo metodo per impostare il tipo come persona. In questo modo il completamento automatico nell'editor di Apps Script mostra i metodi che puoi utilizzare con una persona.

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

Restituisce l'elemento corrente come RichLink, ad esempio un link a un file di Fogli Google.

Quando sai che un elemento è un RichLink, utilizza questo metodo per impostare il tipo come RichLink. In questo modo, il completamento automatico nell'editor di Apps Script ti mostra i metodi che puoi usare con un RichLink.

Invio

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 un determinato elemento è noto per essere di una specifica di testo.

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

asTableCell()

Restituisce l'elemento corrente come TableCell.

Utilizza questo metodo per favorire il completamento automatico ogni volta che un determinato elemento è noto per essere di una specifica di testo.

Invio

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 un determinato elemento è noto per essere di una specifica di testo.

Invio

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 un determinato elemento è noto per essere di una specifica di testo.

Invio

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 un determinato elemento è noto per essere di una specifica di testo.

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 diretta scollegata dell'elemento corrente.

Vengono copiati anche tutti gli elementi secondari presenti nell'elemento. Il nuovo elemento non ha principale.

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

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

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

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

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

isAtDocumentEnd()

Determina se l'elemento si trova alla fine di Document.

Invio

Boolean: 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 con l'elemento di pari livello precedente dello stesso tipo.

È possibile unire solo elementi dello stesso elemento ElementType. Qualsiasi elemento secondario contenuto in gli elementi correnti vengono spostati all'elemento di pari livello precedente.

L'elemento corrente viene rimosso dal documento.

var doc = DocumentApp.getActiveDocument();
var documentTab = doc.getActiveTab().asDocumentTab();
var body = documentTab.getBody();

// Example 1: Merge paragraphs
// Append two paragraphs to the document's active tab.
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();

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

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

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)

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

NomeTipoDescrizione
attributesObjectGli 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