Un documento contenente uno o più oggetti Tab
, ognuno dei quali contiene RTF
come tabelle ed elenchi.
I documenti possono essere aperti o creati utilizzando DocumentApp
.
// Open a document by ID. var doc = DocumentApp.openById("<my-id>"); // Create and open a document. doc = DocumentApp.create("Document Title");
I metodi nella classe Document
che accedono direttamente ai contenuti di testo e li modificano operano in base a
la scheda attiva (negli script associati a un
documento specifico) o la prima scheda (se una scheda attiva non è disponibile). Gli script che si basano su
è possibile eseguire la migrazione di questi metodi (ad esempio getBody()
) alle schede di supporto utilizzando
getTabs()
e poi Tab.asDocumentTab()
.
Metodi
Metodo | Tipo restituito | Breve descrizione |
---|---|---|
addBookmark(position) | Bookmark | Aggiunge un Bookmark nel valore Position specificato alla prima scheda oppure, per gli script che sono
associata a un documento, la scheda attiva. |
addEditor(emailAddress) | Document | Aggiunge l'utente specificato all'elenco di editor per Document . |
addEditor(user) | Document | Aggiunge l'utente specificato all'elenco di editor per Document . |
addEditors(emailAddresses) | Document | Aggiunge l'array di utenti specificato all'elenco di editor per Document . |
addFooter() | FooterSection | Aggiunge una sezione a piè di pagina, se non ne esiste nessuna, alla prima scheda o, per gli script legati a un documento, alla scheda attiva. |
addHeader() | HeaderSection | Aggiunge una sezione di intestazione, se non ne esiste nessuna, alla prima scheda o, per gli script associati a un documento, alla scheda attiva. |
addNamedRange(name, range) | NamedRange | Aggiunge un NamedRange , ovvero un Range che ha un nome e un ID da utilizzare per
recupero in seguito, nella prima scheda o, per gli script associati a un documento, alla scheda attiva. |
addViewer(emailAddress) | Document | Aggiunge l'utente specificato all'elenco di visualizzatori per Document . |
addViewer(user) | Document | Aggiunge l'utente specificato all'elenco di visualizzatori per Document . |
addViewers(emailAddresses) | Document | Aggiunge l'array specificato di utenti all'elenco di visualizzatori per Document . |
getActiveTab() | Tab | Restituisce il valore Tab attualmente attivo dell'utente nel documento. |
getAs(contentType) | Blob | Recupera i contenuti attuali di Document come blob del tipo specificato. |
getBlob() | Blob | Recupera i contenuti attuali di Document come blob. |
getBody() | Body | Recupera il valore Body della prima scheda o, per gli script associati a un documento, il valore DocumentBodySection della scheda attiva. |
getBookmark(id) | Bookmark | Recupera Bookmark con l'ID specificato nella prima scheda o, per gli script associati a un documento, nella scheda attiva. |
getBookmarks() | Bookmark[] | Recupera tutti gli oggetti Bookmark nella prima scheda o, per gli script associati a un documento, la scheda attiva. |
getCursor() | Position | Restituisce il cursore dell'utente nella scheda attiva. |
getEditors() | User[] | Ottiene l'elenco degli editor per questo Document . |
getFooter() | FooterSection | Recupera la sezione del piè di pagina della prima scheda o, per gli script legati a un documento, il piè di pagina della scheda attiva . |
getFootnotes() | Footnote[] | Recupera tutti gli elementi Footnote nel corpo della prima scheda o, per gli script associati a un documento, nel corpo della scheda attiva. |
getHeader() | HeaderSection | Recupera la sezione dell'intestazione della prima scheda o, per gli script associati a un documento, l'intestazione della scheda attiva . |
getId() | String | Recupera l'identificatore univoco del documento. |
getLanguage() | String | Ottiene il codice lingua del documento. |
getName() | String | Recupera il titolo del documento. |
getNamedRangeById(id) | NamedRange | Recupera NamedRange con l'ID specificato nella prima scheda o, per gli script associati a un documento, nella scheda attiva. |
getNamedRanges() | NamedRange[] | Recupera tutti gli oggetti NamedRange nella prima scheda o, per gli script associati a un documento, la scheda attiva. |
getNamedRanges(name) | NamedRange[] | Recupera tutti gli oggetti NamedRange con il nome specificato nella prima scheda o, per gli script che
sono legati a un documento, la scheda attiva. |
getSelection() | Range | Restituisce la selezione dell'utente nella scheda attiva. |
getSupportedLanguageCodes() | String[] | Recupera tutti i codici lingua supportati nei file di Documenti Google. |
getTab(tabId) | Tab | Ottiene il valore Tab con l'ID specificato. |
getTabs() | Tab[] | Recupera tutti gli elementi Tab non nidificati che fanno parte del documento. |
getUrl() | String | Recupera l'URL per accedere al documento corrente. |
getViewers() | User[] | Consente di acquisire l'elenco di visualizzatori e commentatori di Document . |
newPosition(element, offset) | Position | Crea un nuovo Position , che è un riferimento a una posizione nella scheda, rispetto a un
elemento specifico nella prima scheda o, per gli script legati a un documento, alla scheda attiva. |
newRange() | RangeBuilder | Crea un builder utilizzato per costruire oggetti Range da elementi scheda in
prima scheda o, per gli script associati a una
documento, la scheda attiva. |
removeEditor(emailAddress) | Document | Rimuove l'utente specificato dall'elenco degli editor per Document . |
removeEditor(user) | Document | Rimuove l'utente specificato dall'elenco degli editor per Document . |
removeViewer(emailAddress) | Document | Rimuove l'utente specificato dall'elenco di visualizzatori e commentatori per Document . |
removeViewer(user) | Document | Rimuove l'utente specificato dall'elenco di visualizzatori e commentatori per Document . |
saveAndClose() | void | Salva l'attuale Document . |
setActiveTab(tabId) | void | Imposta il Tab selezionato dall'utente nel documento corrente sulla scheda con l'ID specificato. |
setCursor(position) | Document | Imposta il cursore dell'utente, una volta selezionato un Position . |
setLanguage(languageCode) | Document | Imposta il codice lingua del documento. |
setName(name) | Document | Imposta il titolo del documento. |
setSelection(range) | Document | Imposta la selezione dell'utente nella scheda attiva, in base a un valore Range . |
Documentazione dettagliata
addBookmark(position)
Aggiunge un Bookmark
nel valore Position
specificato alla prima scheda oppure, per gli script che sono
associata a un documento, la scheda attiva. Per aggiungere un
Aggiungi ai preferiti una scheda qualsiasi, utilizza il metodo DocumentTab.addBookmark(position)
.
// 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(DOCUMENT_ID); // 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 preferito. |
Invio
Bookmark
: il nuovo preferito.
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
addEditor(emailAddress)
Aggiunge l'utente specificato all'elenco di editor per Document
. Se l'utente era già
nell'elenco dei visualizzatori, questo metodo promuove l'utente all'esterno dell'elenco dei visualizzatori.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
emailAddress | String | L'indirizzo email dell'utente da aggiungere. |
Invio
Document
: 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
addEditor(user)
Aggiunge l'utente specificato all'elenco di editor per Document
. Se l'utente era già
nell'elenco dei visualizzatori, questo metodo promuove l'utente all'esterno dell'elenco dei visualizzatori.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
user | User | Una rappresentazione dell'utente da aggiungere. |
Invio
Document
: 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
addEditors(emailAddresses)
Aggiunge l'array di utenti specificato all'elenco di editor per Document
. Se uno dei
utenti erano già presenti nell'elenco dei visualizzatori, questo metodo li promuove dall'elenco dei
spettatori.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
emailAddresses | String[] | Un array di indirizzi email degli utenti da aggiungere. |
Invio
Document
: 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
addHeader()
Aggiunge una sezione di intestazione, se non ne esiste nessuna, alla prima scheda o, per gli script associati a un documento, alla scheda attiva. Per aggiungere un'intestazione
in una scheda qualsiasi, usa il metodo DocumentTab.addHeader()
.
// 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(DOCUMENT_ID); // 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');
Invio
HeaderSection
: 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
addNamedRange(name, range)
Aggiunge un NamedRange
, ovvero un Range
che ha un nome e un ID da utilizzare per
recupero in seguito, nella prima scheda o, per gli script associati a un documento, alla scheda attiva. Per aggiungere un NamedRange
in qualsiasi scheda, usa il metodo DocumentTab.addNamedRange(name, range)
. I nomi non sono
necessariamente univoco; diversi intervalli nello stesso documento possono condividere lo stesso nome,
come una classe in HTML. Al contrario, gli ID sono univoci all'interno del documento, come un ID nel codice HTML.
Dopo aver aggiunto un elemento NamedRange
a un documento, non puoi modificarlo, puoi solo rimuoverlo.
Qualsiasi script che accede al documento può accedere a un NamedRange
. Per evitare indesiderate
i conflitti tra gli script, considera l'idea di anteporre ai nomi degli intervalli una stringa univoca.
// Creates a named range that includes every table in the active tab. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var 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 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 creato manualmente con newRange() . |
Invio
NamedRange
- Il NamedRange
.
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
addViewer(emailAddress)
Aggiunge l'utente specificato all'elenco di visualizzatori per Document
. Se l'utente era già
nell'elenco degli editor, questo metodo non ha alcun effetto.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
emailAddress | String | L'indirizzo email dell'utente da aggiungere. |
Invio
Document
: 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
addViewer(user)
Aggiunge l'utente specificato all'elenco di visualizzatori per Document
. Se l'utente era già
nell'elenco degli editor, questo metodo non ha alcun effetto.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
user | User | Una rappresentazione dell'utente da aggiungere. |
Invio
Document
: 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
addViewers(emailAddresses)
Aggiunge l'array specificato di utenti all'elenco di visualizzatori per Document
. Se uno dei
utenti erano già presenti nell'elenco degli editor, questo metodo non ha alcun effetto su di loro.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
emailAddresses | String[] | Un array di indirizzi email degli utenti da aggiungere. |
Invio
Document
: 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
getActiveTab()
Restituisce il valore Tab
attualmente attivo dell'utente nel documento. Uno script può accedere solo
scheda attiva dell'utente che sta eseguendo lo script 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());
Invio
Tab
: Tab
attualmente attivo dell'utente o null
se lo script non è associato a
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
getAs(contentType)
Recupera i contenuti attuali 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(DOCUMENT_ID); // 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 |
---|---|---|
contentType | String | Il tipo MIME in cui eseguire la conversione; Le app 'application/pdf' e 'text/markdown' sono supportate. |
Invio
Blob
: il documento corrente come blob.
getBlob()
Recupera i contenuti attuali 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(DOCUMENT_ID); // Retrieves the current document's contents as a blob and logs it to the console. console.log(doc.getBlob().getContentType());
Invio
Blob
: il documento corrente come blob.
getBody()
Recupera il valore Body
della prima scheda o, per gli script associati a un documento, il valore DocumentBodySection
della scheda attiva. Per ottenere il valore DocumentBodySection
di qualsiasi scheda, usa il metodo DocumentTab.getBody()
.
Le schede possono contenere diversi tipi di sezioni (ad es. HeaderSection
e FooterSection
). La sezione attiva di una scheda è Body
.
I metodi degli elementi in Document
delegano all'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(DOCUMENT_ID); // 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());
Invio
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
getBookmark(id)
Recupera Bookmark
con l'ID specificato nella prima scheda o, per gli script associati a un documento, nella scheda attiva. Per ottenere un
preferito in qualsiasi scheda, usa il metodo DocumentTab.getBookmark(id)
. Questo metodo restituisce null
se questo tipo di Bookmark
non esiste nella 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(DOCUMENT_ID); // 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 . |
Invio
Bookmark
: Bookmark
con l'ID specificato o null
, in caso contrario, Bookmark
sono presenti 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
getBookmarks()
Recupera tutti gli oggetti Bookmark
nella prima scheda o, per gli script associati a un documento, la scheda attiva. Per ottenere tutte
preferiti in qualsiasi scheda, usa il metodo DocumentTab.getBookmarks()
.
// 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(DOCUMENT_ID); // 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);
Invio
Bookmark[]
: un array degli oggetti Bookmark
presenti 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
getCursor()
Restituisce il cursore dell'utente nella scheda attiva. Uno script può accedere soltanto al cursore dell'utente che stia eseguendo lo script e solo se è legato al documento.
// Insert some text at the cursor position and make it bold. var 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. var element = cursor.insertText('ಠ‿ಠ'); if (element) { element.setBold(true); } else { DocumentApp.getUi().alert('Cannot insert text here.'); } } else { DocumentApp.getUi().alert('Cannot find a cursor.'); }
Invio
Position
: una rappresentazione del cursore dell'utente o null
se l'utente non ha una rappresentazione
cursore posizionato 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
getEditors()
Ottiene l'elenco degli editor per questo Document
.
Invio
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
getFootnotes()
Recupera tutti gli elementi Footnote
nel corpo della prima scheda o, per gli script associati a un documento, nel corpo della scheda attiva. Per ottenere
tutte le note a piè di pagina di qualsiasi scheda, usa il metodo DocumentTab.getFootnotes()
.
Le chiamate a getFootnotes
causano un'iterazione degli 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(DOCUMENT_ID); // 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());
Invio
Footnote[]
: 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
getHeader()
Recupera la sezione dell'intestazione della prima scheda o, per gli script associati a un documento, l'intestazione della scheda attiva
. Per visualizzare la sezione dell'intestazione di qualsiasi scheda, usa il metodo DocumentTab.getHeader()
.
// 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(DOCUMENT_ID); // Gets the text of the active or first tab's header and logs it to the console. console.log(doc.getHeader().getText());
Invio
HeaderSection
: 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
getId()
Recupera l'identificatore univoco del documento. L'ID documento viene utilizzato con DocumentApp.openById()
per aprire un'istanza specifica del documento.
Invio
String
: 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
getLanguage()
Ottiene il codice lingua del documento. Si tratta della lingua per la visualizzazione nel campo File dell'editor di documenti > Lingua, che potrebbe non essere la lingua effettiva presente nel documento.
Invio
String
: 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
getName()
Recupera il titolo del documento.
Invio
String
: 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
getNamedRangeById(id)
Recupera NamedRange
con l'ID specificato nella prima scheda o, per gli script associati a un documento, nella scheda attiva. Per ottenere
NamedRange
con l'ID specificato in qualsiasi scheda, usa DocumentTab.getNamedRangeById(id)
. Questo metodo restituisce null
se questo tipo di NamedRange
non esiste nella scheda. Nomi
non sono necessariamente univoci, nemmeno da una scheda all'altra; intervalli diversi nella stessa scheda possono
condividono 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, che è univoco all'interno della scheda. |
Invio
NamedRange
: NamedRange
con l'ID specificato o null
se questo intervallo non esiste in
la 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
getNamedRanges()
Recupera tutti gli oggetti NamedRange
nella prima scheda o, per gli script associati a un documento, la scheda attiva. Per ottenere tutte
NamedRange
di oggetti in qualsiasi scheda, usa il metodo DocumentTab.getNamedRanges()
.
Un NamedRange
è accessibile da qualsiasi script che accede alla scheda. Da evitare
Conflitti involontari tra gli script, ti consigliamo di anteporre ai nomi degli intervalli una stringa univoca.
Invio
NamedRange[]
: un array degli oggetti NamedRange
nella scheda, che potrebbe includere più oggetti
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
getNamedRanges(name)
Recupera tutti gli oggetti NamedRange
con il nome specificato nella prima scheda o, per gli script che
sono legati a un documento, la scheda attiva. Per ottenere
tutti gli oggetti NamedRange
in qualsiasi scheda, usa il metodo DocumentTab.getNamedRanges(name)
. I nomi non sono necessariamente univoci, anche da una scheda all'altra; diversi intervalli
la stessa scheda può 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 NamedRange
è accessibile da qualsiasi script che accede al documento. Da evitare
Conflitti involontari tra gli script, ti consigliamo di anteporre ai nomi degli intervalli una stringa univoca.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
name | String | Il nome dell'intervallo, che non è necessariamente univoco. |
Invio
NamedRange[]
: un array degli oggetti NamedRange
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
getSelection()
Restituisce la selezione dell'utente nella scheda attiva. Uno script può accedere solo alla selezione dell'utente che esegue lo script e solo se lo script è legato al documento.
// Display a dialog box that tells the user how many elements are included in the selection. var selection = DocumentApp.getActiveDocument().getSelection(); if (selection) { var elements = selection.getRangeElements(); DocumentApp.getUi().alert('Number of selected elements: ' + elements.length); } else { DocumentApp.getUi().alert('Nothing is selected.'); }
Invio
Range
: una rappresentazione della selezione dell'utente o null
se l'utente non ha
qualsiasi elemento selezionato nella scheda, se è selezionata solo la fine di un paragrafo, se solo la fine
di un paragrafo e una nuova riga vengono selezionati 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
getSupportedLanguageCodes()
Recupera tutti i codici lingua supportati nei file di Documenti Google.
Invio
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
getTab(tabId)
Ottiene il valore Tab
con l'ID specificato. Questo metodo restituisce null
se questo tipo di Tab
non esiste. Consente di accedere alle schede a qualsiasi livello di nidificazione.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
tabId | String | L'ID della scheda da ottenere. |
Invio
Tab
: Tab
con l'ID specificato o null
se Tab
non esiste.
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
getTabs()
Recupera tutti gli elementi Tab
non nidificati che fanno parte del documento.
Le schede possono contenere schede secondarie, una scheda nidificata all'interno di un'altra scheda. Le schede secondarie sono accessibili
utilizzando Tab.getChildTabs()
.
Invio
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
getUrl()
Recupera l'URL per accedere al documento corrente.
var doc = DocumentApp.getActiveDocument(); // Send out the link to open the document. MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());
Invio
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
getViewers()
Consente di acquisire l'elenco di visualizzatori e commentatori di Document
.
Invio
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
newPosition(element, offset)
Crea un nuovo Position
, che è un riferimento a una posizione nella scheda, rispetto a un
elemento specifico nella prima scheda o, per gli script legati a un documento, alla scheda attiva. Per creare un
Position
rispetto a una località in qualsiasi scheda, usa DocumentTab.newPosition(element, offset)
. Il cursore dell'utente è rappresentato, ad esempio, da una Position
.
// Append a paragraph to the active tab, then place the user's cursor after the first word of // the new paragraph. var doc = DocumentApp.getActiveDocument(); var paragraph = doc.getBody().appendParagraph('My new paragraph.'); var 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
lo stesso elemento container. |
Invio
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
newRange()
Crea un builder utilizzato per costruire oggetti Range
da elementi scheda in
prima scheda o, per gli script associati a una
documento, la scheda attiva. Per creare un builder utilizzato per costruire DocumentRange
oggetti
dagli elementi tab in qualsiasi scheda, usa il metodo DocumentTab.newRange()
.
// Change the user's selection to a range that includes every table in the active tab. var doc = DocumentApp.getActiveDocument(); var rangeBuilder = doc.newRange(); var tables = doc.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Invio
RangeBuilder
: 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
removeEditor(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 con
accesso generale, ad esempio se Document
viene condiviso con l'intera organizzazione
dominio 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 |
---|---|---|
emailAddress | String | L'indirizzo email dell'utente da rimuovere. |
Invio
Document
: 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
removeEditor(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 con
accesso generale, ad esempio se Document
viene condiviso con l'intera organizzazione
dominio 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. |
Invio
Document
: 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
removeViewer(emailAddress)
Rimuove l'utente specificato dall'elenco di visualizzatori e commentatori per Document
. Questo
non ha effetto se l'utente è un editor, non un visualizzatore o un commentatore. Questo metodo
non impedisce agli utenti di accedere a Document
se appartengono a una classe di utenti che
dispongono di accesso generale, ad esempio, se Document
è condiviso con
l'intero dominio 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 |
---|---|---|
emailAddress | String | L'indirizzo email dell'utente da rimuovere. |
Invio
Document
: 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
removeViewer(user)
Rimuove l'utente specificato dall'elenco di visualizzatori e commentatori per Document
. Questo
non ha effetto se l'utente è un editor, non un visualizzatore. Inoltre, questo metodo non blocca
agli utenti di accedere a Document
se appartengono a una classe di utenti con
accesso, ad esempio se Document
è condiviso con l'intero dominio dell'utente oppure
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. |
Invio
Document
: 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
saveAndClose()
Salva l'attuale Document
. Ciò causa lo svuotamento e l'applicazione degli aggiornamenti in attesa.
Il metodo saveAndClose()
viene richiamato automaticamente al termine dell'esecuzione dello script
per ogni Document
modificabile aperta.
Un Document
chiuso non può essere modificato. Usa DocumentApp.openById()
per riaprire
un determinato documento 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
setActiveTab(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(TAB_ID);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
tabId | 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
setCursor(position)
Imposta il cursore dell'utente, una volta selezionato un Position
. Uno script può accedere soltanto al cursore del parametro
dall'utente che esegue lo script e solo se lo script è legato al documento.
Se invii un Position
da un Tab
non attivo, la scheda attiva dell'utente viene cambiata.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); // Append a paragraph, then place the user's cursor after the first word of the new paragraph. var paragraph = documentTab.getBody().appendParagraph('My new paragraph.'); var position = documentTab.newPosition(paragraph.getChild(0), 2); doc.setCursor(position);
Parametri
Nome | Tipo | Descrizione |
---|---|---|
position | Position | La nuova posizione del cursore. |
Invio
Document
: 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
setLanguage(languageCode)
Imposta il codice lingua del documento. Si tratta della lingua per la visualizzazione nel campo File dell'editor di documenti
> Lingua, che potrebbe non essere la lingua effettiva presente nel documento. Usa getSupportedLanguageCodes()
per ricevere tutti i codici lingua validi.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
languageCode | String | Il codice della lingua. |
Invio
Document
: 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
setName(name)
Imposta il titolo del documento.
Parametri
Nome | Tipo | Descrizione |
---|---|---|
name | String | Il nuovo titolo del documento. |
Invio
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
setSelection(range)
Imposta la selezione dell'utente nella scheda attiva, in base a un valore Range
. Uno script può solo
accedono alla selezione dell'utente che esegue lo script e solo se lo script è legato al documento.
var doc = DocumentApp.getActiveDocument(); var documentTab = doc.getActiveTab().asDocumentTab(); // Change the user's selection to a range that includes every table in the document. var rangeBuilder = documentTab.newRange(); var tables = documentTab.getBody().getTables(); for (var i = 0; i < tables.length; i++) { rangeBuilder.addElement(tables[i]); } doc.setSelection(rangeBuilder.build());
Parametri
Nome | Tipo | Descrizione |
---|---|---|
range | Range | La nuova gamma di elementi da selezionare. |
Invio
Document
: 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