Class Document

Documento

Un documento contenente uno o più oggetti Tab, ciascuno dei quali contiene testo avanzato e elementi come tabelle e elenchi.

I documenti possono essere aperti o creati utilizzando DocumentApp. 

// 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 e modificano direttamente i contenuti di testo operano sulla scheda attiva (negli script vincolati a un determinato documento) o sulla prima scheda (se non è disponibile una scheda attiva). È possibile eseguire la migrazione degli script che si basano su questi metodi (ad es. getBody()) per supportare le schede utilizzando getTabs() e poi Tab.asDocumentTab().

Metodi

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

Documentazione dettagliata

addBookmark(position)

Aggiunge un Bookmark all'Position specificato alla prima scheda o, per gli script vincolati a un documento, alla scheda attiva. Per aggiungere un preferito a qualsiasi scheda, 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('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

NomeTipoDescrizione
positionPositionLa 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 degli editor di Document. Se l'utente era già nell'elenco degli spettatori, questo metodo lo rimuove dall'elenco.

Parametri

NomeTipoDescrizione
emailAddressStringL'indirizzo email dell'utente da aggiungere.

Invio

Document: questo Document, per l'accodamento.

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 degli editor di Document. Se l'utente era già nell'elenco degli spettatori, questo metodo lo rimuove dall'elenco.

Parametri

NomeTipoDescrizione
userUserUna rappresentazione dell'utente da aggiungere.

Invio

Document: questo Document, per l'accodamento.

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 degli editor di Document. Se uno degli utenti faceva già parte dell'elenco degli spettatori, questo metodo lo rimuove dall'elenco.

Parametri

NomeTipoDescrizione
emailAddressesString[]Un array di indirizzi email degli utenti da aggiungere.

Invio

Document: questo Document, per l'accodamento.

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

addFooter()

Aggiunge una sezione di piè di pagina, se non esiste, alla prima scheda o, per gli script vincolati a un documento, alla scheda attiva. Per aggiungere una sezione di piè di pagina a qualsiasi scheda, utilizza il metodo DocumentTab.addFooter(). 

// 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 footer to the document's active or first tab.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

Invio

FooterSection: il 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

addHeader()

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 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('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');

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 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 NamedRange in qualsiasi scheda, utilizza il metodo DocumentTab.addNamedRange(name, range). I nomi non sono necessariamente univoci; diversi intervalli nello stesso documento possono condividere lo stesso nome, come un'entità HTML. Al contrario, gli ID sono univoci all'interno del documento, come un ID in HTML. Dopo aver aggiunto un NamedRange a un documento, non puoi modificarlo, ma solo rimuoverlo.

Qualsiasi script che accede al documento può accedere a un NamedRange. Per evitare conflitti involontari tra gli script, ti consigliamo di anteporre ai nomi degli intervalli 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

NomeTipoDescrizione
nameStringIl nome dell'intervallo, che non deve essere univoco. I nomi degli intervalli devono essere compreso tra 1 e 256 caratteri.
rangeRangeL'intervallo di elementi da associare al nome. L'intervallo può essere la selezione attiva, un risultato di ricerca o costruito 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 degli spettatori del Document. Se l'utente era già nell'elenco degli editor, questo metodo non ha alcun effetto.

Parametri

NomeTipoDescrizione
emailAddressStringL'indirizzo email dell'utente da aggiungere.

Invio

Document: questo Document, per l'accodamento.

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 degli spettatori del Document. Se l'utente era già nell'elenco degli editor, questo metodo non ha alcun effetto.

Parametri

NomeTipoDescrizione
userUserUna rappresentazione dell'utente da aggiungere.

Invio

Document: questo Document, per l'accodamento.

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 di utenti specificato all'elenco degli spettatori per Document. Se uno degli utenti faceva già parte dell'elenco degli editor, questo metodo non ha alcun effetto su di lui.

Parametri

NomeTipoDescrizione
emailAddressesString[]Un array di indirizzi email degli utenti da aggiungere.

Invio

