Un elemento che rappresenta un elemento dell'elenco. Un ListItem
è un Paragraph
associato
a un ID elenco. Un elemento ListItem
può contenere gli elementi Equation
, Footnote
, HorizontalRule
, InlineDrawing
, InlineImage
, PageBreak
e Text
. Per ulteriori informazioni sulla struttura dei documenti, consulta la guida all'estensione di Documenti Google.
Il campo ListItems
non può contenere caratteri di nuova riga. I caratteri delle nuove righe ("\n") vengono convertiti in caratteri di interruzione di riga ("\r").
ListItems
con lo stesso ID elenco appartengono allo stesso elenco e sono numerati di conseguenza.
L'elemento ListItems
di un determinato elenco non deve necessariamente essere adiacente al documento o avere lo stesso elemento principale. Due elementi appartenenti allo stesso elenco possono esistere in qualsiasi punto del
documento mantenendo la numerazione consecutiva, come illustrato nell'esempio seguente:
var body = DocumentApp.getActiveDocument().getBody(); // Append a new list item to the body. var item1 = body.appendListItem('Item 1'); // Log the new list item's list ID. Logger.log(item1.getListId()); // Append a table after the list item. body.appendTable([ ['Cell 1', 'Cell 2'] ]); // Append a second list item with the same list ID. The two items are treated as the same list, // despite not being consecutive. var item2 = body.appendListItem('Item 2'); item2.setListId(item1);
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
addPositionedImage(image) | PositionedImage | Crea e inserisce un nuovo PositionedImage dal blob di immagine specificato. |
appendHorizontalRule() | HorizontalRule | Crea e aggiunge un nuovo HorizontalRule . |
appendInlineImage(image) | InlineImage | Crea e aggiunge un nuovo InlineImage dal blob di immagine specificato. |
appendInlineImage(image) | InlineImage | Accoda il valore InlineImage specificato. |
appendPageBreak() | PageBreak | Crea e aggiunge un nuovo PageBreak . |
appendPageBreak(pageBreak) | PageBreak | Accoda il valore PageBreak specificato. |
appendText(text) | Text | Crea e aggiunge un nuovo elemento Text con i contenuti specificati. |
appendText(text) | Text | Accoda l'elemento Text specificato. |
clear() | ListItem | Consente di cancellare i contenuti dell'elemento. |
copy() | ListItem | Restituisce una copia separata e approfondita dell'elemento corrente. |
editAsText() | Text | Consente di ottenere una versione Text dell'elemento corrente, per la modifica. |
findElement(elementType) | RangeElement | Cerca nei contenuti dell'elemento un discendente del tipo specificato. |
findElement(elementType, from) | RangeElement | Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal valore RangeElement specificato. |
findText(searchPattern) | RangeElement | Cerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari. |
findText(searchPattern, from) | RangeElement | Cerca nei contenuti dell'elemento il pattern di testo specificato, a partire da un determinato risultato di ricerca. |
getAlignment() | HorizontalAlignment | Recupera il file HorizontalAlignment . |
getAttributes() | Object | Recupera gli attributi dell'elemento. |
getChild(childIndex) | Element | Recupera l'elemento secondario nell'indice figlio specificato. |
getChildIndex(child) | Integer | Recupera l'indice figlio per l'elemento secondario specificato. |
getGlyphType() | GlyphType | Recupera l'elemento GlyphType della voce elenco. |
getHeading() | ParagraphHeading | Recupera il file ParagraphHeading . |
getIndentEnd() | Number | Recupera il rientro finale, in punti. |
getIndentFirstLine() | Number | Recupera il rientro della prima riga, in punti. |
getIndentStart() | Number | Recupera il rientro iniziale. |
getLineSpacing() | Number | Recupera l'interlinea in punti. |
getLinkUrl() | String | Recupera l'URL del link. |
getListId() | String | Recupera l'ID elenco. |
getNestingLevel() | Integer | Recupera il livello di annidamento dell'elemento dell'elenco. |
getNextSibling() | Element | Recupera l'elemento di pari livello successivo dell'elemento. |
getNumChildren() | Integer | Recupera il numero di bambini. |
getParent() | ContainerElement | Recupera l'elemento principale dell'elemento. |
getPositionedImage(id) | PositionedImage | Recupera un PositionedImage dall'ID dell'immagine. |
getPositionedImages() | PositionedImage[] | Visualizza tutti i PositionedImage oggetti ancorati al paragrafo. |
getPreviousSibling() | Element | Recupera l'elemento di pari livello precedente dell'elemento. |
getSpacingAfter() | Number | Recupera la spaziatura dopo l'elemento, in punti. |
getSpacingBefore() | Number | Recupera la spaziatura prima dell'elemento, in punti. |
getText() | String | Recupera i contenuti dell'elemento come stringa di testo. |
getTextAlignment() | TextAlignment | Consente di acquisire l'allineamento del testo. |
getType() | ElementType | Recupera l'elemento ElementType dell'elemento. |
insertHorizontalRule(childIndex) | HorizontalRule | Crea e inserisce un HorizontalRule nell'indice specificato. |
insertInlineImage(childIndex, image) | InlineImage | Crea e inserisce un nuovo InlineImage dal blob di immagine specificato, nell'indice specificato. |
insertInlineImage(childIndex, image) | InlineImage | Inserisce il valore InlineImage specificato nell'indice specificato. |
insertPageBreak(childIndex) | PageBreak | Crea e inserisce un nuovo valore PageBreak nell'indice specificato. |
insertPageBreak(childIndex, pageBreak) | PageBreak | Inserisce il valore PageBreak specificato nell'indice specificato. |
insertText(childIndex, text) | Text | Crea e inserisce un nuovo elemento di testo nell'indice specificato. |
insertText(childIndex, text) | Text | Inserisce l'elemento Text specificato nell'indice specificato, con i contenuti testuali specificati. |
isAtDocumentEnd() | Boolean | Determina se l'elemento si trova alla fine di Document . |
isLeftToRight() | Boolean | Recupera l'impostazione da sinistra a destra. |
merge() | ListItem | Unisce l'elemento con l'elemento di pari livello precedente dello stesso tipo. |
removeChild(child) | ListItem | Rimuove l'elemento secondario specificato. |
removeFromParent() | ListItem | Rimuove l'elemento dal relativo elemento principale. |
removePositionedImage(id) | Boolean | Rimuove un PositionedImage in base all'ID dell'immagine. |
replaceText(searchPattern, replacement) | Element | Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando le espressioni regolari. |
setAlignment(alignment) | ListItem | Imposta HorizontalAlignment . |
setAttributes(attributes) | ListItem | Imposta gli attributi dell'elemento. |
setGlyphType(glyphType) | ListItem | Imposta il valore GlyphType dell'elemento dell'elenco. |
setHeading(heading) | ListItem | Imposta ParagraphHeading . |
setIndentEnd(indentEnd) | ListItem | Imposta il rientro finale in punti. |
setIndentFirstLine(indentFirstLine) | ListItem | Imposta il rientro della prima riga, in punti. |
setIndentStart(indentStart) | ListItem | Imposta il rientro iniziale in punti. |
setLeftToRight(leftToRight) | ListItem | Consente di impostare l'impostazione da sinistra a destra. |
setLineSpacing(multiplier) | ListItem | Imposta l'interlinea, come quantità che indica il numero di righe da utilizzare per l'interlinea. |
setLinkUrl(url) | ListItem | Imposta l'URL del link. |
setListId(listItem) | ListItem | Imposta l'ID elenco. |
setNestingLevel(nestingLevel) | ListItem | Imposta il livello di annidamento dell'elemento dell'elenco. |
setSpacingAfter(spacingAfter) | ListItem | Imposta la spaziatura dopo l'elemento, in punti. |
setSpacingBefore(spacingBefore) | ListItem | Imposta la spaziatura prima dell'elemento, in punti. |
setText(text) | void | Imposta i contenuti dell'elemento elenco come testo. |
setTextAlignment(textAlignment) | ListItem | Imposta l'allineamento del testo. |
Documentazione dettagliata
addPositionedImage(image)
Crea e inserisce un nuovo PositionedImage
dal blob di immagine specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
image | BlobSource | i dati dell'immagine |
Ritorni
PositionedImage
: la nuova immagine posizionata
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendHorizontalRule()
Crea e aggiunge un nuovo HorizontalRule
.
Ritorni
HorizontalRule
: la nuova riga orizzontale
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendInlineImage(image)
Crea e aggiunge un nuovo InlineImage
dal blob di immagine specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
image | BlobSource | i dati dell'immagine |
Ritorni
InlineImage
: l'immagine aggiunta
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendInlineImage(image)
Accoda il valore InlineImage
specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
image | InlineImage | i dati dell'immagine |
Ritorni
InlineImage
: l'immagine aggiunta
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak()
Crea e aggiunge un nuovo PageBreak
.
Nota: PageBreaks
potrebbe non essere contenuto in TableCells
.
Se l'elemento corrente è contenuto in una cella di tabella, verrà generata un'eccezione.
Ritorni
PageBreak
: il nuovo elemento di interruzione di pagina
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendPageBreak(pageBreak)
Accoda il valore PageBreak
specificato.
Nota: PageBreaks
potrebbe non essere contenuto in TableCells
.
Se l'elemento corrente è contenuto in una cella di tabella, verrà generata un'eccezione.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
pageBreak | PageBreak | l'interruzione di pagina da aggiungere |
Ritorni
PageBreak
: l'elemento di interruzione di pagina aggiunto.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendText(text)
Crea e aggiunge un nuovo elemento Text
con i contenuti specificati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | i contenuti testuali |
Ritorni
Text
: il nuovo elemento di testo
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
appendText(text)
Accoda l'elemento Text
specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | Text | l'elemento di testo da aggiungere |
Ritorni
Text
: l'elemento di testo aggiunto
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
clear()
copy()
Restituisce una copia separata e approfondita dell'elemento corrente.
Vengono copiati anche tutti gli elementi secondari presenti nell'elemento. Il nuovo elemento non ha un elemento padre.
Ritorni
ListItem
: la nuova copia.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
editAsText()
Consente di ottenere una versione Text
dell'elemento corrente, per la modifica.
Utilizza editAsText
per manipolare i contenuti degli elementi in formato RTF. La modalità editAsText
ignora gli elementi non testuali (come InlineImage
e HorizontalRule
).
Gli elementi secondari completamente contenuti in un intervallo di testo eliminato vengono rimossi dall'elemento.
var body = DocumentApp.getActiveDocument().getBody(); // Insert two paragraphs separated by a paragraph containing an // horizontal rule. body.insertParagraph(0, "An editAsText sample."); body.insertHorizontalRule(0); body.insertParagraph(0, "An example."); // Delete " sample.\n\n An" removing the horizontal rule in the process. body.editAsText().deleteText(14, 25);
Ritorni
Text
: una versione di testo dell'elemento corrente.
findElement(elementType)
Cerca nei contenuti dell'elemento un discendente del tipo specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
elementType | ElementType | il tipo di elemento da cercare |
Ritorni
RangeElement
: un risultato di ricerca che indica la posizione dell'elemento di ricerca.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findElement(elementType, from)
Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal valore RangeElement
specificato.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Define the search parameters. var searchType = DocumentApp.ElementType.PARAGRAPH; var searchHeading = DocumentApp.ParagraphHeading.HEADING1; var searchResult = null; // Search until the paragraph is found. while (searchResult = body.findElement(searchType, searchResult)) { var par = searchResult.getElement().asParagraph(); if (par.getHeading() == searchHeading) { // Found one, update and stop. par.setText('This is the first header.'); return; } }
Parametri
Nome | Tipo | Descrizione |
---|---|---|
elementType | ElementType | il tipo di elemento da cercare |
from | RangeElement | il risultato di ricerca da cui eseguire la ricerca |
Ritorni
RangeElement
: un risultato di ricerca che indica la posizione successiva dell'elemento di ricerca.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern)
Cerca nei contenuti dell'elemento il pattern di testo specificato utilizzando espressioni regolari.
Un sottoinsieme delle funzionalità di espressione regolare JavaScript non è completamente supportato, ad esempio gruppi di acquisizione e modificatori di modalità.
Il modello di espressione regolare fornito viene confrontato in modo indipendente con ciascun blocco di testo contenuto nell'elemento corrente.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
searchPattern | String | lo schema da cercare |
Ritorni
RangeElement
: un risultato di ricerca che indica la posizione del testo di ricerca o un valore nullo in assenza di corrispondenza.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
findText(searchPattern, from)
Cerca nei contenuti dell'elemento il pattern di testo specificato, a partire da un determinato risultato di ricerca.
Un sottoinsieme delle funzionalità di espressione regolare JavaScript non è completamente supportato, ad esempio gruppi di acquisizione e modificatori di modalità.
Il modello di espressione regolare fornito viene confrontato in modo indipendente con ciascun blocco di testo contenuto nell'elemento corrente.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
searchPattern | String | lo schema da cercare |
from | RangeElement | il risultato di ricerca da cui eseguire la ricerca |
Ritorni
RangeElement
: un risultato di ricerca che indica la posizione successiva del testo di ricerca o un valore nullo in assenza di corrispondenza.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAlignment()
Recupera il file HorizontalAlignment
.
Ritorni
HorizontalAlignment
: l'allineamento
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getAttributes()
Recupera gli attributi dell'elemento.
Il risultato è un oggetto contenente una proprietà per ogni attributo valido dell'elemento in cui ogni nome della proprietà corrisponde a un elemento nell'enumerazione DocumentApp.Attribute
.
var body = DocumentApp.getActiveDocument().getBody(); // Append a styled paragraph. var par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. var atts = par.getAttributes(); // Log the paragraph attributes. for (var att in atts) { Logger.log(att + ":" + atts[att]); }
Ritorni
Object
: attributi dell'elemento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
Recupera l'elemento secondario nell'indice figlio specificato.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document. var firstChild = body.getChild(0); // If it's a paragraph, set its contents. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { firstChild.asParagraph().setText("This is the first paragraph."); }
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | l'indice dell'elemento figlio da recuperare |
Ritorni
Element
: l'elemento secondario nell'indice specificato.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChildIndex(child)
Recupera l'indice figlio per l'elemento secondario specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Element | l'elemento figlio per il quale recuperare l'indice |
Ritorni
Integer
: l'indice figlio
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getGlyphType()
getHeading()
Recupera il file ParagraphHeading
.
Ritorni
ParagraphHeading
: l'intestazione
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getIndentEnd()
Recupera il rientro finale, in punti.
Ritorni
Number
: rientro finale, in punti
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getIndentFirstLine()
Recupera il rientro della prima riga, in punti.
Ritorni
Number
: rientro della prima riga, in punti
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getIndentStart()
Recupera il rientro iniziale.
Ritorni
Number
: rientro iniziale
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLineSpacing()
Recupera l'interlinea in punti.
Ritorni
Number
: l'interlinea, in punti
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getLinkUrl()
Recupera l'URL del link.
Ritorni
String
: URL del link oppure null se l'elemento contiene più valori per questo attributo.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getListId()
Recupera l'ID elenco.
Ritorni
String
: l'ID elenco
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNestingLevel()
Recupera il livello di annidamento dell'elemento dell'elenco.
Per impostazione predefinita, gli elementi dell'elenco hanno un livello nidificato pari a zero. Il livello di nidificazione determina il glifo utilizzato dall'elemento dell'elenco.
Ritorni
Integer
: livello di annidamento
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNextSibling()
Recupera l'elemento di pari livello successivo dell'elemento.
L'elemento di pari livello successivo ha lo stesso elemento principale e segue l'elemento corrente.
Ritorni
Element
: l'elemento di pari livello successivo.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getNumChildren()
Recupera il numero di bambini.
// Get the body section of the active document. var body = DocumentApp.getActiveDocument().getBody(); // Log the number of elements in the document. Logger.log("There are " + body.getNumChildren() + " elements in the document body.");
Ritorni
Integer
: il numero di figli
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Recupera l'elemento principale dell'elemento.
L'elemento principale contiene l'elemento corrente.
Ritorni
ContainerElement
: l'elemento principale.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPositionedImage(id)
Recupera un PositionedImage
dall'ID dell'immagine.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
id | String | l'ID immagine |
Ritorni
PositionedImage
: l'immagine posizionata
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPositionedImages()
Visualizza tutti i PositionedImage
oggetti ancorati al paragrafo.
Ritorni
PositionedImage[]
: un elenco di immagini posizionate
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getPreviousSibling()
Recupera l'elemento di pari livello precedente dell'elemento.
L'elemento di pari livello precedente ha lo stesso elemento principale e precede l'elemento corrente.
Ritorni
Element
: l'elemento di pari livello precedente.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSpacingAfter()
Recupera la spaziatura dopo l'elemento, in punti.
Ritorni
Number
: la spaziatura dopo l'elemento, in punti.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getSpacingBefore()
Recupera la spaziatura prima dell'elemento, in punti.
Ritorni
Number
: la spaziatura prima dell'elemento, in punti.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getText()
Recupera i contenuti dell'elemento come stringa di testo.
Ritorni
String
: i contenuti dell'elemento come stringa di testo
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getTextAlignment()
Consente di acquisire l'allineamento del testo. I tipi di allineamento disponibili sono DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
e DocumentApp.TextAlignment.SUPERSCRIPT
.
Ritorni
TextAlignment
: il tipo di allineamento del testo oppure null
se il testo contiene più tipi di allineamenti
o se l'allineamento del testo non è mai stato impostato.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getType()
Recupera l'elemento ElementType
dell'elemento.
Utilizza getType()
per determinare il tipo esatto di un determinato elemento.
var body = DocumentApp.getActiveDocument().getBody(); // Obtain the first element in the document body. var firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() == DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Ritorni
ElementType
: il tipo di elemento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertHorizontalRule(childIndex)
Crea e inserisce un HorizontalRule
nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | l'indice in cui inserire l'elemento |
Ritorni
HorizontalRule
: il nuovo elemento della regola orizzontale
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
Crea e inserisce un nuovo InlineImage
dal blob di immagine specificato, nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | l'indice in cui inserire l'elemento |
image | BlobSource | i dati dell'immagine |
Ritorni
InlineImage
: l'elemento immagine in linea inserito
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertInlineImage(childIndex, image)
Inserisce il valore InlineImage
specificato nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | l'indice in cui inserire l'elemento |
image | InlineImage | i dati dell'immagine |
Ritorni
InlineImage
: l'elemento immagine in linea inserito
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex)
Crea e inserisce un nuovo valore PageBreak
nell'indice specificato.
Nota: PageBreaks
potrebbe non essere contenuto in TableCells
.
Se l'elemento corrente è contenuto in una cella di tabella, verrà generata un'eccezione.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | l'indice in cui inserire l'elemento |
Ritorni
PageBreak
: il nuovo elemento di interruzione di pagina
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertPageBreak(childIndex, pageBreak)
Inserisce il valore PageBreak
specificato nell'indice specificato.
Nota: PageBreaks
potrebbe non essere contenuto in TableCells
.
Se l'elemento corrente è contenuto in una cella di tabella, verrà generata un'eccezione.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | l'indice in cui inserire l'elemento |
pageBreak | PageBreak | la pausa p[age da inserire |
Ritorni
PageBreak
: l'elemento di interruzione di pagina inserito
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
Crea e inserisce un nuovo elemento di testo nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | l'indice in cui inserire l'elemento |
text | String | i contenuti testuali |
Ritorni
Text
: il nuovo elemento di testo
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
insertText(childIndex, text)
Inserisce l'elemento Text
specificato nell'indice specificato, con i contenuti testuali specificati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
childIndex | Integer | l'indice in cui inserire l'elemento |
text | Text | l'elemento di testo da inserire |
Ritorni
Text
: l'elemento di testo inserito
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isAtDocumentEnd()
Determina se l'elemento si trova alla fine di Document
.
Ritorni
Boolean
: indica se l'elemento si trova alla fine del documento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isLeftToRight()
Recupera l'impostazione da sinistra a destra.
Ritorni
Boolean
: l'impostazione da sinistra a destra
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
merge()
Unisce l'elemento con l'elemento di pari livello precedente dello stesso tipo.
È possibile unire solo gli elementi dello stesso ElementType
. Tutti gli elementi secondari contenuti nell'elemento corrente vengono spostati nell'elemento di pari livello precedente.
L'elemento corrente viene rimosso dal documento.
var body = DocumentApp.getActiveDocument().getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document. var par1 = body.appendParagraph('Paragraph 1.'); var par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. var cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'] ]; // Build a table from the array. var table = body.appendTable(cells); // Get the first row in the table. var row = table.getRow(0); // Get the two cells in this row. var cell1 = row.getCell(0); var cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. var merged = cell2.merge();
Ritorni
ListItem
: l'elemento unito.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeChild(child)
Rimuove l'elemento secondario specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Element | l'elemento secondario da rimuovere |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Rimuove l'elemento dal relativo elemento principale.
var body = DocumentApp.getActiveDocument().getBody(); // Remove all images in the document body. var imgs = body.getImages(); for (var i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Ritorni
ListItem
: l'elemento rimosso.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removePositionedImage(id)
Rimuove un PositionedImage
in base all'ID dell'immagine.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
id | String |
Ritorni
Boolean
: indica se l'immagine specificata è stata rimossa o meno
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
replaceText(searchPattern, replacement)
Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa sostitutiva, utilizzando le espressioni regolari.
Il pattern di ricerca viene passato come stringa, non come oggetto di espressione regolare JavaScript. Per questo motivo, dovrai eseguire l'escape delle barre rovesciate nel pattern.
Questo metodo utilizza la libreria di espressioni regolari RE2 di Google, che limita la sintassi supportata.
Il modello di espressione regolare fornito viene confrontato in modo indipendente con ciascun blocco di testo contenuto nell'elemento corrente.
var body = DocumentApp.getActiveDocument().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText("^.*Apps ?Script.*$", "Apps Script");
Parametri
Nome | Tipo | Descrizione |
---|---|---|
searchPattern | String | il pattern regex per cercare |
replacement | String | il testo da utilizzare come sostituzione |
Ritorni
Element
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAlignment(alignment)
Imposta HorizontalAlignment
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
alignment | HorizontalAlignment | l'allineamento orizzontale |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Imposta gli attributi dell'elemento.
Il parametro degli attributi specificato deve essere un oggetto in cui ogni nome proprietà è un elemento nell'enumerazione DocumentApp.Attribute
e ogni valore di proprietà è il nuovo valore da applicare.
var body = DocumentApp.getActiveDocument().getBody(); // Define a custom paragraph style. var style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. var par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
attributes | Object | Gli attributi dell'elemento. |
Ritorni
ListItem
: l'elemento corrente.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setGlyphType(glyphType)
Imposta il valore GlyphType
dell'elemento dell'elenco.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
glyphType | GlyphType | il tipo di glifo |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setHeading(heading)
Imposta ParagraphHeading
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
heading | ParagraphHeading | l'intestazione |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentEnd(indentEnd)
Imposta il rientro finale in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
indentEnd | Number | rientro finale, in punti |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentFirstLine(indentFirstLine)
Imposta il rientro della prima riga, in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
indentFirstLine | Number | rientro della prima riga, in punti |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentStart(indentStart)
Imposta il rientro iniziale in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
indentStart | Number | il rientro iniziale, in punti |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLeftToRight(leftToRight)
Consente di impostare l'impostazione da sinistra a destra.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
leftToRight | Boolean | l'impostazione da sinistra a destra |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLineSpacing(multiplier)
Imposta l'interlinea, come quantità che indica il numero di righe da utilizzare per l'interlinea.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
multiplier | Number | il numero di righe |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
Imposta l'URL del link.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
url | String | URL del link |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setListId(listItem)
Imposta l'ID elenco.
L'ID elenco è impostato sullo stesso valore per il valore ListItem
specificato. I due ListItems
verranno trattati come membri dello stesso elenco.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
listItem | ListItem | l'elemento dell'elenco di cui utilizzare l'ID elenco |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setNestingLevel(nestingLevel)
Imposta il livello di annidamento dell'elemento dell'elenco.
Per impostazione predefinita, gli elementi dell'elenco hanno un livello nidificato pari a zero. Il livello di nidificazione determina il glifo utilizzato dall'elemento dell'elenco.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
nestingLevel | Integer | il livello di annidamento |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSpacingAfter(spacingAfter)
Imposta la spaziatura dopo l'elemento, in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
spacingAfter | Number | la spaziatura dopo l'elemento, in punti. |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSpacingBefore(spacingBefore)
Imposta la spaziatura prima dell'elemento, in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
spacingBefore | Number | la spaziatura prima dell'elemento, in punti |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
Imposta i contenuti dell'elemento elenco come testo.
Nota: i contenuti esistenti vengono cancellati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | i nuovi contenuti testuali |
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setTextAlignment(textAlignment)
Imposta l'allineamento del testo. I tipi di allineamento disponibili sono DocumentApp.TextAlignment.NORMAL
, DocumentApp.TextAlignment.SUBSCRIPT
e DocumentApp.TextAlignment.SUPERSCRIPT
.
// Make the entire first paragraph be superscript. var text = DocumentApp.getActiveDocument().getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
textAlignment | TextAlignment | il tipo di allineamento del testo da applicare |
Ritorni
ListItem
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents