Class Document

Documento

Un documento contenente RTF ed elementi 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");

Metodi

MetodoTipo restituitoBreve descrizione
addBookmark(position)BookmarkAggiunge un valore Bookmark al valore Position specificato.
addEditor(emailAddress)DocumentAggiunge l'utente specificato all'elenco degli editor per Document.
addEditor(user)DocumentAggiunge l'utente specificato all'elenco degli editor per Document.
addEditors(emailAddresses)DocumentAggiunge l'array specificato di utenti all'elenco degli editor per Document.
addFooter()FooterSectionAggiunge una sezione per il piè di pagina del documento, se non esiste.
addHeader()HeaderSectionAggiunge una sezione di intestazione del documento, se non ne esiste nessuna.
addNamedRange(name, range)NamedRangeAggiunge un NamedRange, ovvero un Range con un nome e un ID da utilizzare per il recupero in un secondo momento.
addViewer(emailAddress)DocumentAggiunge l'utente specificato all'elenco dei visualizzatori per Document.
addViewer(user)DocumentAggiunge l'utente specificato all'elenco dei visualizzatori per Document.
addViewers(emailAddresses)DocumentAggiunge l'array specificato di utenti all'elenco dei visualizzatori per Document.
getAs(contentType)BlobRecupera i contenuti attuali di Document come blob del tipo specificato.
getBlob()BlobRecupera i contenuti attuali di Document come blob.
getBody()BodyRecupera il Body del documento attivo.
getBookmark(id)BookmarkRecupera Bookmark con l'ID specificato.
getBookmarks()Bookmark[]Recupera tutti gli oggetti Bookmark nel documento.
getCursor()PositionRestituisce il cursore dell'utente nel documento attivo.
getEditors()User[]Consente di acquisire l'elenco degli editor di Document.
getFooter()FooterSectionRecupera la sezione del piè di pagina del documento, se esistente.
getFootnotes()Footnote[]Recupera tutti gli elementi Footnote nel corpo del documento.
getHeader()HeaderSectionRecupera la sezione di intestazione del documento, se esistente.
getId()StringRecupera l'identificatore univoco del documento.
getLanguage()StringRestituisce il codice lingua del documento.
getName()StringRecupera il titolo del documento.
getNamedRangeById(id)NamedRangeRecupera NamedRange con l'ID specificato.
getNamedRanges()NamedRange[]Recupera tutti gli oggetti NamedRange nel documento.
getNamedRanges(name)NamedRange[]Restituisce tutti gli oggetti NamedRange nel documento con il nome specificato.
getSelection()RangeRestituisce la selezione dell'utente nel documento attivo.
getSupportedLanguageCodes()String[]Visualizza tutti i codici lingua supportati nei file di Documenti Google.
getUrl()StringRecupera l'URL per accedere al documento corrente.
getViewers()User[]Visualizza l'elenco di spettatori e commentatori per Document.
newPosition(element, offset)PositionCrea un nuovo Position, ovvero un riferimento a una posizione nel documento rispetto a un elemento specifico.
newRange()RangeBuilderCrea un generatore utilizzato per costruire Range oggetti dagli elementi del documento.
removeEditor(emailAddress)DocumentRimuove l'utente specificato dall'elenco degli editor per Document.
removeEditor(user)DocumentRimuove l'utente specificato dall'elenco degli editor per Document.
removeViewer(emailAddress)DocumentRimuove l'utente specificato dall'elenco dei visualizzatori e commentatori per Document.
removeViewer(user)DocumentRimuove l'utente specificato dall'elenco dei visualizzatori e commentatori per Document.
saveAndClose()voidSalva l'attuale Document.
setCursor(position)DocumentImposta il cursore dell'utente nel documento attivo, a cui viene assegnato un Position.
setLanguage(languageCode)DocumentImposta il codice lingua del documento.
setName(name)DocumentImposta il titolo del documento.
setSelection(range)DocumentImposta la selezione dell'utente nel documento attivo a cui viene assegnato un Range.

Documentazione dettagliata

addBookmark(position)

Aggiunge un valore Bookmark al valore Position 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('abc123456');

// Gets the document 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.

Ritorni

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 per Document. Se l'utente era già nell'elenco degli spettatori, scegli questo metodo per escluderlo.

Parametri

NomeTipoDescrizione
emailAddressStringL'indirizzo email dell'utente da aggiungere.

Ritorni

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

addEditor(user)

Aggiunge l'utente specificato all'elenco degli editor per Document. Se l'utente era già nell'elenco degli spettatori, scegli questo metodo per escluderlo.

Parametri

NomeTipoDescrizione
userUserUna rappresentazione dell'utente da aggiungere.

Ritorni

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

addEditors(emailAddresses)

