Document Service

Documento

Questo servizio consente agli script di creare, accedere e modificare i file di Documenti Google.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID');

// Create and open a document.
doc = DocumentApp.create('Document Name');

Corsi

NomeBreve descrizione
AttributeUn'enumerazione degli attributi dell'elemento.
BodyI contenuti di una scheda in un documento di Documenti Google.
BookmarkUn oggetto che rappresenta un segnalibro.
ContainerElementUn elemento generico che può contenere altri elementi.
DateUn elemento che rappresenta una data formattata
DocumentUn documento contenente uno o più oggetti Tab, ognuno dei quali contiene RTF come tabelle ed elenchi.
DocumentAppIl servizio documenti crea e apre Documents che può essere modificato.
DocumentTabUna scheda di un documento contenente testo in formato RTF ed elementi come tabelle ed elenchi.
ElementUn elemento generico.
ElementTypeUn'enumerazione di tutti i tipi di elementi.
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.
FontFamilyUn'enumerazione dei caratteri supportati.
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.
GlyphTypeUn'enumerazione dei tipi di glifi supportati.
HeaderSectionUn elemento che rappresenta una sezione di intestazione.
HorizontalAlignmentUn'enumerazione dei tipi di allineamento orizzontale supportati.
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.
NamedRangeUn elemento Range che abbia un nome e un ID per consentirne il recupero in un secondo momento.
PageBreakUn elemento che rappresenta un'interruzione di pagina.
ParagraphUn elemento che rappresenta un paragrafo.
ParagraphHeadingUn'enumerazione delle intestazioni di paragrafo standard.
PersonUn elemento che rappresenta un link a una persona.
PositionUn riferimento a una posizione nella scheda del documento rispetto a un elemento specifico.
PositionedImageImmagine con posizione fissa ancorata a Paragraph.
PositionedLayoutUn'enumerazione che specifica come disporre un PositionedImage in relazione all'ambiente circostante testo.
RangeUna serie di elementi in un documento.
RangeBuilderUn builder utilizzato per creare oggetti Range a partire da elementi di documenti.
RangeElementUn wrapper attorno a un Element con un possibile offset di inizio e fine.
RichLinkUn elemento che rappresenta un link a una risorsa Google, ad esempio un file di Drive o un video di YouTube.
TabUna scheda all'interno di un documento di Documenti Google.
TabTypeUn'enumerazione di tutti i tipi di schede.
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.
TextAlignmentUn'enumerazione del tipo di allineamenti del testo.
UnsupportedElementUn elemento che rappresenta una regione sconosciuta o che non può essere interessata da uno script, ad esempio un numero di pagina.
VerticalAlignmentUn'enumerazione dei tipi di allineamento verticale supportati.

Attribute

Proprietà

ProprietàTipoDescrizione
BACKGROUND_COLOREnumIl colore di sfondo di un elemento (paragrafo, tabella e così via) o documento.
BOLDEnumL'impostazione dello spessore del carattere per il formato RTF.
BORDER_COLOREnumIl colore del bordo per gli elementi della tabella.
BORDER_WIDTHEnumLa larghezza del bordo in punti per gli elementi della tabella.
CODEEnumContenuti del codice per gli elementi delle equazioni.
FONT_FAMILYEnumL'impostazione della famiglia di caratteri per il formato RTF.
FONT_SIZEEnumL'impostazione delle dimensioni del carattere in punti, per il formato RTF.
FOREGROUND_COLOREnumL'impostazione del colore in primo piano per il formato RTF.
HEADINGEnumIl tipo di intestazione per gli elementi paragrafo (ad esempio, DocumentApp.ParagraphHeading.HEADING1).
HEIGHTEnumL'impostazione dell'altezza per gli elementi dell'immagine.
HORIZONTAL_ALIGNMENTEnumL'allineamento orizzontale per gli elementi paragrafo (ad es. DocumentApp.HorizontalAlignment.CENTER).
INDENT_ENDEnumL'impostazione del rientro finale in punti per gli elementi paragrafo.
INDENT_FIRST_LINEEnumImpostazione del rientro della prima riga in punti per gli elementi paragrafo.
INDENT_STARTEnumImpostazione del rientro iniziale in punti per gli elementi paragrafo.
ITALICEnumL'impostazione dello stile del carattere per il formato RTF.
GLYPH_TYPEEnumIl tipo di glifo, per gli elementi degli elementi dell'elenco.
LEFT_TO_RIGHTEnumL'impostazione della direzione del testo per il formato RTF.
LINE_SPACINGEnumL'impostazione dell'interlinea come moltiplicatore, per gli elementi del paragrafo.
LINK_URLEnumL'URL del link per il formato RTF.
LIST_IDEnumL'ID dell'elenco completo per gli elementi elemento dell'elenco.
MARGIN_BOTTOMEnumImpostazione del margine inferiore in punti per gli elementi paragrafo.
MARGIN_LEFTEnumL'impostazione del margine sinistro in punti, per gli elementi paragrafo.
MARGIN_RIGHTEnumL'impostazione del margine destro in punti per gli elementi paragrafo.
MARGIN_TOPEnumImpostazione del margine superiore in punti per gli elementi paragrafo.
NESTING_LEVELEnumIl livello di nidificazione degli elementi per gli elementi degli elementi dell'elenco.
MINIMUM_HEIGHTEnumL'impostazione dell'altezza minima in punti per gli elementi di riga della tabella.
PADDING_BOTTOMEnumL'impostazione della spaziatura interna inferiore in punti per gli elementi delle celle della tabella.
PADDING_LEFTEnumL'impostazione della spaziatura interna sinistra in punti per gli elementi delle celle della tabella.
PADDING_RIGHTEnumL'impostazione della spaziatura interna destra in punti per gli elementi delle celle della tabella.
PADDING_TOPEnumL'impostazione della spaziatura interna superiore in punti per gli elementi delle celle della tabella.
PAGE_HEIGHTEnumL'impostazione dell'altezza della pagina in punti per i documenti.
PAGE_WIDTHEnumL'impostazione della larghezza della pagina in punti per i documenti.
SPACING_AFTEREnumL'impostazione della spaziatura in basso in punti per gli elementi paragrafo.
SPACING_BEFOREEnumL'impostazione di spaziatura in alto in punti per gli elementi paragrafo.
STRIKETHROUGHEnumImpostazione del barramento per il formato RTF.
UNDERLINEEnumL'impostazione per la sottolineatura per il formato RTF.
VERTICAL_ALIGNMENTEnumL'impostazione di allineamento verticale per gli elementi delle celle di tabella.
WIDTHEnumL'impostazione della larghezza per elementi di immagini e celle della tabella.

Body

Metodi

