Interface Element

Elemento

Un elemento generico. I contenuti di Document sono rappresentati come elementi. Ad esempio, ListItem, Paragraph e Table sono elementi ed ereditano tutti i metodi definiti da Element, ad esempio getType().

Implementazione delle classi

NomeBreve descrizione
BodyI contenuti di una scheda in un documento Google.
ContainerElementUn elemento generico che può contenere altri elementi.
DateUn elemento che rappresenta una data formattata
EquationUn elemento che rappresenta un'espressione matematica.
EquationFunctionUn elemento che rappresenta una funzione in un Equation matematico.
EquationFunctionArgumentSeparatorUn elemento che rappresenta un separatore di funzioni in un'espressione matematica Equation.
EquationSymbolUn elemento che rappresenta un simbolo in un Equation matematico.
FooterSectionUn elemento che rappresenta una sezione del piè di pagina.
FootnoteUn elemento che rappresenta una nota a piè di pagina.
FootnoteSectionUn elemento che rappresenta una sezione di note a piè di pagina.
HeaderSectionUn elemento che rappresenta una sezione di intestazione.
HorizontalRuleUn elemento 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 di 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 della tabella.
TableOfContentsUn elemento contenente un sommario.
TableRowUn elemento che rappresenta una riga della tabella.
TextUn elemento che rappresenta una regione di testo 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 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 indipendente e completa dell'elemento corrente.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getNextSibling()Element|nullRecupera l'elemento successivo associato all'elemento.
getParent()ContainerElement|nullRecupera l'elemento principale dell'elemento.
getPreviousSibling()Element|nullRecupera l'elemento precedente associato all'elemento.
getType()ElementTypeRecupera ElementType dell'elemento.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
merge()Element|nullUnisce l'elemento al fratello precedente dello stesso tipo.
removeFromParent()Element|nullRimuove l'elemento dal relativo elemento principale.
setAttributes(attributes)ElementImposta gli attributi dell'elemento.

Documentazione dettagliata

asBody()

Restituisce l'elemento corrente come Body.

Utilizza questo metodo per facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 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.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 è una Person, utilizza questo metodo per impostarne il tipo come persona. In questo modo, il completamento automatico nell'editor di script di Apps Script mostra i metodi che puoi utilizzare con un elemento persona.

Indietro

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 Fogli Google.

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

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 facilitare il completamento automatico ogni volta che un determinato elemento è noto per essere di un tipo specifico.

Indietro

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 indipendente e completa dell'elemento corrente.

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

Indietro

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 dell'elemento valido, in cui ogni nome della proprietà corrisponde a un elemento nell'enumerazione DocumentApp.Attribute. 

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]}`);
}

Indietro

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 successivo associato all'elemento.

L'elemento successivo ha lo stesso elemento principale e segue l'elemento corrente.

Indietro

Element|null: l'elemento associato 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.

Indietro

ContainerElement|null: 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 precedente associato all'elemento.

L'elemento associato precedente ha lo stesso elemento principale e precede l'elemento corrente.

Indietro

Element|null: l'elemento associato 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 ElementType dell'elemento.

Utilizza getType() 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.');
}

Indietro

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.

Indietro

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 al fratello precedente dello stesso tipo.

È possibile unire solo elementi dello stesso ElementType. Tutti gli elementi secondari contenuti nell'elemento corrente vengono spostati nell'elemento fratello precedente.

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();

Indietro

Element|null: 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. 

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();
}

Indietro

Element|null: 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 di proprietà è un elemento dell'enumerazione DocumentApp.Attribute e ogni valore di 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

NomeTipoDescrizione
attributesObjectGli attributi dell'elemento.

Indietro

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