Cette page a été traduite par l'API Cloud Translation.

Class DocumentApp

Le service de documents crée et ouvre Documents, qui peut être modifié.

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

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

Propriétés

Propriété	Type	Description
`Attribute`	`Attribute`	Énumération `Attribute`.
`ElementType`	`ElementType`	Énumération `ElementType`.
`FontFamily`	`FontFamily`	Énumération `FontFamily`.
`GlyphType`	`GlyphType`	Énumération `GlyphType`.
`HorizontalAlignment`	`HorizontalAlignment`	Énumération `HorizontalAlignment`.
`ParagraphHeading`	`ParagraphHeading`	Énumération `ParagraphHeading`.
`PositionedLayout`	`PositionedLayout`	Énumération `PositionedLayout`.
`TextAlignment`	`TextAlignment`	Énumération `TextAlignment`.
`VerticalAlignment`	`VerticalAlignment`	Énumération `VerticalAlignment`.

Méthodes

Méthode	Type renvoyé	Brève description
`create(name)`	`Document`	Crée et renvoie un document.
`getActiveDocument()`	`Document`	Renvoie le document auquel le script est lié à un conteneur.
`getUi()`	`Ui`	Renvoie une instance de l'environnement d'interface utilisateur du document qui permet au script d'ajouter des fonctionnalités telles que des menus, des boîtes de dialogue et des barres latérales.
`openById(id)`	`Document`	Renvoie le document avec l'ID spécifié.
`openByUrl(url)`	`Document`	Ouvre et renvoie le document avec l'URL spécifiée.

Documentation détaillée

`create(name)`

Crée et renvoie un document.

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

Paramètres

Nom	Type	Description
`name`	`String`	nom du nouveau document

Aller-retour

Document : nouvelle instance du document

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

https://www.googleapis.com/auth/documents

`getActiveDocument()`

Renvoie le document auquel le script est lié à un conteneur. Pour interagir avec un document auquel le script n'est pas lié à un conteneur, utilisez plutôt openById(id) ou openByUrl(url).

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

Aller-retour

Document : instance de document

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

https://www.googleapis.com/auth/documents.currentonly
https://www.googleapis.com/auth/documents

`getUi()`

Renvoie une instance de l'environnement d'interface utilisateur du document qui permet au script d'ajouter des fonctionnalités telles que des menus, des boîtes de dialogue et des barres latérales. Un script ne peut interagir avec l'interface utilisateur de l'instance actuelle d'un document ouvert que s'il est lié au document. Pour en savoir plus, consultez les guides des menus, ainsi que les boîtes de dialogue et les barres latérales.

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

Aller-retour

Ui : instance de l'environnement d'interface utilisateur de ce document

`openById(id)`

Renvoie le document avec l'ID spécifié. Si le script est lié à un conteneur, utilisez getActiveDocument().

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

Paramètres

Nom	Type	Description
`id`	`String`	ID du document à ouvrir

Aller-retour

Document : instance de document

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants :

https://www.googleapis.com/auth/documents

`openByUrl(url)`

Ouvre et renvoie le document avec l'URL spécifiée. Si le script est lié au conteneur du document, utilisez plutôt getActiveDocument().

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

Paramètres

Nom	Type	Description
`url`	`String`	URL du document à ouvrir

Aller-retour

Document : instance de document

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

https://www.googleapis.com/auth/documents