MetodoTipo restituitoBreve descrizione
appendHorizontalRule()HorizontalRuleCrea e aggiunge un nuovo HorizontalRule.
appendImage(image)InlineImageCrea e aggiunge un nuovo InlineImage dal blob dell'immagine specificato.
appendImage(image)InlineImageAggiungi il valore InlineImage specificato.
appendListItem(listItem)ListItemAggiungi il valore ListItem specificato.
appendListItem(text)ListItemCrea e aggiunge un nuovo ListItem contenente i contenuti di testo specificati.
appendPageBreak()PageBreakCrea e aggiunge un nuovo PageBreak.
appendPageBreak(pageBreak)PageBreakAggiungi il valore PageBreak specificato.
appendParagraph(paragraph)ParagraphAggiungi il valore Paragraph specificato.
appendParagraph(text)ParagraphCrea e aggiunge un nuovo Paragraph contenente i contenuti di testo specificati.
appendTable()TableCrea e aggiunge un nuovo Table.
appendTable(cells)TableAggiunge un nuovo Table contenente un TableCell per ogni valore di stringa specificato.
appendTable(table)TableAggiungi il valore Table specificato.
clear()BodyCancella i contenuti dell'elemento.
copy()BodyRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getHeadingAttributes(paragraphHeading)ObjectRecupera l'insieme di attributi per il valore ParagraphHeading fornito.
getImages()InlineImage[]Recupera tutti i valori InlineImages contenuti nella sezione.
getListItems()ListItem[]Recupera tutti i valori ListItems contenuti nella sezione.
getMarginBottom()NumberRecupera il margine inferiore, in punti.
getMarginLeft()NumberRecupera il margine sinistro, in punti.
getMarginRight()NumberRecupera il margine destro.
getMarginTop()NumberRecupera il margine superiore.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getPageHeight()NumberRecupera l'altezza della pagina, in punti.
getPageWidth()NumberRecupera la larghezza della pagina, in punti.
getParagraphs()Paragraph[]Recupera tutti i valori Paragraphs contenuti nella sezione (incluso ListItems).
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getTables()Table[]Recupera tutti i valori Tables contenuti nella sezione.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserisce un nuovo HorizontalRule nell'indice specificato.
insertImage(childIndex, image)InlineImageCrea e inserisce un InlineImage dal blob dell'immagine specificato, nel punto specificato indice.
insertImage(childIndex, image)InlineImageInserisce il valore InlineImage specificato nell'indice specificato.
insertListItem(childIndex, listItem)ListItemInserisce il valore ListItem specificato nell'indice specificato.
insertListItem(childIndex, text)ListItemCrea e inserisce un nuovo ListItem nell'indice specificato, contenente il valore specificato contenuti testuali.
insertPageBreak(childIndex)PageBreakCrea e inserisce un nuovo PageBreak nell'indice specificato.
insertPageBreak(childIndex, pageBreak)PageBreakInserisce il valore PageBreak specificato nell'indice specificato.
insertParagraph(childIndex, paragraph)ParagraphInserisce il valore Paragraph specificato nell'indice specificato.
insertParagraph(childIndex, text)ParagraphCrea e inserisce un nuovo Paragraph nell'indice specificato, contenente il valore specificato contenuti testuali.
insertTable(childIndex)TableCrea e inserisce un nuovo Table nell'indice specificato.
insertTable(childIndex, cells)TableCrea e inserisce un nuovo Table contenente le celle specificate, nell'indice specificato.
insertTable(childIndex, table)TableInserisce il valore Table specificato nell'indice specificato.
removeChild(child)BodyRimuove l'elemento secondario specificato.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAttributes(attributes)BodyConsente di impostare gli attributi dell'elemento.
setHeadingAttributes(paragraphHeading, attributes)BodyImposta gli attributi per l'attributo ParagraphHeading fornito.
setMarginBottom(marginBottom)BodyImposta il margine inferiore, in punti.
setMarginLeft(marginLeft)BodyImposta il margine sinistro, in punti.
setMarginRight(marginRight)BodyImposta il margine destro, in punti.
setMarginTop(marginTop)BodyImposta il margine superiore.
setPageHeight(pageHeight)BodyConsente di impostare l'altezza della pagina, in punti.
setPageWidth(pageWidth)BodyImposta la larghezza della pagina, in punti.
setText(text)BodyImposta i contenuti come testo normale.
setTextAlignment(textAlignment)BodyImposta l'allineamento del testo.

Bookmark

Metodi

MetodoTipo restituitoBreve descrizione
getId()StringRecupera l'ID di Bookmark.
getPosition()PositionOttiene il valore Position di Bookmark all'interno di DocumentTab.
remove()voidElimina Bookmark.

ContainerElement

Metodi

MetodoTipo restituitoBreve descrizione
asBody()BodyRestituisce l'elemento corrente come Body.
asEquation()EquationRestituisce l'elemento corrente come Equation.
asFooterSection()FooterSectionRestituisce l'elemento corrente come FooterSection.
asFootnoteSection()FootnoteSectionRestituisce l'elemento corrente come FootnoteSection.
asHeaderSection()HeaderSectionRestituisce l'elemento corrente come HeaderSection.
asListItem()ListItemRestituisce l'elemento corrente come ListItem.
asParagraph()ParagraphRestituisce l'elemento corrente come Paragraph.
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.
clear()ContainerElementCancella i contenuti dell'elemento.
copy()ContainerElementRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getLinkUrl()StringRecupera l'URL del link.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
merge()ContainerElementUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()ContainerElementRimuove l'elemento da quello principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAttributes(attributes)ContainerElementConsente di impostare gli attributi dell'elemento.
setLinkUrl(url)ContainerElementImposta l'URL del link.
setTextAlignment(textAlignment)ContainerElementImposta l'allineamento del testo.

Date

Metodi

MetodoTipo restituitoBreve descrizione
copy()DateRestituisce una copia diretta scollegata dell'elemento corrente.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getDisplayText()StringRestituisce il valore visualizzato nel documento.
getLocale()StringRestituisce le impostazioni internazionali della data utilizzate per il valore visualizzato.
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.
getTimestamp()DateRestituisce il timestamp associato alla data.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
merge()DateUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()DateRimuove l'elemento da quello principale.
setAttributes(attributes)DateConsente di impostare gli attributi dell'elemento.

Document

I metodi della classe Document che accedono direttamente ai contenuti del testo e ne modificano i contenuti operano sulla scheda attiva (negli script associati a un determinato documento) o sulla prima scheda (se non è disponibile una scheda attiva). Gli script che si basano su questi metodi (ad esempio Document.getBody()) possono essere aggiornati per supportare le schede in uno dei seguenti modi:

  • Usa la prima scheda: Document.getTabs()[0].asDocumentTab().getBody()
  • Utilizza tutte le schede: sposta la struttura delle schede utilizzando Document.getTabs() e Tab.getChildTabs(). Per ogni scheda nell'albero, richiama Tab.asDocumentTab().getBody()
  • Utilizza la scheda selezionata: Document.getTabs()[Document.getActiveTab().getId()].asDocumentTab().getBody()
  • Utilizza una scheda specifica: Document.getTab(TAB_ID).asDocumentTab().getBody()

Per ulteriori informazioni sulla funzionalità delle schede, consulta la sezione Utilizzo delle schede.

Metodi

MetodoTipo restituitoBreve descrizione
addBookmark(position)BookmarkAggiunge un Bookmark nel valore Position specificato alla prima scheda oppure, per gli script che sono associata a un documento, la scheda attiva.
addEditor(emailAddress)DocumentAggiunge l'utente specificato all'elenco di editor per Document.
addEditor(user)DocumentAggiunge l'utente specificato all'elenco di editor per Document.
addEditors(emailAddresses)DocumentAggiunge l'array di utenti specificato all'elenco di editor per Document.
addFooter()FooterSectionAggiunge una sezione a piè di pagina, se non ne esiste nessuna, alla prima scheda o, per gli script legati a un documento, alla scheda attiva.
addHeader()HeaderSectionAggiunge una sezione di intestazione, se non ne esiste nessuna, alla prima scheda o, per gli script associati a un documento, alla scheda attiva.
addNamedRange(name, range)NamedRangeAggiunge un NamedRange, ovvero un Range che ha un nome e un ID da utilizzare per recupero in seguito, nella prima scheda o, per gli script associati a un documento, alla scheda attiva.
addViewer(emailAddress)DocumentAggiunge l'utente specificato all'elenco di visualizzatori per Document.
addViewer(user)DocumentAggiunge l'utente specificato all'elenco di visualizzatori per Document.
addViewers(emailAddresses)DocumentAggiunge l'array specificato di utenti all'elenco di visualizzatori per Document.
getActiveTab()TabRestituisce il valore Tab attualmente attivo dell'utente nel documento.
getAs(contentType)BlobRecupera i contenuti attuali di Document come blob del tipo specificato.
getBlob()BlobRecupera i contenuti attuali di Document come blob.
getBody()BodyRecupera il valore Body della prima scheda o, per gli script associati a un documento, il valore DocumentBodySection della scheda attiva.
getBookmark(id)BookmarkRecupera Bookmark con l'ID specificato nella prima scheda o, per gli script associati a un documento, nella scheda attiva.
getBookmarks()Bookmark[]Recupera tutti gli oggetti Bookmark nella prima scheda o, per gli script associati a un documento, la scheda attiva.
getCursor()PositionRestituisce il cursore dell'utente nella scheda attiva.
getEditors()User[]Ottiene l'elenco degli editor per questo Document.
getFooter()FooterSectionRecupera la sezione del piè di pagina della prima scheda o, per gli script legati a un documento, il piè di pagina della scheda attiva .
getFootnotes()Footnote[]Recupera tutti gli elementi Footnote nel corpo della prima scheda o, per gli script associati a un documento, nel corpo della scheda attiva.
getHeader()HeaderSectionRecupera la sezione dell'intestazione della prima scheda o, per gli script associati a un documento, l'intestazione della scheda attiva .
getId()StringRecupera l'identificatore univoco del documento.
getLanguage()StringOttiene il codice lingua del documento.
getName()StringRecupera il titolo del documento.
getNamedRangeById(id)NamedRangeRecupera NamedRange con l'ID specificato nella prima scheda o, per gli script associati a un documento, nella scheda attiva.
getNamedRanges()NamedRange[]Recupera tutti gli oggetti NamedRange nella prima scheda o, per gli script associati a un documento, la scheda attiva.
getNamedRanges(name)NamedRange[]Recupera tutti gli oggetti NamedRange con il nome specificato nella prima scheda o, per gli script che sono legati a un documento, la scheda attiva.
getSelection()RangeRestituisce la selezione dell'utente nella scheda attiva.
getSupportedLanguageCodes()String[]Recupera tutti i codici lingua supportati nei file di Documenti Google.
getTab(tabId)TabOttiene il valore Tab con l'ID specificato.
getTabs()Tab[]Recupera tutti gli elementi Tab non nidificati che fanno parte del documento.
getUrl()StringRecupera l'URL per accedere al documento corrente.
getViewers()User[]Consente di acquisire l'elenco di visualizzatori e commentatori di Document.
newPosition(element, offset)PositionCrea un nuovo Position, che è un riferimento a una posizione nella scheda, rispetto a un elemento specifico nella prima scheda o, per gli script legati a un documento, alla scheda attiva.
newRange()RangeBuilderCrea un builder utilizzato per costruire oggetti Range da elementi scheda in prima scheda o, per gli script associati a una documento, la scheda attiva.
removeEditor(emailAddress)DocumentRimuove l'utente specificato dall'elenco degli editor per Document.
removeEditor(user)DocumentRimuove l'utente specificato dall'elenco degli editor per Document.
removeViewer(emailAddress)DocumentRimuove l'utente specificato dall'elenco di visualizzatori e commentatori per Document.
removeViewer(user)DocumentRimuove l'utente specificato dall'elenco di visualizzatori e commentatori per Document.
saveAndClose()voidSalva l'attuale Document.
setActiveTab(tabId)voidImposta il Tab selezionato dall'utente nel documento corrente sulla scheda con l'ID specificato.
setCursor(position)DocumentImposta il cursore dell'utente, una volta selezionato un Position.
setLanguage(languageCode)DocumentImposta il codice lingua del documento.
setName(name)DocumentImposta il titolo del documento.
setSelection(range)DocumentImposta la selezione dell'utente nella scheda attiva, in base a un valore Range.

