Class DocumentApp

DocumentApp

Le service Documents crée et ouvre des Documents qui peuvent être modifiés.

// 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éTypeDescription
AttributeAttributeÉnumération Attribute.
ElementTypeElementTypeÉnumération ElementType.
FontFamilyFontFamilyÉnumération FontFamily.
GlyphTypeGlyphTypeÉnumération GlyphType.
HorizontalAlignmentHorizontalAlignmentÉnumération HorizontalAlignment.
ParagraphHeadingParagraphHeadingÉnumération ParagraphHeading.
PositionedLayoutPositionedLayoutÉnumération PositionedLayout.
TextAlignmentTextAlignmentÉnumération TextAlignment.
VerticalAlignmentVerticalAlignmentÉnumération VerticalAlignment.

Méthodes

MéthodeType renvoyéBrève description
create(name)DocumentCrée et affiche un document.
getActiveDocument()DocumentRenvoie le document pour lequel le script est lié au conteneur.
getUi()UiRenvoie 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)DocumentRenvoie le document portant l'identifiant spécifié.
openByUrl(url)DocumentOuvre 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.
var doc = DocumentApp.create('Document Name');

Paramètres

NomTypeDescription
nameStringle nom du nouveau document

Renvois

Document : nouvelle instance de document

Autorisation

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

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

getActiveDocument()

Renvoie le document pour lequel le script est lié au conteneur. Pour interagir avec le document pour lequel 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();

Renvois

Document : instance de document

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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 que pour l'instance actuelle d'un document ouvert, et uniquement s'il 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 portant l'identifiant spécifié. Si le script est lié au conteneur du document, utilisez plutôt getActiveDocument().

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

Paramètres

NomTypeDescription
idStringID du document à ouvrir

Renvois

Document : instance de document

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation associée à 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

NomTypeDescription
urlStringl'URL du document à ouvrir

Renvois

Document : instance de document

Autorisation

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

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