Document: questo Document, per l'accodamento.

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()

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 è legato 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: 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

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('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

NomeTipoDescrizione
contentTypeStringIl tipo MIME in cui eseguire la conversione. Sono supportati 'application/pdf' e 'text/markdown'.

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('123abc');

// 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 Body della prima scheda o, per gli script vincolati a un documento, DocumentBodySection della scheda attiva. Per ottenere il DocumentBodySection di qualsiasi scheda, utilizza il metodo DocumentTab.getBody().

Le schede possono contenere diversi tipi di sezioni (ad esempio HeaderSection, FooterSection). La sezione attiva per una scheda è Body.

I metodi degli elementi in Document vengono delegati a 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());

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 il Bookmark con l'ID specificato nella prima scheda o, per gli script vincolati a un documento, nella scheda attiva. Per ottenere un preferito in qualsiasi scheda, utilizza il metodo DocumentTab.getBookmark(id). Questo metodo restituisce null se non esiste un null di questo tipo nella scheda.Bookmark 

// 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

NomeTipoDescrizione
idStringL'ID del Bookmark.

Invio

Bookmark: il Bookmark con l'ID specificato o null se non esiste un Bookmark 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

getBookmarks()

Recupera tutti gli oggetti Bookmark nella prima scheda o, per gli script vincolati a un documento, nella scheda attiva. Per recuperare tutti i preferiti in qualsiasi scheda, utilizza 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('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);

Invio

Bookmark[]: un array di 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

getCursor()

Recupera il cursore dell'utente nella scheda attiva. Uno script può accedere al cursore dell'utente che lo esegue solo se è legato 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.');
}

Invio

Position: una rappresentazione del cursore dell'utente oppure null se l'utente non ha un cursore inserito 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()

Recupera l'elenco degli editor di 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

getFooter()

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. Per ottenere la sezione del piè di pagina di qualsiasi scheda, utilizza il metodo DocumentTab.getFooter(). 

// 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 footer and logs it to the console.
console.log(doc.getFooter().getText());

Invio

FooterSection: il 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

getFootnotes()

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 qualsiasi scheda, utilizza il metodo DocumentTab.getFootnotes().

Le chiamate a getFootnotes 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());

Invio

Footnote[]: 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

getHeader()

Recupera la sezione dell'intestazione della prima scheda o, per gli script vincolati a un documento, la sezione dell'intestazione della scheda attiva. Per ottenere la sezione dell'intestazione di qualsiasi scheda, utilizza 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('123abc');

// Gets the text of the active or first tab's header and logs it to the console.
console.log(doc.getHeader().getText());

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

getId()

Recupera l'identificatore univoco del documento. L'ID documento viene utilizzato con DocumentApp.openById() per aprire un'istanza del documento specifica.

Invio

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

getLanguage()

Recupera il codice lingua del documento. Si tratta della lingua indicata in File > Lingua dell'editor di documenti, che potrebbe non essere la lingua effettiva del documento.

Invio

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

getName()

Recupera il titolo del documento.

Invio

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

getNamedRangeById(id)

Recupera il NamedRange con l'ID specificato nella prima scheda o, per gli script vincolati a un documento, nella scheda attiva. Per ottenere il NamedRange con l'ID specificato in qualsiasi scheda, utilizza il metodo DocumentTab.getNamedRangeById(id). Questo metodo restituisce null se non esiste un null di questo tipo nella scheda.NamedRange I nomi non sono necessariamente univoci, anche tra schede; diversi intervalli nella stessa scheda possono condividere lo stesso nome, in modo simile a un'entità in HTML. Al contrario, gli ID sono univoci all'interno della scheda, come un ID in HTML.

Parametri

NomeTipoDescrizione
idStringL'ID dell'intervallo, univoco all'interno della scheda.

Invio

NamedRange: il NamedRange 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

getNamedRanges()

Recupera tutti gli oggetti NamedRange nella prima scheda o, per gli script vincolati a un documento, nella scheda attiva. Per ottenere tutti gli oggetti NamedRange in qualsiasi scheda, utilizza il metodo DocumentTab.getNamedRanges().

A un NamedRange può accedere qualsiasi script che accede alla scheda. Per evitare conflitti involontari tra gli script, valuta la possibilità di anteporre ai nomi degli intervalli una stringa univoca.

Invio

NamedRange[]: un array di oggetti NamedRange nella scheda, che può 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

getNamedRanges(name)

Recupera tutti gli oggetti NamedRange con il nome specificato nella prima scheda o, per gli script associati a un documento, nella scheda attiva. Per recuperare tutti gli oggetti NamedRange in qualsiasi scheda, utilizza il metodo DocumentTab.getNamedRanges(name). I nomi non sono necessariamente univoci, anche tra 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.