DocumentApp

Proprietà

ProprietàTipoDescrizione
AttributeAttributeL'enumerazione Attribute.
ElementTypeElementTypeL'enumerazione ElementType.
FontFamilyFontFamilyL'enumerazione FontFamily.
GlyphTypeGlyphTypeL'enumerazione GlyphType.
HorizontalAlignmentHorizontalAlignmentL'enumerazione HorizontalAlignment.
ParagraphHeadingParagraphHeadingL'enumerazione ParagraphHeading.
PositionedLayoutPositionedLayoutL'enumerazione PositionedLayout.
TextAlignmentTextAlignmentL'enumerazione TextAlignment.
VerticalAlignmentVerticalAlignmentL'enumerazione VerticalAlignment.

Metodi

MetodoTipo restituitoBreve descrizione
create(name)DocumentCrea e restituisce un nuovo documento.
getActiveDocument()DocumentRestituisce il documento a cui lo script è container-bound.
getUi()UiRestituisce un'istanza dell'ambiente di interfaccia utente del documento che consente allo script di aggiungere come menu, finestre di dialogo e barre laterali.
openById(id)DocumentRestituisce il documento con l'ID specificato.
openByUrl(url)DocumentApre e restituisce il documento con l'URL specificato.

DocumentTab

Metodi

MetodoTipo restituitoBreve descrizione
addBookmark(position)BookmarkAggiunge un Bookmark a Position specificato.
addFooter()FooterSectionAggiunge una sezione per il piè di pagina delle schede, se non ne esiste nessuna.
addHeader()HeaderSectionAggiunge una sezione di intestazione della scheda, se non ne esiste nessuna.
addNamedRange(name, range)NamedRangeAggiunge un NamedRange, ovvero un Range che ha un nome e un ID da utilizzare per per il recupero in un secondo momento.
getBody()BodyRecupera il valore Body della scheda.
getBookmark(id)BookmarkRecupera Bookmark con l'ID specificato.
getBookmarks()Bookmark[]Recupera tutti gli oggetti Bookmark nella scheda.
getFooter()FooterSectionRecupera la sezione del piè di pagina della scheda, se esistente.
getFootnotes()Footnote[]Recupera tutti gli elementi Footnote nel corpo della scheda.
getHeader()HeaderSectionRecupera la sezione dell'intestazione della scheda, se esistente.
getNamedRangeById(id)NamedRangeRecupera NamedRange con l'ID specificato.
getNamedRanges()NamedRange[]Recupera tutti gli oggetti NamedRange nella scheda.
getNamedRanges(name)NamedRange[]Recupera tutti gli oggetti NamedRange nella scheda con il nome specificato.
newPosition(element, offset)PositionCrea un nuovo Position, che è un riferimento a una posizione nella scheda, rispetto a un elemento specifico.
newRange()RangeBuilderCrea un builder utilizzato per costruire oggetti Range da elementi scheda.

Element

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.

ElementType

Proprietà

ProprietàTipoDescrizione
BODY_SECTIONEnumIl tipo corrispondente all'elemento Body.
COMMENT_SECTIONEnumIl tipo corrispondente all'elemento CommentSection.
DATEEnumIl tipo corrispondente a Date .
EQUATIONEnumIl tipo corrispondente all'elemento Equation.
EQUATION_FUNCTIONEnumIl tipo corrispondente all'elemento EquationFunction.
EQUATION_FUNCTION_ARGUMENT_SEPARATOREnumIl tipo corrispondente a EquationFunctionArgumentSeparator .
EQUATION_SYMBOLEnumIl tipo corrispondente all'elemento EquationSymbol.
RICH_LINKEnumIl tipo corrispondente all'elemento RichLink.
FOOTER_SECTIONEnumIl tipo corrispondente all'elemento FooterSection.
FOOTNOTEEnumIl tipo corrispondente all'elemento Footnote.
FOOTNOTE_SECTIONEnumIl tipo corrispondente all'elemento FootnoteSection.
HEADER_SECTIONEnumIl tipo corrispondente all'elemento HeaderSection.
HORIZONTAL_RULEEnumIl tipo corrispondente all'elemento HorizontalRule.
INLINE_DRAWINGEnumIl tipo corrispondente all'elemento InlineDrawing.
INLINE_IMAGEEnumIl tipo corrispondente all'elemento InlineImage.
LIST_ITEMEnumIl tipo corrispondente all'elemento ListItem.
PAGE_BREAKEnumIl tipo corrispondente all'elemento PageBreak.
PARAGRAPHEnumIl tipo corrispondente all'elemento Paragraph.
PERSONEnumIl tipo corrispondente all'elemento Person.
TABLEEnumIl tipo corrispondente all'elemento Table.
TABLE_CELLEnumIl tipo corrispondente all'elemento TableCell.
TABLE_OF_CONTENTSEnumIl tipo corrispondente all'elemento TableOfContents.
TABLE_ROWEnumIl tipo corrispondente all'elemento TableRow.
TEXTEnumIl tipo corrispondente a Text .
UNSUPPORTEDEnumIl tipo corrispondente a UnsupportedElement.

Equation

Metodi

MetodoTipo restituitoBreve descrizione
clear()EquationCancella i contenuti dell'elemento.
copy()EquationRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getLinkUrl()StringRecupera l'URL del link.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
merge()EquationUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()EquationRimuove l'elemento da quello principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAttributes(attributes)EquationConsente di impostare gli attributi dell'elemento.
setLinkUrl(url)EquationImposta l'URL del link.
setTextAlignment(textAlignment)EquationImposta l'allineamento del testo.

EquationFunction

Metodi

MetodoTipo restituitoBreve descrizione
clear()EquationFunctionCancella i contenuti dell'elemento.
copy()EquationFunctionRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getCode()StringRecupera il codice corrispondente alla funzione dell'equazione.
getLinkUrl()StringRecupera l'URL del link.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
merge()EquationFunctionUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()EquationFunctionRimuove l'elemento da quello principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAttributes(attributes)EquationFunctionConsente di impostare gli attributi dell'elemento.
setLinkUrl(url)EquationFunctionImposta l'URL del link.
setTextAlignment(textAlignment)EquationFunctionImposta l'allineamento del testo.

EquationFunctionArgumentSeparator

Metodi

MetodoTipo restituitoBreve descrizione
copy()EquationFunctionArgumentSeparatorRestituisce 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()EquationFunctionArgumentSeparatorUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()EquationFunctionArgumentSeparatorRimuove l'elemento da quello principale.
setAttributes(attributes)EquationFunctionArgumentSeparatorConsente di impostare gli attributi dell'elemento.

EquationSymbol

Metodi

