Un documento contenente uno o più oggetti Tab, ognuno dei quali contiene testo RTF ed elementi come tabelle ed elenchi.
I documenti possono essere aperti o creati utilizzando Document.
// Open a document by ID. let doc = DocumentApp.openById('<my-id>'); // Create and open a document. doc = DocumentApp.create('Document Title');
I metodi della classe Document che accedono direttamente ai contenuti di testo e li modificano operano
sulla scheda attiva (negli script vincolati a un
documento specifico) o sulla prima scheda (se non è disponibile una scheda attiva). Gli script che si basano su questi metodi (ad esempio get) possono essere migrati per supportare le schede utilizzando get e poi Tab.asDocumentTab().
Metodi
| Metodo | Tipo restituito | Breve descrizione |
|---|---|---|
add | Bookmark | Aggiunge un Bookmark al Position specificato alla prima scheda o, per gli script vincolati a un documento, alla scheda attiva. |
add | Document | Aggiunge l'utente specificato all'elenco degli editor per Document. |
add | Document | Aggiunge l'utente specificato all'elenco degli editor per Document. |
add | Document | Aggiunge l'array di utenti specificato all'elenco degli editor del Document. |
add | Footer | Aggiunge una sezione del piè di pagina, se non esiste, alla prima scheda o, per gli script vincolati a un documento, alla scheda attiva. |
add | Header | Aggiunge una sezione di intestazione, se non esiste, alla prima scheda o, per gli script vincolati a un documento, alla scheda attiva. |
add | Named | Aggiunge un Named, ovvero un Range con un nome e un ID da utilizzare per il recupero successivo, nella prima scheda o, per gli script vincolati a un documento, nella scheda attiva. |
add | Document | Aggiunge l'utente specificato all'elenco degli spettatori di Document. |
add | Document | Aggiunge l'utente specificato all'elenco degli spettatori di Document. |
add | Document | Aggiunge l'array di utenti specificato all'elenco dei visualizzatori di Document. |
get | Tab | Recupera il Tab attualmente attivo dell'utente nel documento. |
get | Blob | Recupera i contenuti correnti di Document come blob del tipo specificato. |
get | Blob | Recupera i contenuti correnti di Document come blob. |
get | Body | Recupera il Body della prima scheda o, per gli script vincolati a un documento, il Document della scheda attiva. |
get | Bookmark|null | Recupera Bookmark con l'ID specificato nella prima scheda o, per gli script vincolati a un documento, nella scheda attiva. |
get | Bookmark[] | Recupera tutti gli oggetti Bookmark nella prima scheda o, per gli script vincolati a un documento, la scheda attiva. |
get | Position|null | Recupera il cursore dell'utente nella scheda attiva. |
get | User[] | Recupera l'elenco degli editor per questo Document. |
get | Footer | Recupera la sezione del piè di pagina della prima scheda o, per gli script vincolati a un documento, la sezione del piè di pagina della scheda attiva. |
get | Footnote[]|null | Recupera tutti gli elementi Footnote nel corpo della prima scheda o, per gli script vincolati a un documento, nel corpo della scheda attiva. |
get | Header | Recupera la sezione di intestazione della prima scheda o, per gli script vincolati a un documento, la sezione di intestazione della scheda attiva. |
get | String | Recupera l'identificatore univoco del documento. |
get | String | Recupera il codice lingua del documento. |
get | String | Recupera il titolo del documento. |
get | Named | Recupera Named con l'ID specificato nella prima scheda o, per gli script vincolati a un documento, nella scheda attiva. |
get | Named | Recupera tutti gli oggetti Named nella prima scheda o, per gli script vincolati a un documento, la scheda attiva. |
get | Named | Recupera tutti gli oggetti Named con il nome specificato nella prima scheda o, per gli script
associati a un documento, nella scheda attiva. |
get | Range|null | Recupera la selezione dell'utente nella scheda attiva. |
get | String[] | Recupera tutti i codici lingua supportati nei file Google Docs. |
get | Tab | Recupera Tab con l'ID specificato. |
get | Tab[] | Recupera tutti i Tab non nidificati che fanno parte del documento. |
get | String | Recupera l'URL per accedere al documento corrente. |
get | User[] | Recupera l'elenco di visualizzatori e commentatori per questo Document. |
new | Position | Crea un nuovo Position, ovvero un riferimento a una posizione nella scheda, relativa a un
elemento specifico nella prima scheda o, per gli script vincolati a un documento, alla scheda attiva. |
new | Range | Crea un builder utilizzato per costruire oggetti Range dagli elementi delle schede nella prima scheda o, per gli script associati a un documento, nella scheda attiva. |
remove | Document | Rimuove l'utente specificato dall'elenco degli editor per Document. |
remove | Document | Rimuove l'utente specificato dall'elenco degli editor per Document. |
remove | Document | Rimuove l'utente specificato dall'elenco di visualizzatori e commentatori del Document. |
remove | Document | Rimuove l'utente specificato dall'elenco di visualizzatori e commentatori del Document. |
save | void | Salva l'Document corrente. |
set | void | Imposta il Tab selezionato dall'utente nel documento corrente sulla scheda con l'ID specificato. |
set | Document | Imposta il cursore dell'utente, dato un Position. |
set | Document | Imposta il codice della lingua del documento. |
set | Document | Imposta il titolo del documento. |
set | Document | Imposta la selezione dell'utente nella scheda attiva, dato un Range. |
Documentazione dettagliata
add Bookmark(position)
Aggiunge un Bookmark al Position specificato alla prima scheda o, per gli script vincolati a un documento, alla scheda attiva. Per aggiungere un
segnalibro a qualsiasi scheda, utilizza il metodo Document.
// 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 active or first tab's body and adds a paragraph. const paragraph = doc.getBody().appendParagraph('My new paragraph.'); // Creates a position at the first character of the paragraph text. const position = doc.newPosition(paragraph.getChild(0), 0); // Adds a bookmark at the first character of the paragraph text. const bookmark = doc.addBookmark(position); // Logs the bookmark ID to the console. console.log(bookmark.getId());
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
position | Position | La posizione del nuovo segnalibro. |
Indietro
Bookmark: il nuovo segnalibro.
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
add Editor(emailAddress)
Aggiunge l'utente specificato all'elenco degli editor per Document. Se l'utente era già
nell'elenco degli spettatori, questo metodo lo rimuove dall'elenco.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
email | String | L'indirizzo email dell'utente da aggiungere. |
Indietro
Document — This Document, for chaining.
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
add Editor(user)
Aggiunge l'utente specificato all'elenco degli editor per Document. Se l'utente era già
nell'elenco degli spettatori, questo metodo lo rimuove dall'elenco.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
user | User | Una rappresentazione dell'utente da aggiungere. |
Indietro
Document — This Document, for chaining.
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
add Editors(emailAddresses)
Aggiunge l'array di utenti specificato all'elenco degli editor del Document. Se alcuni utenti erano già presenti nell'elenco degli spettatori, questo metodo li rimuove dall'elenco.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
email | String[] | Un array di indirizzi email degli utenti da aggiungere. |
Indietro
Document — This Document, for chaining.
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
add Header()
Aggiunge una sezione di intestazione, se non esiste, alla prima scheda o, per gli script vincolati a un documento, alla scheda attiva. Per aggiungere una sezione di intestazione a qualsiasi scheda, utilizza il metodo Document.
// 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'); // Adds a header to the document's active or first tab. const header = doc.addHeader(); // Sets the header text to 'This is a header.' header.setText('This is a header');
Indietro
Header: l'intestazione 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
add Named Range(name, range)
Aggiunge un Named, ovvero un Range con un nome e un ID da utilizzare per il recupero successivo, nella prima scheda o, per gli script vincolati a un documento, nella scheda attiva. Per aggiungere un Named in qualsiasi scheda, utilizza il metodo Document. I nomi non sono
necessariamente univoci; diversi intervalli nello stesso documento possono condividere lo stesso nome, proprio
come una classe in HTML. Al contrario, gli ID sono univoci all'interno del documento, come un ID in HTML.
Dopo aver aggiunto un Named a un documento, non puoi modificarlo, ma solo rimuoverlo.
Qualsiasi script che accede al documento può accedere a un Named. Per evitare conflitti
involontari tra gli script, valuta la possibilità di aggiungere un prefisso ai nomi degli intervalli con una stringa univoca.
// Creates a named range that includes every table in the active tab. const doc = DocumentApp.getActiveDocument(); const rangeBuilder = doc.newRange(); const tables = doc.getBody().getTables(); for (let i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } // Adds the named range to the document's active tab. doc.addNamedRange('Document tables', rangeBuilder.build());
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
name | String | Il nome dell'intervallo, che non deve essere univoco; i nomi degli intervalli devono essere compresi tra 1 e 256 caratteri. |
range | Range | L'intervallo di elementi da associare al nome; l'intervallo può essere la selezione attiva, un risultato di ricerca o costruito manualmente con new. |
Indietro
Named: il Named.
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
add Viewer(emailAddress)
Aggiunge l'utente specificato all'elenco degli spettatori di Document. Se l'utente era già
nell'elenco degli editor, questo metodo non ha effetto.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
email | String | L'indirizzo email dell'utente da aggiungere. |
Indietro
Document — This Document, for chaining.
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
add Viewer(user)
Aggiunge l'utente specificato all'elenco degli spettatori di Document. Se l'utente era già
nell'elenco degli editor, questo metodo non ha effetto.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
user | User | Una rappresentazione dell'utente da aggiungere. |
Indietro
Document — This Document, for chaining.
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
add Viewers(emailAddresses)
Aggiunge l'array di utenti specificato all'elenco dei visualizzatori di Document. Se alcuni degli
utenti erano già presenti nell'elenco degli editor, questo metodo non ha alcun effetto.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
email | String[] | Un array di indirizzi email degli utenti da aggiungere. |
Indietro
Document — This Document, for chaining.
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
get Active Tab()
Recupera il Tab attualmente attivo dell'utente nel documento. Uno script può accedere solo alla scheda attiva dell'utente che lo esegue e solo se lo script è associato al documento.
// Display a dialog box that shows the title of the tab that the // user is currently viewing. const tab = DocumentApp.getActiveDocument().getActiveTab(); DocumentApp.getUi().alert(`ID of selected tab: ${tab.getTitle()}`);
Indietro
Tab: il Tab attualmente attivo dell'utente o null se lo script non è associato
al 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
get As(contentType)
Recupera i contenuti correnti di Document come blob del tipo 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 document as a PDF. const pdf = doc.getAs('application/pdf'); // Logs the name of the PDF to the console. console.log(pdf.getName());
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
content | String | Il tipo MIME in cui eseguire la conversione; sono supportati 'application/pdf' e 'text/markdown'. |
Indietro
Blob: il documento corrente come blob.
get Blob()
Recupera i contenuti correnti di Document come blob.
// 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'); // Retrieves the current document's contents as a blob and logs it to the // console. console.log(doc.getBlob().getContentType());
Indietro
Blob: il documento corrente come blob.
get Body()
Recupera il Body della prima scheda o, per gli script vincolati a un documento, il Document della scheda attiva. Per ottenere l'Document di una scheda, utilizza il metodo Document.
Le schede possono contenere diversi tipi di sezioni (ad esempio Header, Footer). La sezione attiva di una scheda è Body.
I metodi degli elementi in Document vengono delegati all'elemento Body attivo.
// 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 active or first tab's body. const body = doc.getBody(); // Gets the body text and logs it to the console. console.log(body.getText());
Indietro
Body: la sezione del corpo 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
get Bookmark(id)
Recupera Bookmark con l'ID specificato nella prima scheda o, per gli script vincolati a un documento, nella scheda attiva. Per ottenere un
segnalibro in qualsiasi scheda, utilizza il metodo Document. Questo metodo restituisce null se non esiste alcun Bookmark all'interno della scheda.
// 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 bookmark by its ID in the document's active or first tab. const bookmark = doc.getBookmark('id.xyz654321'); // If the bookmark exists, logs the character offset of its position to the // console. otherwise, logs 'No bookmark exists with the given ID.' to the // console. if (bookmark) { console.log(bookmark.getPosition().getOffset()); } else { console.log('No bookmark exists with the given ID.'); }
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
id | String | L'ID di Bookmark. |
Indietro
Bookmark|null: il Bookmark con l'ID specificato o null se non esiste alcun Bookmark
nella 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
get Bookmarks()
Recupera tutti gli oggetti Bookmark nella prima scheda o, per gli script vincolati a un documento, la scheda attiva. Per ottenere tutti
i preferiti in qualsiasi scheda, utilizza il metodo Document.
// Opens the Docs file by its ID. If you created your script from within // a Google Docs file, you can use DocumentApp.getActiveDocument() instead. const doc = DocumentApp.openById('123abc'); // Gets all of the bookmarks in the document's active or first tab. const bookmarks = doc.getBookmarks(); // Logs the number of bookmarks in the tab to the console. console.log(bookmarks.length);
Indietro
Bookmark[]: un array degli oggetti Bookmark nella 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
get Cursor()
Recupera il cursore dell'utente nella scheda attiva. Uno script può accedere al cursore dell'utente che lo esegue solo se lo script è associato al documento.
// Insert some text at the cursor position and make it bold. const cursor = DocumentApp.getActiveDocument().getCursor(); if (cursor) { // Attempt to insert text at the cursor position. If the insertion returns // null, the cursor's containing element doesn't allow insertions, so show the // user an error message. const element = cursor.insertText('ಠ‿ಠ'); if (element) { element.setBold(true); } else { DocumentApp.getUi().alert('Cannot insert text here.'); } } else { DocumentApp.getUi().alert('Cannot find a cursor.'); }
Indietro
Position|null: una rappresentazione del cursore dell'utente o null se l'utente non ha
posizionato un cursore nella scheda o se lo script non è associato al 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
get Editors()
Recupera l'elenco degli editor per questo Document.
Indietro
User[]: un array di utenti con autorizzazione di modifica.
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
get Footnotes()
Recupera tutti gli elementi Footnote nel corpo della prima scheda o, per gli script vincolati a un documento, nel corpo della scheda attiva. Per visualizzare
tutte le note a piè di pagina in una scheda, utilizza il metodo Document.
Le chiamate a get causano un'iterazione sugli elementi della scheda. Per le schede di grandi dimensioni,
evita chiamate non necessarie a questo metodo.
// 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 first footnote in the active or first tab's body. const footnote = doc.getFootnotes()[0]; // Logs footnote contents to the console. console.log(footnote.getFootnoteContents().getText());
Indietro
Footnote[]|null: le note a piè di pagina 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
get Header()
Recupera la sezione di intestazione della prima scheda o, per gli script vincolati a un documento, la sezione di intestazione della scheda attiva. Per ottenere la sezione dell'intestazione di una scheda, utilizza il metodo Document.
// 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 text of the active or first tab's header and logs it to the console. console.log(doc.getHeader().getText());
Indietro
Header: l'intestazione 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
get Id()
Recupera l'identificatore univoco del documento. L'ID documento viene utilizzato con Document per aprire una specifica istanza del documento.
Indietro
String: l'ID 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
get Language()
Recupera il codice lingua del documento. Questa è la lingua mostrata in File > Lingua dell'editor di documenti, che potrebbe non essere la lingua effettiva contenuta nel documento.
Indietro
String: la lingua del documento o null se non è definita.
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
get Name()
Recupera il titolo del documento.
Indietro
String: il titolo 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
get Named Range By Id(id)
Recupera Named con l'ID specificato nella prima scheda o, per gli script vincolati a un documento, nella scheda attiva. Per ottenere
Named con l'ID specificato in qualsiasi scheda, utilizza il metodo Document. Questo metodo restituisce null se non esiste alcun Named nella scheda. I nomi
non sono necessariamente univoci, nemmeno tra le schede; diversi intervalli nella stessa scheda possono
condividere lo stesso nome, proprio come una classe in HTML. Al contrario, gli ID sono univoci all'interno della scheda,
come un ID in HTML.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
id | String | L'ID dell'intervallo, univoco all'interno della scheda. |
Indietro
Named: il Named con l'ID specificato o null se non esiste un intervallo di questo tipo nella
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
get Named Ranges()
Recupera tutti gli oggetti Named nella prima scheda o, per gli script vincolati a un documento, la scheda attiva. Per ottenere tutti gli oggetti Named in qualsiasi scheda, utilizza il metodo Document.
Un Named può essere accessibile da qualsiasi script che accede alla scheda. Per evitare
conflitti indesiderati tra gli script, valuta la possibilità di aggiungere un prefisso ai nomi degli intervalli con una stringa univoca.
Indietro
Named: un array degli oggetti Named nella scheda, che potrebbe includere più intervalli con lo stesso nome.
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
get Named Ranges(name)
Recupera tutti gli oggetti Named con il nome specificato nella prima scheda o, per gli script
associati a un documento, nella scheda attiva. Per ottenere
tutti gli oggetti Named in qualsiasi scheda, utilizza il metodo Document. I nomi non sono necessariamente univoci, nemmeno nelle schede. Diversi intervalli nella
stessa scheda possono condividere lo stesso nome, proprio come una classe in HTML. Al contrario, gli ID sono univoci
all'interno della scheda, come un ID in HTML.
Un Named può essere accessibile a qualsiasi script che accede al documento. Per evitare
conflitti indesiderati tra gli script, valuta la possibilità di aggiungere un prefisso ai nomi degli intervalli con una stringa univoca.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
name | String | Il nome dell'intervallo, che non è necessariamente univoco. |
Indietro
Named: un array degli oggetti Named nella scheda con il nome 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
get Selection()
Recupera la selezione dell'utente nella scheda attiva. Uno script può accedere solo alla selezione dell'utente che lo esegue e solo se lo script è associato al documento.
// Display a dialog box that tells the user how many elements are included in // the selection. const selection = DocumentApp.getActiveDocument().getSelection(); if (selection) { const elements = selection.getRangeElements(); DocumentApp.getUi().alert(`Number of selected elements: ${elements.length}`); } else { DocumentApp.getUi().alert('Nothing is selected.'); }
Indietro
Range|null: una rappresentazione della selezione dell'utente o null se l'utente non ha
selezionato nulla nella scheda, se è selezionata solo la fine di un paragrafo, se sono selezionate solo la fine
di un paragrafo e una nuova riga o se lo script non è associato al 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
get Supported Language Codes()
Recupera tutti i codici lingua supportati nei file Google Docs.
Indietro
String[]: un array di codici lingua.
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
get Tab(tabId)
Recupera Tab con l'ID specificato. Questo metodo restituisce null se non esiste alcun Tab. Può accedere alle schede a qualsiasi livello di nidificazione.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
tab | String | L'ID della scheda da recuperare. |
Indietro
Tab: il Tab con l'ID specificato o null se non esiste alcun Tab.
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
get Tabs()
Recupera tutti i Tab non nidificati che fanno parte del documento.
Le schede possono contenere schede secondarie, ovvero schede nidificate all'interno di un'altra scheda. Le schede per bambini sono accessibili
utilizzando Tab.getChildTabs().
Indietro
Tab[]: l'elenco di tutti i Tab che fanno parte 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
get Url()
Recupera l'URL per accedere al documento corrente.
const doc = DocumentApp.getActiveDocument(); // Send out the link to open the document. MailApp.sendEmail('<email-address>', doc.getName(), doc.getUrl());
Indietro
String: l'URL per accedere al documento 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
get Viewers()
Recupera l'elenco di visualizzatori e commentatori per questo Document.
Indietro
User[]: un array di utenti con autorizzazione di visualizzazione o commento.
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
new Position(element, offset)
Crea un nuovo Position, ovvero un riferimento a una posizione nella scheda, relativa a un
elemento specifico nella prima scheda o, per gli script vincolati a un documento, alla scheda attiva. Per creare un
Position relativo a una posizione in qualsiasi scheda, utilizza il metodo Document. Il cursore dell'utente è rappresentato da un Position, tra gli altri utilizzi.
// Append a paragraph to the active tab, then place the user's cursor after the // first word of the new paragraph. const doc = DocumentApp.getActiveDocument(); const paragraph = doc.getBody().appendParagraph('My new paragraph.'); const position = doc.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
element | Element | L'elemento che deve contenere il nuovo Position; deve essere un elemento
Text o un elemento contenitore come Paragraph. |
offset | Integer | Per gli elementi Text, il numero di caratteri prima di Position;
per gli altri elementi, il numero di elementi secondari prima di Position all'interno dello
stesso elemento contenitore. |
Indietro
Position — Il nuovo Position.
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
new Range()
Crea un builder utilizzato per costruire oggetti Range dagli elementi delle schede nella prima scheda o, per gli script associati a un documento, nella scheda attiva. Per creare un builder utilizzato per costruire oggetti Document
da elementi scheda in qualsiasi scheda, utilizza il metodo Document.
// Change the user's selection to a range that includes every table in the // active tab. const doc = DocumentApp.getActiveDocument(); const rangeBuilder = doc.newRange(); const tables = doc.getBody().getTables(); for (let i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Indietro
Range: il nuovo builder.
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
remove Editor(emailAddress)
Rimuove l'utente specificato dall'elenco degli editor per Document. Questo metodo non
impedisce agli utenti di accedere a Document se appartengono a una classe di utenti che dispone di
accesso generale, ad esempio se Document è condiviso con l'intero
dominio dell'utente o se Document si trova in un Drive condiviso a cui l'utente può accedere.
Per i file di Drive, l'utente viene rimosso anche dall'elenco dei visualizzatori.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
email | String | L'indirizzo email dell'utente da rimuovere. |
Indietro
Document — This Document, for chaining.
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
remove Editor(user)
Rimuove l'utente specificato dall'elenco degli editor per Document. Questo metodo non
impedisce agli utenti di accedere a Document se appartengono a una classe di utenti che dispone di
accesso generale, ad esempio se Document è condiviso con l'intero
dominio dell'utente o se Document si trova in un Drive condiviso a cui l'utente può accedere.
Per i file di Drive, l'utente viene rimosso anche dall'elenco dei visualizzatori.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
user | User | Una rappresentazione dell'utente da rimuovere. |
Indietro
Document — This Document, for chaining.
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
remove Viewer(emailAddress)
Rimuove l'utente specificato dall'elenco di visualizzatori e commentatori del Document. Questo
metodo non ha alcun effetto se l'utente è un editor, non un visualizzatore o un commentatore. Questo metodo
non impedisce inoltre agli utenti di accedere a Document se appartengono a una classe di utenti che
hanno accesso generale, ad esempio se Document è condiviso con l'intero dominio dell'utente o se Document si trova in un Drive condiviso a cui l'utente può accedere.
Per i file di Drive, l'utente viene rimosso anche dall'elenco degli editor.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
email | String | L'indirizzo email dell'utente da rimuovere. |
Indietro
Document — Questo Document per il concatenamento.
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
remove Viewer(user)
Rimuove l'utente specificato dall'elenco di visualizzatori e commentatori del Document. Questo metodo non ha effetto se l'utente è un editor, non un visualizzatore. Questo metodo non impedisce
agli utenti di accedere a Document se appartengono a una classe di utenti che hanno accesso
generale, ad esempio se Document è condiviso con l'intero dominio dell'utente o
se Document si trova in un Drive condiviso a cui l'utente può accedere.
Per i file di Drive, l'utente viene rimosso anche dall'elenco degli editor.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
user | User | Una rappresentazione dell'utente da rimuovere. |
Indietro
Document — Questo Document per il concatenamento.
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
save And Close()
Salva l'Document corrente. Causa lo svuotamento e l'applicazione degli aggiornamenti in attesa.
Il metodo save viene richiamato automaticamente al termine dell'esecuzione dello script
per ogni Document modificabile aperto.
Un Document chiuso non può essere modificato. Utilizza Document per riaprire un
documento specifico per la modifica.
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
set Active Tab(tabId)
Imposta il Tab selezionato dall'utente nel documento corrente sulla scheda con l'ID specificato.
const doc = DocumentApp.getActiveDocument(); // Sets the user's selected tab by its ID. // TODO(developer): Replace the ID with your own. const tab = doc.setActiveTab('123abc');
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
tab | String | L'ID della scheda da impostare come attiva. |
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
set Cursor(position)
Imposta il cursore dell'utente, dato un Position. Uno script può accedere al cursore solo dell'utente che lo esegue e solo se lo script è associato al documento.
Se fornisci un Position da un Tab inattivo, la scheda attiva dell'utente viene cambiata.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); // Append a paragraph, then place the user's cursor after the first word of the // new paragraph. const paragraph = documentTab.getBody().appendParagraph('My new paragraph.'); const position = documentTab.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
position | Position | La nuova posizione del cursore. |
Indietro
Document — This Document, for chaining.
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
set Language(languageCode)
Imposta il codice della lingua del documento. Questa è la lingua mostrata in File > Lingua dell'editor di documenti, che potrebbe non essere la lingua effettiva contenuta nel documento. Utilizza get per ottenere tutti i codici lingua validi.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
language | String | Il codice lingua. |
Indietro
Document — This Document, for chaining.
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
set Name(name)
Imposta il titolo del documento.
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
name | String | Il nuovo titolo del documento. |
Indietro
Document: il documento 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
set Selection(range)
Imposta la selezione dell'utente nella scheda attiva, dato un Range. Uno script può accedere solo alla selezione dell'utente che lo esegue e solo se lo script è associato al documento.
const doc = DocumentApp.getActiveDocument(); const documentTab = doc.getActiveTab().asDocumentTab(); // Change the user's selection to a range that includes every table in the // document. const rangeBuilder = documentTab.newRange(); const tables = documentTab.getBody().getTables(); for (let i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Parametri
| Nome | Tipo | Descrizione |
|---|---|---|
range | Range | Il nuovo intervallo di elementi da selezionare. |
Indietro
Document — This Document, for chaining.
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