Class DocumentApp

Appdocumento

Il servizio di documenti crea e apre Documents che possono essere modificati. 

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
let doc = DocumentApp.openById('DOCUMENT_ID');

// Create and open a document.
doc = DocumentApp.create('Document Name');

Proprietà

ProprietàTipoDescrizione
AttributeAttributeL'enumerazione Attribute.
ElementTypeElementTypeL'enumerazione ElementType.
FontFamilyFontFamilyL'enumerazione FontFamily.
GlyphTypeGlyphTypeL'enumerazione GlyphType.
HorizontalAlignmentHorizontalAlignmentL'enumerazione HorizontalAlignment.
ParagraphHeadingParagraphHeadingL'enumerazione ParagraphHeading.
PositionedLayoutPositionedLayoutL'enumerazione PositionedLayout.
TextAlignmentTextAlignmentL'enumerazione TextAlignment.
VerticalAlignmentVerticalAlignmentL'enumerazione VerticalAlignment.

Metodi

MetodoTipo restituitoBreve descrizione
create(name)DocumentCrea e restituisce un nuovo documento.
getActiveDocument()DocumentRestituisce il documento a cui lo script è legato al contenitore.
getUi()UiRestituisce un'istanza dell'ambiente dell'interfaccia utente del documento che consente allo script di aggiungere funzionalità come menu, finestre di dialogo e barre laterali.
openById(id)DocumentRestituisce il documento con l'ID specificato.
openByUrl(url)DocumentApre e restituisce il documento con l'URL specificato.

Documentazione dettagliata

create(name)

Crea e restituisce un nuovo documento. 

// Create and open a new document.
const doc = DocumentApp.create('Document Name');

Parametri

NomeTipoDescrizione
nameStringIl nome del nuovo documento.

Invio

Document: la nuova istanza 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

getActiveDocument()

Restituisce il documento a cui lo script è legato al contenitore. Per interagire con il documento a cui lo script non è associato al contenitore, utilizza openById(id) o openByUrl(url). 

// Get the document to which this script is bound.
const doc = DocumentApp.getActiveDocument();

Invio

Document: l'istanza 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

getUi()

Restituisce un'istanza dell'ambiente dell'interfaccia utente del documento che consente allo script di aggiungere funzionalità come menu, finestre di dialogo e barre laterali. Uno script può interagire con l'interfaccia utente solo per l'istanza corrente di un documento aperto e solo se è legato al documento. Per ulteriori informazioni, consulta le guide ai menu e alle finestre di dialogo e alle barre laterali. 

// Add a custom menu to the active document, including a separator and a
// sub-menu.
function onOpen(e) {
  DocumentApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(
          DocumentApp.getUi()
              .createMenu('My sub-menu')
              .addItem('One sub-menu item', 'mySecondFunction')
              .addItem('Another sub-menu item', 'myThirdFunction'),
          )
      .addToUi();
}

Invio

Ui: un'istanza dell'ambiente dell'interfaccia utente di questo documento

openById(id)

Restituisce il documento con l'ID specificato. Se lo script è associato al contenitore del documento, utilizza invece getActiveDocument(). 

// Open a document by ID.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('DOCUMENT_ID');

Parametri

NomeTipoDescrizione
idStringL'ID del documento da aprire.

Invio

Document: l'istanza 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

openByUrl(url)

Apre e restituisce il documento con l'URL specificato. Se lo script è associato al contenitore del documento, utilizza invece getActiveDocument(). 

// Open a document by URL.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit',
);

Parametri

NomeTipoDescrizione
urlStringl'URL del documento da aprire

Invio

Document: l'istanza 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