Class DocumentApp

DocumentApp

Il servizio documenti crea e apre il file Documents, che può essere modificato.

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

// 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 è collegato al container.
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.
var doc = DocumentApp.create('Document Name');

Parametri

NomeTipoDescrizione
nameStringil nome del nuovo documento

Ritorni

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 è collegato al container. Per interagire con un documento a cui lo script non è associato a un container, utilizza invece openById(id) o openByUrl(url).

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

Ritorni

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 lo script è associato al documento. Per ulteriori informazioni, consulta le guide ai menu e alle finestre di dialogo e 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();
}

Ritorni

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


openById(id)

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

// Open a document by ID.
var doc = DocumentApp.openById('DOCUMENT_ID_GOES_HERE');

Parametri

NomeTipoDescrizione
idStringL'ID del documento da aprire

Ritorni

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 a un container al documento, utilizza invece getActiveDocument().

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

Parametri

NomeTipoDescrizione
urlStringL'URL del documento da aprire

Ritorni

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