Class DocumentApp

DocumentApp

Le service Documents crée et ouvre un fichier Documents modifiable.

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

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

Propriétés

PropriétéTypeDescription
AttributeAttributeL'énumération Attribute.
ElementTypeElementTypeL'énumération ElementType.
FontFamilyFontFamilyL'énumération FontFamily.
GlyphTypeGlyphTypeL'énumération GlyphType.
HorizontalAlignmentHorizontalAlignmentL'énumération HorizontalAlignment.
ParagraphHeadingParagraphHeadingL'énumération ParagraphHeading.
PositionedLayoutPositionedLayoutL'énumération PositionedLayout.
TextAlignmentTextAlignmentL'énumération TextAlignment.
VerticalAlignmentVerticalAlignmentL'énumération VerticalAlignment.

Méthodes

MéthodeType renvoyéBrève description
create(name)DocumentCrée et renvoie un document.
getActiveDocument()DocumentRenvoie le document dans 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 fonctionnalités telles que les menus, les boîtes de dialogue et les barres latérales.
openById(id)DocumentRenvoie le document dont l'ID est spécifié.
openByUrl(url)DocumentOuvre 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

NomTypeDescription
nameStringNom du nouveau document.

Renvois

Document : nouvelle instance du document.

Autorisation

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

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

getActiveDocument()

Renvoie le document dans lequel le script est lié au conteneur. Pour interagir avec un document sur lequel le script n'est pas limité au conteneur, utilisez openById(id) ou openByUrl(url). à la place.

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

Renvois

Document : instance du document

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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 fonctionnalités telles que les menus, les boîtes de dialogue et les barres latérales. Un script ne peut interagir avec l'interface utilisateur que pour la instance actuelle d'un document ouvert, et uniquement si le script est lié au document. Pour en savoir plus, consultez les des guides sur les menus, ainsi que sur 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();
}

Renvois

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


openById(id)

Renvoie le document dont l'ID est spécifié. Si le script est lié au document par un conteneur, utilisez plutôt getActiveDocument().

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

Paramètres

NomTypeDescription
idStringID du document à ouvrir.

Renvois

Document : instance du document.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation correspondant à 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é à un conteneur , 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 du document

Autorisation

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

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