MetodoTipo restituitoBreve descrizione
copy()EquationSymbolRestituisce una copia diretta scollegata dell'elemento corrente.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getCode()StringRecupera il codice corrispondente al simbolo dell'equazione.
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()EquationSymbolUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()EquationSymbolRimuove l'elemento da quello principale.
setAttributes(attributes)EquationSymbolConsente di impostare gli attributi dell'elemento.

FontFamily

FooterSection

Metodi

MetodoTipo restituitoBreve descrizione
appendHorizontalRule()HorizontalRuleCrea e aggiunge un nuovo HorizontalRule.
appendImage(image)InlineImageCrea e aggiunge un nuovo InlineImage dal blob dell'immagine specificato.
appendImage(image)InlineImageAggiungi il valore InlineImage specificato.
appendListItem(listItem)ListItemAggiungi il valore ListItem specificato.
appendListItem(text)ListItemCrea e aggiunge un nuovo ListItem contenente i contenuti di testo specificati.
appendParagraph(paragraph)ParagraphAggiungi il valore Paragraph specificato.
appendParagraph(text)ParagraphCrea e aggiunge un nuovo Paragraph contenente i contenuti di testo specificati.
appendTable()TableCrea e aggiunge un nuovo Table.
appendTable(cells)TableAggiunge un nuovo Table contenente un TableCell per ogni valore di stringa specificato.
appendTable(table)TableAggiungi il valore Table specificato.
clear()FooterSectionCancella i contenuti dell'elemento.
copy()FooterSectionRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getImages()InlineImage[]Recupera tutti i valori InlineImages contenuti nella sezione.
getListItems()ListItem[]Recupera tutti i valori ListItems contenuti nella sezione.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getParagraphs()Paragraph[]Recupera tutti i valori Paragraphs contenuti nella sezione (incluso ListItems).
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getTables()Table[]Recupera tutti i valori Tables contenuti nella sezione.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserisce un nuovo HorizontalRule nell'indice specificato.
insertImage(childIndex, image)InlineImageCrea e inserisce un InlineImage dal blob dell'immagine specificato, nel punto specificato indice.
insertImage(childIndex, image)InlineImageInserisce il valore InlineImage specificato nell'indice specificato.
insertListItem(childIndex, listItem)ListItemInserisce il valore ListItem specificato nell'indice specificato.
insertListItem(childIndex, text)ListItemCrea e inserisce un nuovo ListItem nell'indice specificato, contenente il valore specificato contenuti testuali.
insertParagraph(childIndex, paragraph)ParagraphInserisce il valore Paragraph specificato nell'indice specificato.
insertParagraph(childIndex, text)ParagraphCrea e inserisce un nuovo Paragraph nell'indice specificato, contenente il valore specificato contenuti testuali.
insertTable(childIndex)TableCrea e inserisce un nuovo Table nell'indice specificato.
insertTable(childIndex, cells)TableCrea e inserisce un nuovo Table contenente le celle specificate, nell'indice specificato.
insertTable(childIndex, table)TableInserisce il valore Table specificato nell'indice specificato.
removeChild(child)FooterSectionRimuove l'elemento secondario specificato.
removeFromParent()FooterSectionRimuove l'elemento da quello principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAttributes(attributes)FooterSectionConsente di impostare gli attributi dell'elemento.
setText(text)FooterSectionImposta i contenuti come testo normale.
setTextAlignment(textAlignment)FooterSectionImposta l'allineamento del testo.

Footnote

Metodi

MetodoTipo restituitoBreve descrizione
copy()FootnoteRestituisce una copia diretta scollegata dell'elemento corrente.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getFootnoteContents()FootnoteSectionRecupera i contenuti dell'elemento nota a piè di pagina.
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.
removeFromParent()FootnoteRimuove l'elemento da quello principale.
setAttributes(attributes)FootnoteConsente di impostare gli attributi dell'elemento.

FootnoteSection

Metodi

MetodoTipo restituitoBreve descrizione
appendParagraph(paragraph)ParagraphAggiungi il valore Paragraph specificato.
appendParagraph(text)ParagraphCrea e aggiunge un nuovo Paragraph contenente i contenuti di testo specificati.
clear()FootnoteSectionCancella i contenuti dell'elemento.
copy()FootnoteSectionRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getParagraphs()Paragraph[]Recupera tutti i valori Paragraphs contenuti nella sezione (incluso ListItems).
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
insertParagraph(childIndex, paragraph)ParagraphInserisce il valore Paragraph specificato nell'indice specificato.
insertParagraph(childIndex, text)ParagraphCrea e inserisce un nuovo Paragraph nell'indice specificato, contenente il valore specificato contenuti testuali.
removeChild(child)FootnoteSectionRimuove l'elemento secondario specificato.
removeFromParent()FootnoteSectionRimuove l'elemento da quello principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAttributes(attributes)FootnoteSectionConsente di impostare gli attributi dell'elemento.
setText(text)FootnoteSectionImposta i contenuti come testo normale.
setTextAlignment(textAlignment)FootnoteSectionImposta l'allineamento del testo.

GlyphType

Proprietà

ProprietàTipoDescrizione
BULLETEnumIl punto predefinito, circolare e pieno.
HOLLOW_BULLETEnumUn punto elenco vuoto.
SQUARE_BULLETEnumUn punto elenco quadrato.
NUMBEREnumUn punto elenco basato su numeri.
LATIN_UPPEREnumUn punto elenco latino- maiuscolo.
LATIN_LOWEREnumUn punto elenco latino- minuscolo.
ROMAN_UPPEREnumUn numero romano con un punto elenco maiuscolo.
ROMAN_LOWEREnumUn numero romano con un punto elenco minuscolo.

HeaderSection

Metodi

MetodoTipo restituitoBreve descrizione
appendHorizontalRule()HorizontalRuleCrea e aggiunge un nuovo HorizontalRule.
appendImage(image)InlineImageCrea e aggiunge un nuovo InlineImage dal blob dell'immagine specificato.
appendImage(image)InlineImageAggiungi il valore InlineImage specificato.
appendListItem(listItem)ListItemAggiungi il valore ListItem specificato.
appendListItem(text)ListItemCrea e aggiunge un nuovo ListItem contenente i contenuti di testo specificati.
appendParagraph(paragraph)ParagraphAggiungi il valore Paragraph specificato.
appendParagraph(text)ParagraphCrea e aggiunge un nuovo Paragraph contenente i contenuti di testo specificati.
appendTable()TableCrea e aggiunge un nuovo Table.
appendTable(cells)TableAggiunge un nuovo Table contenente un TableCell per ogni valore di stringa specificato.
appendTable(table)TableAggiungi il valore Table specificato.
clear()HeaderSectionCancella i contenuti dell'elemento.
copy()HeaderSectionRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getImages()InlineImage[]Recupera tutti i valori InlineImages contenuti nella sezione.
getListItems()ListItem[]Recupera tutti i valori ListItems contenuti nella sezione.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getParagraphs()Paragraph[]Recupera tutti i valori Paragraphs contenuti nella sezione (incluso ListItems).
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getTables()Table[]Recupera tutti i valori Tables contenuti nella sezione.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserisce un nuovo HorizontalRule nell'indice specificato.
insertImage(childIndex, image)InlineImageCrea e inserisce un InlineImage dal blob dell'immagine specificato, nel punto specificato indice.
insertImage(childIndex, image)InlineImageInserisce il valore InlineImage specificato nell'indice specificato.
insertListItem(childIndex, listItem)ListItemInserisce il valore ListItem specificato nell'indice specificato.
insertListItem(childIndex, text)ListItemCrea e inserisce un nuovo ListItem nell'indice specificato, contenente il valore specificato contenuti testuali.
insertParagraph(childIndex, paragraph)ParagraphInserisce il valore Paragraph specificato nell'indice specificato.
insertParagraph(childIndex, text)ParagraphCrea e inserisce un nuovo Paragraph nell'indice specificato, contenente il valore specificato contenuti testuali.
insertTable(childIndex)TableCrea e inserisce un nuovo Table nell'indice specificato.
insertTable(childIndex, cells)TableCrea e inserisce un nuovo Table contenente le celle specificate, nell'indice specificato.
insertTable(childIndex, table)TableInserisce il valore Table specificato nell'indice specificato.
removeChild(child)HeaderSectionRimuove l'elemento secondario specificato.
removeFromParent()HeaderSectionRimuove l'elemento da quello principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAttributes(attributes)HeaderSectionConsente di impostare gli attributi dell'elemento.
setText(text)HeaderSectionImposta i contenuti come testo normale.
setTextAlignment(textAlignment)HeaderSectionImposta l'allineamento del testo.