A un NamedRange può accedere qualsiasi script che accede al documento. Per evitare conflitti involontari tra gli script, valuta la possibilità di anteporre ai nomi degli intervalli una stringa univoca.

Parametri

NomeTipoDescrizione
nameStringIl nome dell'intervallo, che non è necessariamente univoco.

Invio

NamedRange[]: un array di 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()

Recupera la selezione dell'utente nella scheda attiva. Uno script può accedere alla selezione dell'utente che lo esegue solo se è legato 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.');
}

Invio

Range: una rappresentazione della selezione dell'utente oppure 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 oppure 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 Google Documenti.

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)

Recupera il Tab con l'ID specificato. Questo metodo restituisce null se non esiste un null di questo tipo.Tab Può accedere alle schede a qualsiasi livello di nidificazione.

Parametri

NomeTipoDescrizione
tabIdStringL'ID della scheda da ottenere.

Invio

Tab: il Tab con l'ID specificato o null se non esiste un Tab di questo tipo.

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 i Tab non nidificati che fanno parte del documento.

Le schede possono contenere schede secondarie, una scheda nidificata in 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. 

const 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()

Recupera l'elenco di visualizzatori e commentatori per questo 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 vincolati a un documento, alla scheda attiva. Per creare un Position relativo a una posizione in qualsiasi scheda, utilizza il metodo DocumentTab.newPosition(element, offset). Il cursore dell'utente è rappresentato come 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

NomeTipoDescrizione
elementElementL'elemento che deve contenere il nuovo Position; deve essere un elemento Text o un elemento contenitore come Paragraph.
offsetIntegerPer 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.

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 generatore utilizzato per costruire oggetti Range dagli elementi della scheda nella prima scheda o, per gli script associati a un documento, nella scheda attiva. Per creare un generatore utilizzato per costruire oggetti DocumentRange da elementi di tabulazione in qualsiasi scheda, utilizza il metodo DocumentTab.newRange(). 

// 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());

Invio

RangeBuilder: il nuovo generatore.

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 di 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 è 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 spettatori.

Parametri

NomeTipoDescrizione
emailAddressStringL'indirizzo email dell'utente da rimuovere.

Invio

Document: questo Document, per l'accodamento.

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 di 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 è 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 spettatori.

Parametri

NomeTipoDescrizione
userUserUna rappresentazione dell'utente da rimuovere.

Invio

Document: questo Document, per l'accodamento.

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 il Document. Questo metodo non ha alcun effetto se l'utente è un editor, non uno spettatore o un commentatore. Inoltre, 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

NomeTipoDescrizione
emailAddressStringL'indirizzo email dell'utente da rimuovere.

Invio

Document: questo Document per l'accodamento.

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 il Document. Questo metodo non ha alcun effetto se l'utente è un editor e non un visualizzatore. Inoltre, questo metodo non impedisce agli utenti di accedere a Document se appartengono a una classe di utenti con 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

NomeTipoDescrizione
userUserUna rappresentazione dell'utente da rimuovere.

Invio

Document: questo Document per l'accodamento.

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 il Document corrente. Consente di svuotare la cache e applicare gli aggiornamenti in attesa.

Il metodo saveAndClose() viene invocato automaticamente al termine dell'esecuzione dello script per ogni Document modificabile aperto.

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('123abc');

Parametri

NomeTipoDescrizione
tabIdStringL'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, dato un Position. Uno script può accedere al cursore dell'utente che lo esegue solo se è legato al documento.

Se fornisci un Position da un Tab non attivo, la scheda attiva dell'utente cambia. 

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

NomeTipoDescrizione
positionPositionLa nuova posizione del cursore.

Invio

Document: questo Document, per l'accodamento.

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 della lingua del documento. Si tratta della lingua indicata in File > Lingua dell'editor di documenti, che potrebbe non essere la lingua effettiva del documento. Utilizza getSupportedLanguageCodes() per ottenere tutti i codici lingua validi.

Parametri

NomeTipoDescrizione
languageCodeStringIl codice lingua.

Invio

Document: questo Document, per l'accodamento.

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

NomeTipoDescrizione
nameStringIl titolo del nuovo 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, dato un Range. Uno script può accedere alla selezione dell'utente che lo esegue solo se è legato 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

NomeTipoDescrizione
rangeRangeIl nuovo intervallo di elementi da selezionare.

Invio

Document: questo Document, per l'accodamento.

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