Aggiunge l'array specificato di utenti all'elenco degli editor per Document. Se uno degli utenti era già presente nell'elenco degli spettatori, questo metodo lo promuove fuori dall'elenco degli spettatori.

Parametri

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

Ritorni

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

addFooter()

Aggiunge una sezione per il piè di pagina del documento, se non esiste. 

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

// Adds a footer to the document.
const footer = doc.addFooter();

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

Ritorni

FooterSection: piè di pagina 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

addHeader()

Aggiunge una sezione di intestazione del documento, se non ne esiste nessuna. 

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

// Adds a header to the document.
const header = doc.addHeader();

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

Ritorni

HeaderSection: intestazione 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

addNamedRange(name, range)

Aggiunge un NamedRange, ovvero un Range con un nome e un ID da utilizzare per il recupero in un secondo momento. I nomi non sono necessariamente univoci: più intervalli diversi 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 elemento NamedRange a un documento, non puoi modificarlo, ma solo rimuoverlo.

Tutti gli script che accedono al documento possono accedere a un NamedRange. Per evitare conflitti involontari tra gli script, puoi anteporre una stringa univoca ai nomi degli intervalli. 

// Creates a named range that includes every table in the document.
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.addNamedRange('Document tables', rangeBuilder.build());

Parametri

NomeTipoDescrizione
nameStringIl nome dell'intervallo, che non deve essere univoco. I nomi degli intervalli devono essere compresi 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 creato manualmente con newRange().

Ritorni

NamedRange: 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 dei visualizzatori per Document. Se l'utente era già nell'elenco degli editor, questo metodo non ha effetto.

Parametri

NomeTipoDescrizione
emailAddressStringL'indirizzo email dell'utente da aggiungere.

Ritorni

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

addViewer(user)

Aggiunge l'utente specificato all'elenco dei visualizzatori per Document. Se l'utente era già nell'elenco degli editor, questo metodo non ha effetto.

Parametri

NomeTipoDescrizione
userUserUna rappresentazione dell'utente da aggiungere.

Ritorni

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

addViewers(emailAddresses)

Aggiunge l'array specificato di utenti all'elenco dei visualizzatori per Document. Se qualcuno degli utenti era già presente nell'elenco degli editor, questo metodo non produce alcun effetto.

Parametri

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

Ritorni

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

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

// 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. Al momento è supportato solo 'application/pdf'.

Ritorni

Blob: documento corrente sotto forma di 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('abc123456');

// Retrieves the current document's contents as a blob and logs it to the console.
console.log(doc.getBlob().getContentType());

Ritorni

Blob: documento corrente sotto forma di blob.

getBody()

Recupera il Body del documento attivo.

I documenti possono contenere diversi tipi di sezioni (ad esempio, HeaderSection, FooterSection). La sezione attiva di un documento è la Body.

I metodi degli elementi in Document delegano 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('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Ritorni

Body: la sezione del corpo del documento 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

getBookmark(id)

Recupera Bookmark con l'ID specificato. Questo metodo restituisce null se questo Bookmark non esiste. 

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

// Gets the bookmark by its ID.
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 di Bookmark.

Ritorni

Bookmark: Bookmark con l'ID specificato oppure null se questo Bookmark 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

getBookmarks()

Recupera tutti gli oggetti Bookmark nel documento. 

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

// Gets all of the bookmarks in the document.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the document to the console.
console.log(bookmarks.length);

Ritorni

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

getCursor()

Restituisce il cursore dell'utente nel documento attivo. Uno script può accedere solo al cursore dell'utente che lo esegue e solo se è associato 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.');
}

Ritorni

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

Consente di acquisire l'elenco degli editor di Document.

Ritorni

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 del documento, se esistente. 

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

// Gets the text of the document's footer and logs it to the console.
console.log(doc.getFooter().getText());

Ritorni

FooterSection: piè di pagina 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

getFootnotes()

Recupera tutti gli elementi Footnote nel corpo del documento.

Le chiamate a getFootnotes causano un'iterazione sugli elementi del documento. Per i documenti 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('abc123456');

// Gets the first footnote.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Ritorni

Footnote[]: le note a piè di pagina 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

getHeader()

Recupera la sezione di intestazione del documento, se esistente. 

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

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

Ritorni

HeaderSection: intestazione 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

getId()

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

Ritorni

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

Restituisce il codice lingua del documento. Questa è la lingua mostrata in File > Lingua dell'editor del documento, che potrebbe non essere la lingua effettiva del documento.

Ritorni

String: lingua del documento oppure 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.

Ritorni

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 NamedRange con l'ID specificato. Questo metodo restituisce null se questo NamedRange non esiste. I nomi non sono necessariamente univoci: diversi intervalli nello stesso documento possono condividere lo stesso nome, proprio come una classe in HTML. Gli ID, invece, sono univoci all'interno del documento, come gli ID in HTML.