HorizontalAlignment

Proprietà

ProprietàTipoDescrizione
LEFTEnumL'opzione di allineamento a sinistra.
CENTEREnumL'opzione di allineamento al centro.
RIGHTEnumL'opzione di allineamento a destra.
JUSTIFYEnumL'opzione Allineamento giustificazione.

HorizontalRule

Metodi

MetodoTipo restituitoBreve descrizione
copy()HorizontalRuleRestituisce 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.
removeFromParent()HorizontalRuleRimuove l'elemento da quello principale.
setAttributes(attributes)HorizontalRuleConsente di impostare gli attributi dell'elemento.

InlineDrawing

Metodi

MetodoTipo restituitoBreve descrizione
copy()InlineDrawingRestituisce una copia diretta scollegata dell'elemento corrente.
getAltDescription()StringRestituisce la descrizione alternativa del disegno.
getAltTitle()StringRestituisce il titolo alternativo del disegno.
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()InlineDrawingUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()InlineDrawingRimuove l'elemento da quello principale.
setAltDescription(description)InlineDrawingConsente di impostare la descrizione alternativa del disegno.
setAltTitle(title)InlineDrawingImposta il titolo alternativo del disegno.
setAttributes(attributes)InlineDrawingConsente di impostare gli attributi dell'elemento.

InlineImage

Metodi

MetodoTipo restituitoBreve descrizione
copy()InlineImageRestituisce una copia diretta scollegata dell'elemento corrente.
getAltDescription()StringRestituisce la descrizione alternativa dell'immagine.
getAltTitle()StringRestituisce il titolo alternativo dell'immagine.
getAs(contentType)BlobRestituisce i dati all'interno di questo oggetto come blob convertito nel tipo di contenuto specificato.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getBlob()BlobRestituisce i dati all'interno dell'oggetto sotto forma di blob.
getHeight()IntegerRecupera l'altezza dell'immagine in pixel.
getLinkUrl()StringRecupera l'URL del link.
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.
getWidth()IntegerRecupera la larghezza dell'immagine, in pixel.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
merge()InlineImageUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()InlineImageRimuove l'elemento da quello principale.
setAltDescription(description)InlineImageConsente di impostare la descrizione alternativa dell'immagine.
setAltTitle(title)InlineImageImposta il titolo alternativo dell'immagine.
setAttributes(attributes)InlineImageConsente di impostare gli attributi dell'elemento.
setHeight(height)InlineImageConsente di impostare l'altezza dell'immagine in pixel.
setLinkUrl(url)InlineImageImposta l'URL del link.
setWidth(width)InlineImageConsente di impostare la larghezza dell'immagine, in pixel.

ListItem

Metodi

MetodoTipo restituitoBreve descrizione
addPositionedImage(image)PositionedImageCrea e inserisce un nuovo PositionedImage dal blob dell'immagine specificato.
appendHorizontalRule()HorizontalRuleCrea e aggiunge un nuovo HorizontalRule.
appendInlineImage(image)InlineImageCrea e aggiunge un nuovo InlineImage dal blob dell'immagine specificato.
appendInlineImage(image)InlineImageAggiungi il valore InlineImage specificato.
appendPageBreak()PageBreakCrea e aggiunge un nuovo PageBreak.
appendPageBreak(pageBreak)PageBreakAggiungi il valore PageBreak specificato.
appendText(text)TextCrea e aggiunge un nuovo elemento Text con i contenuti specificati.
appendText(text)TextAccoda l'elemento Text specificato.
clear()ListItemCancella i contenuti dell'elemento.
copy()ListItemRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAlignment()HorizontalAlignmentRecupera l'oggetto HorizontalAlignment.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getGlyphType()GlyphTypeRecupera il valore GlyphType dell'elemento dell'elenco.
getHeading()ParagraphHeadingRecupera l'oggetto ParagraphHeading.
getIndentEnd()NumberRecupera il rientro finale, in punti.
getIndentFirstLine()NumberRecupera il rientro della prima riga, in punti.
getIndentStart()NumberRecupera il rientro iniziale.
getLineSpacing()NumberRecupera l'interlinea, in punti.
getLinkUrl()StringRecupera l'URL del link.
getListId()StringRecupera l'ID elenco.
getNestingLevel()IntegerRecupera il livello di annidamento dell'elemento dell'elenco.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPositionedImage(id)PositionedImageRecupera un valore PositionedImage dall'ID dell'immagine.
getPositionedImages()PositionedImage[]Recupera tutti gli oggetti PositionedImage ancorati al paragrafo.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
getSpacingAfter()NumberRecupera la spaziatura dopo l'elemento, in punti.
getSpacingBefore()NumberRecupera la spaziatura prima dell'elemento, in punti.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserisce un HorizontalRule nell'indice specificato.
insertInlineImage(childIndex, image)InlineImageCrea e inserisce un nuovo InlineImage dal blob dell'immagine specificato, nel punto specificato indice.
insertInlineImage(childIndex, image)InlineImageInserisce il valore InlineImage specificato nell'indice specificato.
insertPageBreak(childIndex)PageBreakCrea e inserisce un nuovo PageBreak nell'indice specificato.
insertPageBreak(childIndex, pageBreak)PageBreakInserisce il valore PageBreak specificato nell'indice specificato.
insertText(childIndex, text)TextCrea e inserisce un nuovo elemento di testo in corrispondenza dell'indice specificato.
insertText(childIndex, text)TextInserisce l'elemento Text specificato nell'indice specificato, con il testo specificato contenuti.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
isLeftToRight()BooleanRecupera l'impostazione da sinistra a destra.
merge()ListItemUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeChild(child)ListItemRimuove l'elemento secondario specificato.
removeFromParent()ListItemRimuove l'elemento da quello principale.
removePositionedImage(id)BooleanRimuove una PositionedImage dall'ID dell'immagine.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAlignment(alignment)ListItemImposta il HorizontalAlignment.
setAttributes(attributes)ListItemConsente di impostare gli attributi dell'elemento.
setGlyphType(glyphType)ListItemConsente di impostare il valore GlyphType dell'elemento dell'elenco.
setHeading(heading)ListItemImposta il ParagraphHeading.
setIndentEnd(indentEnd)ListItemImposta il rientro finale, in punti.
setIndentFirstLine(indentFirstLine)ListItemImposta il rientro della prima riga, in punti.
setIndentStart(indentStart)ListItemImposta il rientro iniziale in punti.
setLeftToRight(leftToRight)ListItemConsente di impostare un'impostazione da sinistra a destra.
setLineSpacing(multiplier)ListItemConsente di impostare l'interlinea, come quantità che indica il numero di righe da utilizzare per l'interlinea.
setLinkUrl(url)ListItemImposta l'URL del link.
setListId(listItem)ListItemConsente di impostare l'ID elenco.
setNestingLevel(nestingLevel)ListItemImposta il livello di annidamento dell'elemento dell'elenco.
setSpacingAfter(spacingAfter)ListItemConsente di impostare la spaziatura dopo l'elemento, in punti.
setSpacingBefore(spacingBefore)ListItemConsente di impostare la spaziatura prima dell'elemento, in punti.
setText(text)voidImposta i contenuti dell'elemento dell'elenco come testo.
setTextAlignment(textAlignment)ListItemImposta l'allineamento del testo.

NamedRange

Metodi

MetodoTipo restituitoBreve descrizione
getId()StringOttiene l'ID di questo NamedRange.
getName()StringOttiene il nome di questo NamedRange.
getRange()RangeRestituisce l'intervallo di elementi associati a NamedRange.
remove()voidRimuove NamedRange dalla scheda.

PageBreak

Metodi

MetodoTipo restituitoBreve descrizione
copy()PageBreakRestituisce 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.
removeFromParent()PageBreakRimuove l'elemento da quello principale.
setAttributes(attributes)PageBreakConsente di impostare gli attributi dell'elemento.

Paragraph

Metodi

