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

Class DocumentApp

Le service de documents crée et ouvre des Documents pouvant être modifiés.

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

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 affiche un document.
`getActiveDocument()`	`Document`	Renvoie le document auquel le script est lié au 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 dont l'ID est indiqué.
`openByUrl(url)`	`Document`	Ouvre et renvoie le document avec l'URL spécifiée.

Documentation détaillée

`create(name)`

Crée et affiche un document.

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

Paramètres

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

Renvois

Document : nouvelle 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

`getActiveDocument()`

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

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

Renvois

Document : 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.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'UI que pour l'instance actuelle d'un document ouvert, et uniquement si le script est lié au document. Pour en savoir plus, consultez les guides sur les menus et les boîtes de dialogue et 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();
}

Renvois

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

`openById(id)`

Renvoie le document dont l'ID est indiqué. Si le script est lié au conteneur du document, utilisez plutôt getActiveDocument().

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

Paramètres

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

Renvois

Document : 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

`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.
const doc = DocumentApp.openByUrl(
    'https://docs.google.com/document/d/1234567890abcdefghijklmnopqrstuvwxyz_a1b2c3/edit',
);

Paramètres

Nom	Type	Description
`url`	`String`	l'URL du document à ouvrir ;

Renvois

Document : 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