Parametri

NomeTipoDescrizione
idStringl'ID dell'intervallo, che è univoco all'interno del documento

Ritorni

NamedRange: NamedRange con l'ID specificato oppure null se questo intervallo 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

getNamedRanges()

Recupera tutti gli oggetti NamedRange nel documento.

È possibile accedere a NamedRange da qualsiasi script che accede al documento. Per evitare conflitti involontari tra gli script, ti consigliamo di anteporre una stringa univoca ai nomi degli intervalli.

Ritorni

NamedRange[]: un array di oggetti NamedRange nel documento, 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

getNamedRanges(name)

Restituisce tutti gli oggetti NamedRange nel documento con il nome specificato. I nomi non sono necessariamente univoci; diversi intervalli diversi nello stesso documento possono condividere lo stesso nome, proprio come una classe in HTML. Gli ID, invece, sono univoci all'interno del documento, come gli ID in HTML.

È possibile accedere a NamedRange da qualsiasi script che accede al documento. Per evitare conflitti involontari tra gli script, ti consigliamo di anteporre una stringa univoca ai nomi degli intervalli.

Parametri

NomeTipoDescrizione
nameStringil nome dell'intervallo, che non è necessariamente univoco

Ritorni

NamedRange[]: un array di NamedRange oggetti nel documento 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 nel documento attivo. Uno script può accedere solo alla selezione dell'utente che lo esegue e solo se è associato 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.');
}

Ritorni

Range: una rappresentazione della selezione dell'utente oppure null se l'utente non ha selezionato nulla nel documento, 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

getSupportedLanguageCodes()

Visualizza tutti i codici lingua supportati nei file di Documenti Google.

Ritorni

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

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

Ritorni

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

Visualizza l'elenco di spettatori e commentatori per Document.

Ritorni

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, ovvero un riferimento a una posizione nel documento rispetto a un elemento specifico. Il cursore dell'utente è rappresentato come Position, tra gli altri utilizzi. 

// Append a paragraph, 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

NomeTipoDescrizione
elementElementl'elemento che conterrà 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

Ritorni

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 Range oggetti dagli elementi del documento. 

// Change the user's selection to a range that includes every table in the document.
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());

Ritorni

RangeBuilder: il nuovo strumento di creazione

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 è condiviso con l'intero dominio dell'utente o se Document si trova su un Drive condiviso a cui l'utente può accedere.

Per i file di Drive, l'utente viene rimosso anche dall'elenco dei visualizzatori.

Parametri

NomeTipoDescrizione
emailAddressStringL'indirizzo email dell'utente da rimuovere.

Ritorni

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

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 è condiviso con l'intero dominio dell'utente o se Document si trova su un Drive condiviso a cui l'utente può accedere.

Per i file di Drive, l'utente viene rimosso anche dall'elenco dei visualizzatori.

Parametri

NomeTipoDescrizione
userUserUna rappresentazione dell'utente da rimuovere.

Ritorni

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

removeViewer(emailAddress)

Rimuove l'utente specificato dall'elenco dei visualizzatori e commentatori per Document. Questo metodo non ha 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 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
emailAddressStringL'indirizzo email dell'utente da rimuovere.

Ritorni

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

removeViewer(user)

Rimuove l'utente specificato dall'elenco dei visualizzatori e commentatori per Document. Questo metodo non ha effetto se l'utente è un editor, non un visualizzatore. Questo metodo non impedisce inoltre 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 su 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.

Ritorni

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

saveAndClose()

Salva l'attuale Document. 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.

Una Document chiusa non può essere modificata. Utilizza 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

setCursor(position)

Imposta il cursore dell'utente nel documento attivo, a cui viene assegnato un Position. Uno script può accedere solo al cursore dell'utente che lo esegue e solo se è associato al documento. 

// Append a paragraph, 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

NomeTipoDescrizione
positionPositionla nuova posizione del cursore

Ritorni

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

setLanguage(languageCode)

Imposta il codice lingua del documento. Questa è la lingua mostrata in File > Lingua dell'editor del documento, che potrebbe non essere la lingua effettiva del documento. Utilizza getSupportedLanguageCodes() per ricevere tutti i codici lingua validi.

Parametri

NomeTipoDescrizione
languageCodeStringIl codice lingua.

Ritorni

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

setName(name)

Imposta il titolo del documento.

Parametri

NomeTipoDescrizione
nameStringil nuovo titolo del documento

Ritorni

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 nel documento attivo a cui viene assegnato un Range. Uno script può accedere solo alla selezione dell'utente che lo esegue e solo se è associato al documento. 

// Change the user's selection to a range that includes every table in the document.
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());

Parametri

NomeTipoDescrizione
rangeRangeil nuovo intervallo di elementi da selezionare

Ritorni

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