MetodoTipo restituitoBreve descrizione
addPositionedImage(image)PositionedImageCrea e inserisce un nuovo PositionedImage dal blob dell'immagine specificato.
appendHorizontalRule()HorizontalRuleCrea e aggiunge un nuovo HorizontalRule.
appendInlineImage(image)InlineImageCrea e aggiunge un nuovo InlineImage dal blob dell'immagine specificato.
appendInlineImage(image)InlineImageAggiungi il valore InlineImage specificato.
appendPageBreak()PageBreakCrea e aggiunge un nuovo PageBreak.
appendPageBreak(pageBreak)PageBreakAggiungi il valore PageBreak specificato.
appendText(text)TextCrea e aggiunge un nuovo elemento Text con i contenuti specificati.
appendText(text)TextAccoda l'elemento Text specificato.
clear()ParagraphCancella i contenuti dell'elemento.
copy()ParagraphRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAlignment()HorizontalAlignmentRecupera l'oggetto HorizontalAlignment.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getHeading()ParagraphHeadingRecupera l'oggetto ParagraphHeading.
getIndentEnd()NumberRecupera il rientro finale, in punti.
getIndentFirstLine()NumberRecupera il rientro della prima riga, in punti.
getIndentStart()NumberRecupera il rientro iniziale.
getLineSpacing()NumberRecupera l'interlinea, in punti.
getLinkUrl()StringRecupera l'URL del link.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPositionedImage(id)PositionedImageRecupera un valore PositionedImage dall'ID dell'immagine.
getPositionedImages()PositionedImage[]Recupera tutti gli oggetti PositionedImage ancorati al paragrafo.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
getSpacingAfter()NumberRecupera la spaziatura dopo l'elemento, in punti.
getSpacingBefore()NumberRecupera la spaziatura prima dell'elemento, in punti.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserisce un HorizontalRule nell'indice specificato.
insertInlineImage(childIndex, image)InlineImageCrea e inserisce un nuovo InlineImage dal blob dell'immagine specificato, nel punto specificato indice.
insertInlineImage(childIndex, image)InlineImageInserisce il valore InlineImage specificato nell'indice specificato.
insertPageBreak(childIndex)PageBreakCrea e inserisce un nuovo PageBreak nell'indice specificato.
insertPageBreak(childIndex, pageBreak)PageBreakInserisce il valore PageBreak specificato nell'indice specificato.
insertText(childIndex, text)TextCrea e inserisce un nuovo elemento di testo in corrispondenza dell'indice specificato.
insertText(childIndex, text)TextInserisce l'elemento Text specificato nell'indice specificato, con il testo specificato contenuti.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
isLeftToRight()BooleanRecupera l'impostazione da sinistra a destra.
merge()ParagraphUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeChild(child)ParagraphRimuove l'elemento secondario specificato.
removeFromParent()ParagraphRimuove l'elemento da quello principale.
removePositionedImage(id)BooleanRimuove una PositionedImage dall'ID dell'immagine.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAlignment(alignment)ParagraphImposta il HorizontalAlignment.
setAttributes(attributes)ParagraphConsente di impostare gli attributi dell'elemento.
setHeading(heading)ParagraphImposta il ParagraphHeading.
setIndentEnd(indentEnd)ParagraphImposta il rientro finale, in punti.
setIndentFirstLine(indentFirstLine)ParagraphImposta il rientro della prima riga, in punti.
setIndentStart(indentStart)ParagraphImposta il rientro iniziale in punti.
setLeftToRight(leftToRight)ParagraphConsente di impostare un'impostazione da sinistra a destra.
setLineSpacing(multiplier)ParagraphConsente di impostare l'interlinea, come quantità che indica il numero di righe da utilizzare per l'interlinea.
setLinkUrl(url)ParagraphImposta l'URL del link.
setSpacingAfter(spacingAfter)ParagraphConsente di impostare la spaziatura dopo l'elemento, in punti.
setSpacingBefore(spacingBefore)ParagraphConsente di impostare la spaziatura prima dell'elemento, in punti.
setText(text)voidImposta i contenuti del paragrafo come testo.
setTextAlignment(textAlignment)ParagraphImposta l'allineamento del testo.

ParagraphHeading

Proprietà

ProprietàTipoDescrizione
NORMALEnumL'opzione di intestazione per il testo normale.
HEADING1EnumL'opzione di intestazione più alta.
HEADING2EnumLa seconda opzione di intestazione.
HEADING3EnumLa terza opzione di intestazione
HEADING4EnumLa quarta opzione per l'intestazione.
HEADING5EnumLa quinta opzione di intestazione.
HEADING6EnumL'opzione relativa all'intestazione più bassa.
TITLEEnumL'opzione per l'intestazione del titolo.
SUBTITLEEnumL'opzione per l'intestazione dei sottotitoli.

Person

Metodi

MetodoTipo restituitoBreve descrizione
copy()PersonRestituisce una copia diretta scollegata dell'elemento corrente.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getEmail()StringRestituisce l'indirizzo email della persona.
getName()StringRestituisce il nome visualizzato della persona, se impostato.
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()PersonUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()PersonRimuove l'elemento da quello principale.
setAttributes(attributes)PersonConsente di impostare gli attributi dell'elemento.

Position

Metodi

MetodoTipo restituitoBreve descrizione
getElement()ElementRecupera l'elemento che contiene l'elemento Position.
getOffset()IntegerOttiene la posizione relativa di questo Position all'interno dell'elemento che lo contiene.
getSurroundingText()TextCrea un elemento Text artificiale che rappresenta il testo e la formattazione dell'elemento Paragraph o ListItem che contiene Position, direttamente o tramite una catena di elementi secondari.
getSurroundingTextOffset()IntegerRestituisce l'offset di Position all'interno dell'elemento Text restituito da getSurroundingText().
insertBookmark()BookmarkCrea e inserisce un nuovo Bookmark in questo Position.
insertInlineImage(image)InlineImageCrea e inserisce un nuovo InlineImage in questo Position dall'immagine specificata blob.
insertText(text)TextInserisce il testo specificato in questo Position.

PositionedImage

Metodi

MetodoTipo restituitoBreve descrizione
getAs(contentType)BlobRestituisce i dati all'interno di questo oggetto come blob convertito nel tipo di contenuto specificato.
getBlob()BlobRestituisce i dati all'interno dell'oggetto sotto forma di blob.
getHeight()IntegerRecupera l'altezza dell'immagine in pixel.
getId()StringRecupera l'ID dell'immagine.
getLayout()PositionedLayoutOttiene un valore enum che rappresenta il modo in cui è strutturata l'immagine.
getLeftOffset()NumberRestituisce l'offset dell'immagine, in punti, dalla sinistra del paragrafo.
getParagraph()ParagraphOttiene il Paragraph a cui è ancorata l'immagine.
getTopOffset()NumberRestituisce l'offset dell'immagine, in punti, dall'alto del paragrafo.
getWidth()IntegerRecupera la larghezza dell'immagine, in pixel.
setHeight(height)PositionedImageConsente di impostare l'altezza dell'immagine in pixel.
setLayout(layout)PositionedImageConsente di impostare la definizione dell'aspetto dell'immagine.
setLeftOffset(offset)PositionedImageConsente di impostare l'offset dell'immagine, in punti, dal lato sinistro del paragrafo.
setTopOffset(offset)PositionedImageConsente di impostare l'offset dell'immagine, in punti, dal bordo superiore del paragrafo.
setWidth(width)PositionedImageConsente di impostare la larghezza dell'immagine, in pixel.

PositionedLayout

Proprietà

ProprietàTipoDescrizione
ABOVE_TEXTEnumL'immagine è posizionata sopra il testo.
BREAK_BOTHEnumL'immagine spezza il testo a sinistra e a destra.
BREAK_LEFTEnumL'immagine interrompe il testo a sinistra.
BREAK_RIGHTEnumL'immagine rompe il testo a destra.
WRAP_TEXTEnumL'immagine è racchiusa da testo.

Range

Metodi

MetodoTipo restituitoBreve descrizione
getRangeElements()RangeElement[]Recupera tutti gli elementi in questo Range, inclusi eventuali elementi Text parziali (ad esempio, nel caso di una selezione che include solo parte di un elemento Text).

RangeBuilder

Metodi

MetodoTipo restituitoBreve descrizione
addElement(element)RangeBuilderAggiunge un intero Element a questo RangeBuilder.
addElement(textElement, startOffset, endOffsetInclusive)RangeBuilderAggiunge un elemento Text parziale a questo RangeBuilder.
addElementsBetween(startElement, endElementInclusive)RangeBuilderAggiunge due elementi interi, e tutti gli elementi tra di essi, a RangeBuilder.
addElementsBetween(startTextElement, startOffset, endTextElementInclusive, endOffsetInclusive)RangeBuilderAggiunge due elementi Text parziali e tutti gli elementi tra di loro, alla RangeBuilder.
addRange(range)RangeBuilderAggiunge i contenuti di un altro elemento Range a questo RangeBuilder.
build()RangeCrea un Range dalle impostazioni applicate al builder.
getRangeElements()RangeElement[]Recupera tutti gli elementi in questo Range, inclusi eventuali elementi Text parziali (ad esempio, nel caso di una selezione che include solo parte di un elemento Text).

