Un elemento che rappresenta un paragrafo. Un elemento Paragraph
può contenere elementi Equation
, Footnote
, Horizontal
, Inline
, Inline
, Page
e Text
. Per ulteriori informazioni sulla struttura del documento, consulta la guida all'estensione di Documenti Google.
Paragraphs
non può contenere caratteri di nuova riga. I caratteri di nuova riga ("\n") vengono
convertiti in caratteri di interruzione riga ("\r").
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Append a tab header paragraph. const header = body.appendParagraph('A Document'); header.setHeading(DocumentApp.ParagraphHeading.HEADING1); // Append a section header paragraph. const section = body.appendParagraph('Section 1'); section.setHeading(DocumentApp.ParagraphHeading.HEADING2); // Append a regular paragraph. body.appendParagraph('This is a typical paragraph.');
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
add | Positioned | Crea e inserisce un nuovo Positioned dal blob immagine specificato. |
append | Horizontal | Crea e aggiunge un nuovo Horizontal . |
append | Inline | Crea e aggiunge un nuovo Inline dal blob immagine specificato. |
append | Inline | Aggiunge il Inline specificato. |
append | Page | Crea e aggiunge un nuovo Page . |
append | Page | Aggiunge il Page specificato. |
append | Text | Crea e aggiunge un nuovo elemento Text con i contenuti specificati. |
append | Text | Collega l'elemento Text specificato. |
clear() | Paragraph | Cancella i contenuti dell'elemento. |
copy() | Paragraph | Restituisce una copia approfondita e scollegata dell'elemento corrente. |
edit | Text | Consente di ottenere una versione Text dell'elemento corrente da modificare. |
find | Range | Cerca nei contenuti dell'elemento un discendente del tipo specificato. |
find | Range | Cerca nei contenuti dell'elemento un discendente del tipo specificato, a partire dal Range specificato. |
find | Range | Cerca, nei contenuti dell'elemento, il pattern di testo specificato utilizzando le espressioni regolari. |
find | Range | Cerca il pattern di testo specificato nei contenuti dell'elemento, a partire da un determinato risultato di ricerca. |
get | Horizontal | Recupera il Horizontal . |
get | Object | Recupera gli attributi dell'elemento. |
get | Element | Recupera l'elemento figlio all'indice figlio specificato. |
get | Integer | Recupera l'indice dell'elemento secondario per l'elemento secondario specificato. |
get | Paragraph | Recupera il Paragraph . |
get | Number | Recupera il rientro finale in punti. |
get | Number | Recupera il rientro della prima riga, in punti. |
get | Number | Recupera l'indentation iniziale. |
get | Number | Recupera l'interlinea in punti. |
get | String | Recupera l'URL del link. |
get | Element | Recupera l'elemento successivo associato all'elemento. |
get | Integer | Recupera il numero di bambini. |
get | Container | Recupera l'elemento principale dell'elemento. |
get | Positioned | Recupera un Positioned in base all'ID dell'immagine. |
get | Positioned | Recupera tutti gli oggetti Positioned ancorati al paragrafo. |
get | Element | Recupera l'elemento precedente associato all'elemento. |
get | Number | Recupera la spaziatura dopo l'elemento, in punti. |
get | Number | Recupera la spaziatura prima dell'elemento, in punti. |
get | String | Recupera i contenuti dell'elemento come stringa di testo. |
get | Text | Restituisce l'allineamento del testo. |
get | Element | Recupera il Element dell'elemento. |
insert | Horizontal | Crea e inserisce un Horizontal nell'indice specificato. |
insert | Inline | Crea e inserisce un nuovo Inline dal blob immagine specificato nell'indice specificato. |
insert | Inline | Inserisce il valore Inline specificato nell'indice specificato. |
insert | Page | Crea e inserisce un nuovo Page nell'indice specificato. |
insert | Page | Inserisce il valore Page specificato nell'indice specificato. |
insert | Text | Crea e inserisce un nuovo elemento di testo nell'indice specificato. |
insert | Text | Inserisce l'elemento Text specificato nell'indice specificato, con i contenuti di testo specificati. |
is | Boolean | Determina se l'elemento è alla fine del Document . |
is | Boolean | Recupera l'impostazione da sinistra a destra. |
merge() | Paragraph | Unisce l'elemento all'elemento precedente dello stesso tipo. |
remove | Paragraph | Rimuove l'elemento figlio specificato. |
remove | Paragraph | Rimuove l'elemento dal relativo elemento principale. |
remove | Boolean | Rimuove un Positioned dall'ID immagine. |
replace | Element | Sostituisce tutte le occorrenze di un determinato pattern di testo con una determinata stringa di sostituzione, utilizzando espressioni regolari. |
set | Paragraph | Imposta Horizontal . |
set | Paragraph | Imposta gli attributi dell'elemento. |
set | Paragraph | Imposta Paragraph . |
set | Paragraph | Imposta il rientro finale in punti. |
set | Paragraph | Imposta il rientro della prima riga in punti. |
set | Paragraph | Imposta il rientro iniziale in punti. |
set | Paragraph | Imposta l'impostazione da sinistra a destra. |
set | Paragraph | Imposta lo spazio interlinea, come una quantità che indica il numero di righe da utilizzare per lo spazio. |
set | Paragraph | Imposta l'URL del link. |
set | Paragraph | Imposta la spaziatura dopo l'elemento, in punti. |
set | Paragraph | Imposta la spaziatura prima dell'elemento in punti. |
set | void | Imposta i contenuti del paragrafo come testo. |
set | Paragraph | Imposta l'allineamento del testo. |
Documentazione dettagliata
addPositionedImage(image)
Crea e inserisce un nuovo Positioned
dal blob immagine specificato.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Fetches the specified image URL. const image = UrlFetchApp.fetch( 'https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-24dp/logo_apps_script_color_1x_web_24dp.png', ); // Adds the image to the tab, anchored to the first paragraph. paragraph.addPositionedImage(image);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
image | Blob | I dati immagine. |
Invio
Positioned
: 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 Horizontal
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a horizontal line under the first paragraph. paragraph.appendHorizontalRule();
Invio
Horizontal
: il nuovo righello 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 Inline
dal blob immagine specificato.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Fetches the image from the specified image URL. const image = UrlFetchApp.fetch( 'https://fonts.gstatic.com/s/i/productlogos/apps_script/v10/web-96dp/logo_apps_script_color_1x_web_96dp.png', ); // Adds the image to the first paragraph. paragraph.appendInlineImage(image);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
image | Blob | I dati immagine. |
Invio
Inline
: 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)
Aggiunge il Inline
specificato.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Makes a copy of the first image in the body. const image = body.getImages()[0].copy(); // Adds the image to the first paragraph. paragraph.appendInlineImage(image);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
image | Inline | I dati immagine. |
Invio
Inline
: 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 Page
.
Nota: Page
potrebbe non essere contenuto in Table
.
Se l'elemento corrente è contenuto in una cella di tabella, verrà lanciata un'eccezione.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a page break after the first paragraph. paragraph.appendPageBreak();
Invio
Page
: 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)
Aggiunge il Page
specificato.
Nota: Page
non può essere contenuto in Table
.
Se l'elemento corrente esiste in una cella di tabella, lo script genera un'eccezione.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a page break after the first paragraph. const pageBreak = paragraph.appendPageBreak(); // Makes a copy of the page break. const newPageBreak = pageBreak.copy(); // Adds the copied page break to the paragraph. paragraph.appendPageBreak(newPageBreak);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
page | Page | L'interruzione di pagina da aggiungere. |
Invio
Page
: 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.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Adds a string to the paragraph. paragraph.appendText('This is a new sentence.');
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | I contenuti del testo. |
Invio
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)
Collega l'elemento Text
specificato.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the text from the first paragraph in the body. const paragraph1 = body.getParagraphs()[0]; const text = paragraph1.getText(); // Gets the third paragraph in the body. const paragraph3 = body.getParagraphs()[2]; // Adds the text from the first paragraph to the third paragraph. paragraph3.appendText(text);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | Text | L'elemento di testo da accodare. |
Invio
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 approfondita e scollegata dell'elemento corrente.
Vengono copiati anche gli eventuali elementi secondari presenti nell'elemento. Il nuovo elemento non ha un elemento primario.
Invio
Paragraph
: 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 da modificare.
Utilizza edit
per manipolare i contenuti degli elementi come testo avanzato. La modalità edit
ignora gli elementi non di testo (come Inline
e Horizontal
).
Gli elementi secondari completamente contenuti in un intervallo di testo eliminato vengono rimossi dall'elemento.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().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);
Invio
Text
: una versione di testo dell'elemento corrente
findElement(elementType)
Cerca nei contenuti dell'elemento un discendente del tipo specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
element | Element | Il tipo di elemento da cercare. |
Invio
Range
: 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 Range
specificato.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Define the search parameters. let searchResult = null; // Search until the paragraph is found. while ( (searchResult = body.findElement( DocumentApp.ElementType.PARAGRAPH, searchResult, ))) { const par = searchResult.getElement().asParagraph(); if (par.getHeading() === DocumentApp.ParagraphHeading.HEADING1) { // Found one, update and stop. par.setText('This is the first header.'); break; } }
Parametri
Nome | Tipo | Descrizione |
---|---|---|
element | Element | Il tipo di elemento da cercare. |
from | Range | Il risultato di ricerca da cui effettuare la ricerca. |
Invio
Range
: 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 le espressioni regolari.
Un sottoinsieme delle funzionalità delle espressioni regolari di JavaScript non è completamente supportato, ad esempio i gruppi di cattura e i modificatori di modalità.
Il pattern di espressione regolare fornito viene abbinato in modo indipendente a ogni blocco di testo contenuto nell'elemento corrente.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
search | String | lo schema da cercare |
Invio
Range
: un risultato di ricerca che indica la posizione del testo di ricerca oppure null se non esiste alcuna 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 il pattern di testo specificato nei contenuti dell'elemento, a partire da un determinato risultato di ricerca.
Un sottoinsieme delle funzionalità delle espressioni regolari di JavaScript non è completamente supportato, ad esempio i gruppi di cattura e i modificatori di modalità.
Il pattern di espressione regolare fornito viene abbinato in modo indipendente a ogni blocco di testo contenuto nell'elemento corrente.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
search | String | lo schema da cercare |
from | Range | il risultato di ricerca da cui effettuare la ricerca |
Invio
Range
: un risultato di ricerca che indica la posizione successiva del testo di ricerca oppure null se non esiste alcuna 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 Horizontal
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Gets the first paragraph from the body. const paragraph = body.getParagraphs()[0]; // Sets the horizontal alignment to left for the first paragraph. paragraph.setAlignment(DocumentApp.HorizontalAlignment.LEFT); // Gets the horizontal alignment of the first paragraph and logs it to the // console. console.log(paragraph.getAlignment().toString());
Invio
Horizontal
: 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 elemento valido, in cui ogni nome della proprietà corrisponde a un elemento dell'enumerazione Document
.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Append a styled paragraph. const par = body.appendParagraph('A bold, italicized paragraph.'); par.setBold(true); par.setItalic(true); // Retrieve the paragraph's attributes. const atts = par.getAttributes(); // Log the paragraph attributes. for (const att in atts) { Logger.log(`${att}:${atts[att]}`); }
Invio
Object
: gli attributi dell'elemento.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getChild(childIndex)
Recupera l'elemento figlio all'indice figlio specificato.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Obtain the first element in the tab. const 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 |
---|---|---|
child | Integer | L'indice dell'elemento secondario da recuperare. |
Invio
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 dell'elemento secondario per l'elemento secondario specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Element | L'elemento secondario per cui recuperare l'indice. |
Invio
Integer
: l'indice secondario.
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
getHeading()
Recupera il Paragraph
.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. // TODO(developer): Replace the ID with your own. const doc = DocumentApp.openById('123abc'); // Gets the body contents of the tab by its ID. // TODO(developer): Replace the ID with your own. const body = doc.getTab('123abc').asDocumentTab().getBody(); // Adds a paragraph to the body. const paragraph = body.appendParagraph('Title heading'); // Sets the paragraph heading style to 'Title.' paragraph.setHeading(DocumentApp.ParagraphHeading.TITLE); // Gets the heading style and logs it to the console. console.log(paragraph.getHeading().toString());
Invio
Paragraph
: 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.
Invio
Number
: il 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.
Invio
Number
: il 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 l'indentation iniziale.
Invio
Number
: il 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.
Invio
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.
Invio
String
: l'URL del link o 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
getNextSibling()
Recupera l'elemento successivo associato all'elemento.
L'elemento successivo ha lo stesso elemento principale e segue l'elemento corrente.
Invio
Element
: l'elemento successivo associato.
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.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Log the number of elements in the tab. Logger.log(`There are ${body.getNumChildren()} elements in the tab's body.`);
Invio
Integer
: il numero di bambini.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
getParent()
Recupera l'elemento principale dell'elemento.
L'elemento principale contiene l'elemento corrente.
Invio
Container
: 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 Positioned
in base all'ID dell'immagine.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
id | String | l'ID immagine |
Invio
Positioned
: 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()
Recupera tutti gli oggetti Positioned
ancorati al paragrafo.
Invio
Positioned
: 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 precedente associato all'elemento.
L'elemento precedente associato ha lo stesso elemento principale e precede l'elemento corrente.
Invio
Element
: l'elemento precedente associato.
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.
Invio
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.
Invio
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.
Invio
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()
Restituisce l'allineamento del testo. I tipi di allineamento disponibili sono Document
, Document
e Document
.
Invio
Text
: il tipo di allineamento del testo oppure null
se il testo contiene più tipi di allineamento del testo 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 il Element
dell'elemento.
Utilizza get
per determinare il tipo esatto di un determinato elemento.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Obtain the first element in the active tab's body. const firstChild = body.getChild(0); // Use getType() to determine the element's type. if (firstChild.getType() === DocumentApp.ElementType.PARAGRAPH) { Logger.log('The first element is a paragraph.'); } else { Logger.log('The first element is not a paragraph.'); }
Invio
Element
: 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 Horizontal
nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | l'indice in cui inserire l'elemento |
Invio
Horizontal
: il nuovo elemento righello 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 Inline
dal blob immagine specificato nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | l'indice in cui inserire l'elemento |
image | Blob | i dati immagine |
Invio
Inline
: 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 Inline
specificato nell'indice specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | l'indice in cui inserire l'elemento |
image | Inline | i dati immagine |
Invio
Inline
: 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 Page
nell'indice specificato.
Nota: Page
potrebbe non essere contenuto in Table
.
Se l'elemento corrente è contenuto in una cella di tabella, verrà lanciata un'eccezione.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | l'indice in cui inserire l'elemento |
Invio
Page
: 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 Page
specificato nell'indice specificato.
Nota: Page
potrebbe non essere contenuto in Table
.
Se l'elemento corrente è contenuto in una cella di tabella, verrà lanciata un'eccezione.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | l'indice in cui inserire l'elemento |
page | Page | l'interruzione di pagina da inserire |
Invio
Page
: 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 |
---|---|---|
child | Integer | l'indice in cui inserire l'elemento |
text | String | i contenuti del testo |
Invio
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 di testo specificati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Integer | l'indice in cui inserire l'elemento |
text | Text | l'elemento di testo da inserire |
Invio
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 è alla fine del Document
.
Invio
Boolean
: indica se l'elemento si trova alla fine della scheda.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
isLeftToRight()
Recupera l'impostazione da sinistra a destra.
Invio
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 all'elemento precedente dello stesso tipo.
È possibile unire solo elementi dello stesso Element
. Tutti gli elementi secondari contenuti nell'elemento corrente vengono spostati nell'elemento precedente associato.
L'elemento corrente viene rimosso dal documento.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Example 1: Merge paragraphs // Append two paragraphs to the document's active tab. const par1 = body.appendParagraph('Paragraph 1.'); const par2 = body.appendParagraph('Paragraph 2.'); // Merge the newly added paragraphs into a single paragraph. par2.merge(); // Example 2: Merge table cells // Create a two-dimensional array containing the table's cell contents. const cells = [ ['Row 1, Cell 1', 'Row 1, Cell 2'], ['Row 2, Cell 1', 'Row 2, Cell 2'], ]; // Build a table from the array. const table = body.appendTable(cells); // Get the first row in the table. const row = table.getRow(0); // Get the two cells in this row. const cell1 = row.getCell(0); const cell2 = row.getCell(1); // Merge the current cell into its preceding sibling element. const merged = cell2.merge();
Invio
Paragraph
: 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 figlio specificato.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
child | Element | l'elemento secondario da rimuovere |
Invio
Paragraph
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
removeFromParent()
Rimuove l'elemento dal relativo elemento principale.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Remove all images in the active tab's body. const imgs = body.getImages(); for (let i = 0; i < imgs.length; i++) { imgs[i].removeFromParent(); }
Invio
Paragraph
: 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 Positioned
dall'ID immagine.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
id | String | l'ID immagine |
Invio
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 di sostituzione, utilizzando espressioni regolari.
Il pattern di ricerca viene passato come stringa, non come oggetto espressione regolare JavaScript. Per questo motivo, dovrai eseguire l'escape di eventuali barre rovesciate nello schema.
Questi metodi utilizzano la libreria di espressioni regolari RE2 di Google, che limita la sintassi supportata.
Il pattern di espressione regolare fornito viene abbinato in modo indipendente a ogni blocco di testo contenuto nell'elemento corrente.
const body = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab().getBody(); // Clear the text surrounding "Apps Script", with or without text. body.replaceText('^.*Apps ?Script.*$', 'Apps Script');
Parametri
Nome | Tipo | Descrizione |
---|---|---|
search | String | lo schema regex da cercare |
replacement | String | Il testo da utilizzare come sostituto |
Invio
Element
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAlignment(alignment)
Imposta Horizontal
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
alignment | Horizontal | l'allineamento orizzontale |
Invio
Paragraph
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setAttributes(attributes)
Imposta gli attributi dell'elemento.
Il parametro degli attributi specificato deve essere un oggetto in cui ogni nome della proprietà è un elemento dell'enumerazione Document
e ogni valore della proprietà è il nuovo valore da applicare.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); const body = documentTab.getBody(); // Define a custom paragraph style. const style = {}; style[DocumentApp.Attribute.HORIZONTAL_ALIGNMENT] = DocumentApp.HorizontalAlignment.RIGHT; style[DocumentApp.Attribute.FONT_FAMILY] = 'Calibri'; style[DocumentApp.Attribute.FONT_SIZE] = 18; style[DocumentApp.Attribute.BOLD] = true; // Append a plain paragraph. const par = body.appendParagraph('A paragraph with custom style.'); // Apply the custom style. par.setAttributes(style);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
attributes | Object | Gli attributi dell'elemento. |
Invio
Paragraph
: l'elemento corrente.
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setHeading(heading)
Imposta Paragraph
.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
heading | Paragraph | l'intestazione |
Invio
Paragraph
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentEnd(indentEnd)
Imposta il rientro finale in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
indent | Number | il rientro finale, in punti |
Invio
Paragraph
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentFirstLine(indentFirstLine)
Imposta il rientro della prima riga in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
indent | Number | il rientro della prima riga, in punti |
Invio
Paragraph
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setIndentStart(indentStart)
Imposta il rientro iniziale in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
indent | Number | il rientro iniziale, in punti |
Invio
Paragraph
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLeftToRight(leftToRight)
Imposta l'impostazione da sinistra a destra.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
left | Boolean | l'impostazione da sinistra a destra |
Invio
Paragraph
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLineSpacing(multiplier)
Imposta lo spazio interlinea, come una quantità che indica il numero di righe da utilizzare per lo spazio.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
multiplier | Number | il numero di righe |
Invio
Paragraph
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setLinkUrl(url)
Imposta l'URL del link.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
url | String | l'URL del link |
Invio
Paragraph
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSpacingAfter(spacingAfter)
Imposta la spaziatura dopo l'elemento, in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
spacing | Number | la spaziatura dopo l'elemento, in punti |
Invio
Paragraph
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setSpacingBefore(spacingBefore)
Imposta la spaziatura prima dell'elemento in punti.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
spacing | Number | la spaziatura prima dell'elemento, in punti |
Invio
Paragraph
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents
setText(text)
Imposta i contenuti del paragrafo come testo.
Nota: i contenuti esistenti vengono cancellati.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | String | i nuovi contenuti del 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
setTextAlignment(textAlignment)
Imposta l'allineamento del testo. I tipi di allineamento disponibili sono Document
, Document
e Document
.
// Make the entire first paragraph in the active tab be superscript. const documentTab = DocumentApp.getActiveDocument().getActiveTab().asDocumentTab(); const text = documentTab.getBody().getParagraphs()[0].editAsText(); text.setTextAlignment(DocumentApp.TextAlignment.SUPERSCRIPT);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
text | Text | il tipo di allineamento del testo da applicare |
Invio
Paragraph
: l'elemento corrente
Autorizzazione
Gli script che utilizzano questo metodo richiedono l'autorizzazione con uno o più dei seguenti ambiti:
-
https://www.googleapis.com/auth/documents.currentonly
-
https://www.googleapis.com/auth/documents