RangeElement

Metodi

MetodoTipo restituitoBreve descrizione
getElement()ElementRestituisce il valore Element che corrisponde a questo RangeElement.
getEndOffsetInclusive()IntegerRestituisce la posizione della fine di un intervallo parziale all'interno dell'elemento dell'intervallo.
getStartOffset()IntegerRestituisce la posizione dell'inizio di un intervallo parziale all'interno dell'elemento dell'intervallo.
isPartial()BooleanDetermina se questo elemento dell'intervallo copre l'intero elemento o una selezione parziale dell'elemento caratteri dell'elemento.

Metodi

MetodoTipo restituitoBreve descrizione
copy()RichLinkRestituisce una copia diretta scollegata dell'elemento corrente.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getMimeType()StringRestituisce il tipo MIME di il link, disponibile quando l'elemento è un link a un file di Drive e null negli altri casi.
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.
getTitle()StringRestituisce il titolo visualizzato del link.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
getUrl()StringRestituisce l'URL della risorsa.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
merge()RichLinkUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()RichLinkRimuove l'elemento da quello principale.
setAttributes(attributes)RichLinkConsente di impostare gli attributi dell'elemento.

Tab

Metodi

MetodoTipo restituitoBreve descrizione
asDocumentTab()DocumentTabRecupera i contenuti della scheda come DocumentTab.
getChildTabs()Tab[]Recupera le schede secondarie nidificate all'interno di questa scheda.
getId()StringRecupera l'ID della scheda.
getIndex()IntegerRecupera l'indice in base 0 della scheda all'interno della cartella principale.
getTitle()StringRecupera il titolo della scheda.
getType()TabTypeRecupera il tipo di scheda.

TabType

Proprietà

ProprietàTipoDescrizione
DOCUMENT_TABEnumIl tipo corrispondente a DocumentTab.

Table

Metodi

MetodoTipo restituitoBreve descrizione
appendTableRow()TableRowCrea e aggiunge un nuovo TableRow.
appendTableRow(tableRow)TableRowAggiungi il valore TableRow specificato.
clear()TableCancella i contenuti dell'elemento.
copy()TableRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getBorderColor()StringRecupera il colore del bordo.
getBorderWidth()NumberRecupera la larghezza del bordo, in punti.
getCell(rowIndex, cellIndex)TableCellRecupera il valore TableCell negli indici di riga e cella specificati.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getColumnWidth(columnIndex)NumberRecupera la larghezza della colonna della tabella specificata, in punti.
getLinkUrl()StringRecupera l'URL del link.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getNumRows()IntegerRecupera il numero di TableRows.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
getRow(rowIndex)TableRowRecupera TableRow nell'indice di riga specificato.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
insertTableRow(childIndex)TableRowCrea e inserisce un nuovo TableRow nell'indice specificato.
insertTableRow(childIndex, tableRow)TableRowInserisce il valore TableRow specificato nell'indice specificato.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
removeChild(child)TableRimuove l'elemento secondario specificato.
removeFromParent()TableRimuove l'elemento da quello principale.
removeRow(rowIndex)TableRowRimuove il valore TableRow in corrispondenza dell'indice di riga specificato.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAttributes(attributes)TableConsente di impostare gli attributi dell'elemento.
setBorderColor(color)TableImposta il colore del bordo.
setBorderWidth(width)TableImposta la larghezza del bordo, in punti.
setColumnWidth(columnIndex, width)TableImposta la larghezza della colonna specificata, in punti.
setLinkUrl(url)TableImposta l'URL del link.
setTextAlignment(textAlignment)TableImposta l'allineamento del testo.

TableCell

Metodi

MetodoTipo restituitoBreve descrizione
appendHorizontalRule()HorizontalRuleCrea e aggiunge un nuovo HorizontalRule.
appendImage(image)InlineImageCrea e aggiunge un nuovo InlineImage dal blob dell'immagine specificato.
appendImage(image)InlineImageAggiungi il valore InlineImage specificato.
appendListItem(listItem)ListItemAggiungi il valore ListItem specificato.
appendListItem(text)ListItemCrea e aggiunge un nuovo ListItem.
appendParagraph(paragraph)ParagraphAggiungi il valore Paragraph specificato.
appendParagraph(text)ParagraphCrea e aggiunge un nuovo Paragraph.
appendTable()TableCrea e aggiunge un nuovo Table.
appendTable(cells)TableAggiungi un nuovo Table contenente le celle specificate.
appendTable(table)TableAggiungi il valore Table specificato.
clear()TableCellCancella i contenuti dell'elemento.
copy()TableCellRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getBackgroundColor()StringRecupera il colore di sfondo.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getColSpan()IntegerRecupera l'intervallo di colonne, ovvero il numero di colonne di celle della tabella coperte da questa cella.
getLinkUrl()StringRecupera l'URL del link.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getPaddingBottom()NumberRecupera la spaziatura interna inferiore, in punti.
getPaddingLeft()NumberRecupera la spaziatura interna sinistra, in punti.
getPaddingRight()NumberRecupera la spaziatura interna corretta, in punti.
getPaddingTop()NumberRecupera la spaziatura interna superiore, in punti.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getParentRow()TableRowRecupera il valore TableRow contenente il valore TableCell corrente.
getParentTable()TableRecupera il valore Table contenente il valore TableCell corrente.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
getRowSpan()IntegerRecupera l'intervallo di righe, ovvero il numero di righe di celle della tabella coperte da questa cella.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
getVerticalAlignment()VerticalAlignmentRecupera l'oggetto VerticalAlignment.
getWidth()NumberRecupera la larghezza della colonna contenente la cella, in punti.
insertHorizontalRule(childIndex)HorizontalRuleCrea e inserisce un nuovo HorizontalRule nell'indice specificato.
insertImage(childIndex, image)InlineImageCrea e inserisce un InlineImage dal blob dell'immagine specificato, nel punto specificato indice.
insertImage(childIndex, image)InlineImageInserisce il valore InlineImage specificato nell'indice specificato.
insertListItem(childIndex, listItem)ListItemInserisce il valore ListItem specificato nell'indice specificato.
insertListItem(childIndex, text)ListItemCrea e inserisce un nuovo ListItem nell'indice specificato.
insertParagraph(childIndex, paragraph)ParagraphInserisce il valore Paragraph specificato nell'indice specificato.
insertParagraph(childIndex, text)ParagraphCrea e inserisce un nuovo Paragraph nell'indice specificato.
insertTable(childIndex)TableCrea e inserisce un nuovo Table nell'indice specificato.
insertTable(childIndex, cells)TableCrea e inserisce un nuovo Table contenente le celle specificate, nell'indice specificato.
insertTable(childIndex, table)TableInserisce il valore Table specificato nell'indice specificato.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
merge()TableCellUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeChild(child)TableCellRimuove l'elemento secondario specificato.
removeFromParent()TableCellRimuove l'elemento da quello principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAttributes(attributes)TableCellConsente di impostare gli attributi dell'elemento.
setBackgroundColor(color)TableCellImposta il colore dello sfondo.
setLinkUrl(url)TableCellImposta l'URL del link.
setPaddingBottom(paddingBottom)TableCellImposta la spaziatura interna inferiore in punti.
setPaddingLeft(paddingLeft)TableCellImposta la spaziatura interna sinistra in punti.
setPaddingRight(paddingRight)TableCellImposta la spaziatura interna corretta in punti.
setPaddingTop(paddingTop)TableCellImposta la spaziatura interna superiore in punti.
setText(text)TableCellImposta i contenuti come testo normale.
setTextAlignment(textAlignment)TableCellImposta l'allineamento del testo.
setVerticalAlignment(alignment)TableCellConsente di impostare l'allineamento verticale.
setWidth(width)TableCellImposta la larghezza in punti della colonna contenente la cella corrente.

TableOfContents

Metodi

MetodoTipo restituitoBreve descrizione
clear()TableOfContentsCancella i contenuti dell'elemento.
copy()TableOfContentsRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getLinkUrl()StringRecupera l'URL del link.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
removeFromParent()TableOfContentsRimuove l'elemento da quello principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAttributes(attributes)TableOfContentsConsente di impostare gli attributi dell'elemento.
setLinkUrl(url)TableOfContentsImposta l'URL del link.
setTextAlignment(textAlignment)TableOfContentsImposta l'allineamento del testo.

TableRow

Metodi

MetodoTipo restituitoBreve descrizione
appendTableCell()TableCellCrea e aggiunge un nuovo TableCell.
appendTableCell(textContents)TableCellAggiungi il valore TableCell specificato contenente il testo specificato.
appendTableCell(tableCell)TableCellAggiungi il valore TableCell specificato.
clear()TableRowCancella i contenuti dell'elemento.
copy()TableRowRestituisce una copia diretta scollegata dell'elemento corrente.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findElement(elementType)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato.
findElement(elementType, from)RangeElementCerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal specificato RangeElement.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getCell(cellIndex)TableCellRecupera TableCell nell'indice di cella specificato.
getChild(childIndex)ElementRecupera l'elemento figlio nell'indice figlio specificato.
getChildIndex(child)IntegerRecupera l'indice figlio per l'elemento figlio specificato.
getLinkUrl()StringRecupera l'URL del link.
getMinimumHeight()NumberRecupera l'altezza minima, in punti.
getNextSibling()ElementRecupera l'elemento di pari livello successivo dell'elemento.
getNumCells()IntegerRecupera il numero di celle nella riga.
getNumChildren()IntegerRecupera il numero di elementi figlio.
getParent()ContainerElementRecupera l'elemento principale dell'elemento.
getParentTable()TableRecupera il valore Table contenente la riga corrente.
getPreviousSibling()ElementRecupera l'elemento di pari livello precedente dell'elemento.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
insertTableCell(childIndex)TableCellCrea e inserisce un nuovo TableCell nell'indice specificato.
insertTableCell(childIndex, textContents)TableCellInserisce il valore TableCell specificato nell'indice specificato, contenente il testo specificato.
insertTableCell(childIndex, tableCell)TableCellInserisce il valore TableCell specificato nell'indice specificato.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
merge()TableRowUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeCell(cellIndex)TableCellRimuove il valore TableCell in corrispondenza dell'indice di cella specificato.
removeChild(child)TableRowRimuove l'elemento secondario specificato.
removeFromParent()TableRowRimuove l'elemento da quello principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAttributes(attributes)TableRowConsente di impostare gli attributi dell'elemento.
setLinkUrl(url)TableRowImposta l'URL del link.
setMinimumHeight(minHeight)TableRowConsente di impostare l'altezza minima in punti.
setTextAlignment(textAlignment)TableRowImposta l'allineamento del testo.

Text

Metodi

MetodoTipo restituitoBreve descrizione
appendText(text)TextAggiunge il testo specificato alla fine di questa regione di testo.
copy()TextRestituisce una copia diretta scollegata dell'elemento corrente.
deleteText(startOffset, endOffsetInclusive)TextConsente di eliminare un intervallo di testo.
editAsText()TextConsente di ottenere una versione Text dell'elemento corrente, da modificare.
findText(searchPattern)RangeElementCerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
findText(searchPattern, from)RangeElementCerca i contenuti dell'elemento per il pattern di testo specificato, a partire da un determinato risultato di ricerca.
getAttributes()ObjectRecupera gli attributi dell'elemento.
getAttributes(offset)ObjectRecupera gli attributi all'offset del carattere specificato.
getBackgroundColor()StringRecupera l'impostazione del colore di sfondo.
getBackgroundColor(offset)StringRecupera il colore di sfondo in base all'offset del carattere specificato.
getFontFamily()StringRecupera l'impostazione della famiglia di caratteri.
getFontFamily(offset)StringRecupera la famiglia di caratteri all'offset del carattere specificato.
getFontSize()NumberRecupera l'impostazione della dimensione del carattere.
getFontSize(offset)NumberRecupera la dimensione del carattere all'offset del carattere specificato.
getForegroundColor()StringRecupera l'impostazione del colore in primo piano.
getForegroundColor(offset)StringRecupera il colore in primo piano all'offset dei caratteri specificato.
getLinkUrl()StringRecupera l'URL del link.
getLinkUrl(offset)StringRecupera l'URL del link all'offset di caratteri specificato.
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.
getText()StringRecupera i contenuti dell'elemento come stringa di testo.
getTextAlignment()TextAlignmentOttiene l'allineamento del testo.
getTextAlignment(offset)TextAlignmentRestituisce l'allineamento del testo per un singolo carattere.
getTextAttributeIndices()Integer[]Recupera l'insieme di indici di testo che corrispondono all'inizio di una formattazione di testo distinta viene eseguito.
getType()ElementTypeRecupera il valore ElementType dell'elemento.
insertText(offset, text)TextInserisce il testo specificato in corrispondenza dell'offset di caratteri specificato.
isAtDocumentEnd()BooleanDetermina se l'elemento si trova alla fine di Document.
isBold()BooleanRecupera l'impostazione in grassetto.
isBold(offset)BooleanRecupera l'impostazione del grassetto in corrispondenza dell'offset di caratteri specificato.
isItalic()BooleanRecupera l'impostazione in corsivo.
isItalic(offset)BooleanRecupera l'impostazione del corsivo in corrispondenza dell'offset del carattere specificato.
isStrikethrough()BooleanRecupera l'impostazione barrato.
isStrikethrough(offset)BooleanRecupera l'impostazione di barrato in corrispondenza dell'offset di caratteri specificato.
isUnderline()BooleanRecupera l'impostazione della sottolineatura.
isUnderline(offset)BooleanRecupera l'impostazione della sottolineatura in corrispondenza dell'offset del carattere specificato.
merge()TextUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()TextRimuove l'elemento da quello principale.
replaceText(searchPattern, replacement)ElementSostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando regolari le espressioni regolari.
setAttributes(startOffset, endOffsetInclusive, attributes)TextApplica gli attributi specificati all'intervallo di caratteri specificato.
setAttributes(attributes)TextConsente di impostare gli attributi dell'elemento.
setBackgroundColor(startOffset, endOffsetInclusive, color)TextImposta il colore di sfondo per l'intervallo di caratteri specificato.
setBackgroundColor(color)TextImposta il colore dello sfondo.
setBold(bold)TextConsente di impostare il grassetto.
setBold(startOffset, endOffsetInclusive, bold)TextConsente di impostare il grassetto per l'intervallo di caratteri specificato.
setFontFamily(startOffset, endOffsetInclusive, fontFamilyName)TextImposta la famiglia di caratteri per l'intervallo di caratteri specificato.
setFontFamily(fontFamilyName)TextImposta la famiglia di caratteri.
setFontSize(startOffset, endOffsetInclusive, size)TextImposta la dimensione del carattere per l'intervallo di caratteri specificato.
setFontSize(size)TextImposta la dimensione del carattere.
setForegroundColor(startOffset, endOffsetInclusive, color)TextImposta il colore di primo piano per l'intervallo di caratteri specificato.
setForegroundColor(color)TextImposta il colore del primo piano.
setItalic(italic)TextConsente di impostare l'impostazione del corsivo.
setItalic(startOffset, endOffsetInclusive, italic)TextConsente di impostare il corsivo per l'intervallo di caratteri specificato.
setLinkUrl(startOffset, endOffsetInclusive, url)TextImposta l'URL del link per l'intervallo di caratteri specificato.
setLinkUrl(url)TextImposta l'URL del link.
setStrikethrough(strikethrough)TextConsente di impostare l'impostazione del testo barrato.
setStrikethrough(startOffset, endOffsetInclusive, strikethrough)TextConsente di configurare l'impostazione barrato per l'intervallo di caratteri specificato.
setText(text)TextImposta i contenuti del testo.
setTextAlignment(startOffset, endOffsetInclusive, textAlignment)TextImposta l'allineamento del testo per un determinato intervallo di caratteri.
setTextAlignment(textAlignment)TextImposta l'allineamento del testo.
setUnderline(underline)TextConsente di impostare l'impostazione per la sottolineatura.
setUnderline(startOffset, endOffsetInclusive, underline)TextConsente di configurare l'impostazione di sottolineatura per l'intervallo di caratteri specificato.

TextAlignment

Proprietà

ProprietàTipoDescrizione
NORMALEnumAllineamento normale del testo.
SUPERSCRIPTEnumL'allineamento del testo in apice.
SUBSCRIPTEnumL'allineamento del testo in pedice.

UnsupportedElement

Metodi

MetodoTipo restituitoBreve descrizione
copy()UnsupportedElementRestituisce 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()UnsupportedElementUnisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
removeFromParent()UnsupportedElementRimuove l'elemento da quello principale.
setAttributes(attributes)UnsupportedElementConsente di impostare gli attributi dell'elemento.

VerticalAlignment

Proprietà

ProprietàTipoDescrizione
BOTTOMEnumL'opzione di allineamento in basso.
CENTEREnumL'opzione di allineamento al centro.
TOPEnumL'opzione di allineamento in alto.