Class Document

Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.
Document

Document contenant du texte enrichi et des éléments tels que des tableaux et des listes.

Les documents peuvent être ouverts ou créés avec DocumentApp.

// Open a document by ID.
var doc = DocumentApp.openById("<my-id>");

// Create and open a document.
doc = DocumentApp.create("Document Title");

Méthodes

MéthodeType renvoyéBrève description
addBookmark(position)BookmarkAjoute un Bookmark au Position donné.
addEditor(emailAddress)DocumentAjoute l'utilisateur donné à la liste des éditeurs pour Document.
addEditor(user)DocumentAjoute l'utilisateur donné à la liste des éditeurs pour Document.
addEditors(emailAddresses)DocumentAjoute le tableau d'utilisateurs donné à la liste des éditeurs pour Document.
addFooter()FooterSectionAjoute une section de pied de page de document, s'il n'en existe aucune.
addHeader()HeaderSectionAjoute une section d'en-tête de document (s'il n'en existe aucune).
addNamedRange(name, range)NamedRangeAjoute un NamedRange, qui est un Range avec un nom et un ID à utiliser pour la récupération ultérieure.
addViewer(emailAddress)DocumentAjoute l'utilisateur donné à la liste des lecteurs de Document.
addViewer(user)DocumentAjoute l'utilisateur donné à la liste des lecteurs de Document.
addViewers(emailAddresses)DocumentAjoute le tableau d'utilisateurs donné à la liste des lecteurs pour Document.
getAs(contentType)BlobRécupère le contenu Document actuel en tant qu'objet blob du type spécifié.
getBlob()BlobRécupère le contenu Document actuel en tant qu'objet blob.
getBody()BodyRécupère le Body du document actif.
getBookmark(id)BookmarkRécupère les Bookmark avec l'ID donné.
getBookmarks()Bookmark[]Récupère tous les objets Bookmark du document.
getCursor()PositionRécupère le curseur de l'utilisateur dans le document actif.
getEditors()User[]Récupère la liste des éditeurs pour cet élément Document.
getFooter()FooterSectionRécupère la section du pied de page du document, le cas échéant.
getFootnotes()Footnote[]Récupère tous les éléments Footnote du corps du document.
getHeader()HeaderSectionRécupère la section d'en-tête du document, le cas échéant.
getId()StringRécupère l'identifiant unique du document.
getLanguage()StringRécupère le code de langue du document.
getName()StringRécupère le titre du document.
getNamedRangeById(id)NamedRangeRécupère les NamedRange avec l'ID donné.
getNamedRanges()NamedRange[]Récupère tous les objets NamedRange du document.
getNamedRanges(name)NamedRange[]Récupère tous les objets NamedRange du document portant le nom donné.
getSelection()RangeRécupère la sélection de l'utilisateur dans le document actif.
getSupportedLanguageCodes()String[]Récupère tous les codes de langue compatibles avec les fichiers Google Docs.
getUrl()StringRécupère l'URL permettant d'accéder au document actuel.
getViewers()User[]Récupère la liste des lecteurs et des commentateurs de cet élément Document.
newPosition(element, offset)PositionCrée une valeur Position, qui est une référence à un emplacement dans le document, par rapport à un élément spécifique.
newRange()RangeBuilderCrée un compilateur utilisé pour construire des objets Range à partir d'éléments de document.
removeEditor(emailAddress)DocumentSupprime l'utilisateur donné de la liste des éditeurs pour Document.
removeEditor(user)DocumentSupprime l'utilisateur donné de la liste des éditeurs pour Document.
removeViewer(emailAddress)DocumentSupprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour Document.
removeViewer(user)DocumentSupprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour Document.
saveAndClose()voidEnregistre le Document actuel.
setCursor(position)DocumentDéfinit le curseur de l'utilisateur dans le document actif, en fonction d'un Position.
setLanguage(languageCode)DocumentDéfinit le code de langue du document.
setName(name)DocumentDéfinit le titre du document.
setSelection(range)DocumentDéfinit la sélection de l'utilisateur dans le document actif, en fonction d'une Range.

Documentation détaillée

addBookmark(position)

Ajoute un Bookmark au Position donné.

Paramètres

NomTypeDescription
positionPositionla position du nouveau favori

Aller-retour

Bookmark : nouveau favori

Autorisation

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

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

addEditor(emailAddress)

Ajoute l'utilisateur donné à la liste des éditeurs pour Document. Si l'utilisateur se trouvait déjà dans la liste, cette méthode le promeut sur la liste.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à ajouter.

Aller-retour

Document : cet élément Document, pour le chaînage.

Autorisation

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

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

addEditor(user)

Ajoute l'utilisateur donné à la liste des éditeurs pour Document. Si l'utilisateur se trouvait déjà dans la liste, cette méthode le promeut sur la liste.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Aller-retour

Document : cet élément Document, pour le chaînage.

Autorisation

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

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

addEditors(emailAddresses)

Ajoute le tableau d'utilisateurs donné à la liste des éditeurs pour Document. Si l'un des utilisateurs figurait déjà dans la liste des spectateurs, cette méthode le fait sortir de cette liste.

Paramètres

NomTypeDescription
emailAddressesString[]Tableau des adresses e-mail des utilisateurs à ajouter.

Aller-retour

Document : cet élément Document, pour le chaînage.

Autorisation

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

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

addFooter()

Ajoute une section de pied de page de document, s'il n'en existe aucune.

Aller-retour

FooterSection : pied de page du document

Autorisation

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

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

addHeader()

Ajoute une section d'en-tête de document (s'il n'en existe aucune).

Aller-retour

HeaderSection : en-tête du document

Autorisation

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

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

addNamedRange(name, range)

Ajoute un NamedRange, qui est un Range avec un nom et un ID à utiliser pour la récupération ultérieure. Les noms ne sont pas nécessairement uniques. Plusieurs plages différentes d'un même document peuvent partager le même nom, à l'instar d'une classe en HTML. En revanche, les ID sont uniques dans le document, comme un ID en HTML. Une fois que vous avez ajouté un NamedRange à un document, vous ne pouvez plus le modifier, mais seulement le supprimer.

Tout script accédant au document peut accéder à un NamedRange. Pour éviter les conflits involontaires entre les scripts, envisagez de préfixer les noms de plages par une chaîne unique.

// Creates a named range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.addNamedRange('Document tables', rangeBuilder.build());

Paramètres

NomTypeDescription
nameStringNom de la plage, qui n'a pas besoin d'être unique. Les noms de plage doivent comporter entre 1 et 256 caractères.
rangeRangePlage d'éléments à associer au nom. Il peut s'agir de la sélection active, d'un résultat de recherche ou d'une construction manuelle avec newRange().

Aller-retour

NamedRange : NamedRange.

Autorisation

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

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

addViewer(emailAddress)

Ajoute l'utilisateur donné à la liste des lecteurs de Document. Si l'utilisateur figure déjà dans la liste des éditeurs, cette méthode n'a aucun effet.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à ajouter.

Aller-retour

Document : cet élément Document, pour le chaînage.

Autorisation

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

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

addViewer(user)

Ajoute l'utilisateur donné à la liste des lecteurs de Document. Si l'utilisateur figure déjà dans la liste des éditeurs, cette méthode n'a aucun effet.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Aller-retour

Document : cet élément Document, pour le chaînage.

Autorisation

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

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

addViewers(emailAddresses)

Ajoute le tableau d'utilisateurs donné à la liste des lecteurs pour Document. Si l'un des utilisateurs figurait déjà dans la liste des éditeurs, cette méthode n'a aucun effet pour eux.

Paramètres

NomTypeDescription
emailAddressesString[]Tableau des adresses e-mail des utilisateurs à ajouter.

Aller-retour

Document : cet élément Document, pour le chaînage.

Autorisation

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

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

getAs(contentType)

Récupère le contenu Document actuel en tant qu'objet blob du type spécifié.

Paramètres

NomTypeDescription
contentTypeStringType MIME vers lequel effectuer la conversion. Actuellement, seul 'application/pdf' est accepté.

Aller-retour

Blob : document actuel sous forme de blob


getBlob()

Récupère le contenu Document actuel en tant qu'objet blob.

Aller-retour

Blob : document actuel sous forme de blob


getBody()

Récupère le Body du document actif.

Les documents peuvent contenir différents types de sections (par exemple, HeaderSection et FooterSection). La section active d'un document est Body.

Les méthodes d'élément dans Document délèguent le Body actif.

Aller-retour

Body : section du corps du document actif

Autorisation

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

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

getBookmark(id)

Récupère les Bookmark avec l'ID donné. Cette méthode renvoie null si aucun Bookmark de ce type n'existe.

Paramètres

NomTypeDescription
idStringl'ID de Bookmark

Aller-retour

Bookmark : Bookmark avec l'ID donné, ou null si aucun Bookmark n'existe

Autorisation

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

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

getBookmarks()

Récupère tous les objets Bookmark du document.

Aller-retour

Bookmark[] : tableau des objets Bookmark du document

Autorisation

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

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

getCursor()

Récupère le curseur de l'utilisateur dans le document actif. Un script ne peut accéder qu'au curseur de l'utilisateur qui l'exécute et uniquement s'il est lié au document.

// Insert some text at the cursor position and make it bold.
var cursor = DocumentApp.getActiveDocument().getCursor();
if (cursor) {
  // Attempt to insert text at the cursor position. If the insertion returns null, the cursor's
  // containing element doesn't allow insertions, so show the user an error message.
  var element = cursor.insertText('ಠ‿ಠ');
  if (element) {
    element.setBold(true);
  } else {
    DocumentApp.getUi().alert('Cannot insert text here.');
  }
} else {
  DocumentApp.getUi().alert('Cannot find a cursor.');
}

Aller-retour

Position : représentation du curseur de l'utilisateur, ou null si l'utilisateur n'a pas placé de curseur dans le document ou si le script n'est pas lié au document.

Autorisation

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

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

getEditors()

Récupère la liste des éditeurs pour cet élément Document.

Aller-retour

User[] : tableau des utilisateurs disposant de droits de modification.

Autorisation

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

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

getFooter()

Récupère la section du pied de page du document, le cas échéant.

Aller-retour

FooterSection : pied de page du document

Autorisation

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

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

getFootnotes()

Récupère tous les éléments Footnote du corps du document.

Les appels à getFootnotes entraînent une itération sur les éléments du document. Pour les documents volumineux, évitez d'appeler inutilement cette méthode.

Aller-retour

Footnote[] : notes de bas de page du document

Autorisation

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

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

getHeader()

Récupère la section d'en-tête du document, le cas échéant.

Aller-retour

HeaderSection : en-tête du document

Autorisation

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

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

getId()

Récupère l'identifiant unique du document. L'ID du document est utilisé avec DocumentApp.openById() pour ouvrir une instance de document spécifique.

Aller-retour

String : ID du document

Autorisation

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

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

getLanguage()

Récupère le code de langue du document. Il s'agit de la langue affichée dans Fichier > Langue de l'éditeur de documents, qui peut ne pas correspondre à la langue réelle du document.

Aller-retour

String : langue du document, ou null si elle n'est pas définie.

Autorisation

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

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

getName()

Récupère le titre du document.

Aller-retour

String : titre du document

Autorisation

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

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

getNamedRangeById(id)

Récupère les NamedRange avec l'ID donné. Cette méthode renvoie null si aucun NamedRange de ce type n'existe. Les noms ne sont pas nécessairement uniques. Plusieurs plages différentes d'un même document peuvent partager le même nom, à l'instar d'une classe en HTML. En revanche, les ID sont uniques dans le document, comme un ID en HTML.

Paramètres

NomTypeDescription
idStringID de la plage, unique dans le document

Aller-retour

NamedRange : NamedRange avec l'ID donné, ou null si aucune plage de ce type n'existe

Autorisation

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

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

getNamedRanges()

Récupère tous les objets NamedRange du document.

Un NamedRange est accessible par tout script accédant au document. Pour éviter les conflits involontaires entre les scripts, envisagez de préfixer les noms de plages par une chaîne unique.

Aller-retour

NamedRange[] : tableau des objets NamedRange du document, pouvant inclure plusieurs plages du même nom

Autorisation

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

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

getNamedRanges(name)

Récupère tous les objets NamedRange du document portant le nom donné. Les noms ne sont pas nécessairement uniques. Plusieurs plages différentes d'un même document peuvent partager le même nom, un peu comme une classe en HTML. En revanche, les ID sont uniques dans le document, comme un ID en HTML.

Un NamedRange est accessible par tout script accédant au document. Pour éviter les conflits involontaires entre les scripts, envisagez de préfixer les noms de plages par une chaîne unique.

Paramètres

NomTypeDescription
nameStringNom de la plage, qui n'est pas nécessairement unique

Aller-retour

NamedRange[] : tableau des objets NamedRange du document portant le nom donné

Autorisation

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

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

getSelection()

Récupère la sélection de l'utilisateur dans le document actif. Un script ne peut accéder qu'à la sélection de l'utilisateur qui l'exécute et uniquement s'il est lié au document.

// Display a dialog box that tells the user how many elements are included in the selection.
var selection = DocumentApp.getActiveDocument().getSelection();
if (selection) {
  var elements = selection.getRangeElements();
  DocumentApp.getUi().alert('Number of selected elements: ' + elements.length);
} else {
  DocumentApp.getUi().alert('Nothing is selected.');
}

Aller-retour

Range : représentation de la sélection de l'utilisateur, ou null si aucun élément n'est sélectionné dans le document, si la fin d'un paragraphe est sélectionnée, si seule la fin d'un paragraphe et une nouvelle ligne sont sélectionnées, ou si le script n'est pas lié au document.

Autorisation

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

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

getSupportedLanguageCodes()

Récupère tous les codes de langue compatibles avec les fichiers Google Docs.

Aller-retour

String[] : tableau des codes de langue.

Autorisation

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

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

getUrl()

Récupère l'URL permettant d'accéder au document actuel.

var doc = DocumentApp.getActiveDocument();

// Send out the link to open the document.
MailApp.sendEmail("<email-address>", doc.getName(), doc.getUrl());

Aller-retour

String : URL permettant d'accéder au document actuel

Autorisation

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

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

getViewers()

Récupère la liste des lecteurs et des commentateurs de cet élément Document.

Aller-retour

User[] : tableau des utilisateurs disposant de droits d'affichage ou de commentaires.

Autorisation

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

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

newPosition(element, offset)

Crée une valeur Position, qui est une référence à un emplacement dans le document, par rapport à un élément spécifique. Le curseur de l'utilisateur est représenté par un Position, entre autres utilisations.

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Paramètres

NomTypeDescription
elementElementÉlément qui contiendra le nouveau Position. Il doit s'agir d'un élément Text ou d'un élément conteneur comme Paragraph.
offsetIntegerPour les éléments Text, le nombre de caractères avant Position ; pour les autres éléments, le nombre d'éléments enfants avant Position dans le même élément conteneur

Aller-retour

Position : nouveau Position

Autorisation

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

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

newRange()

Crée un compilateur utilisé pour construire des objets Range à partir d'éléments de document.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Aller-retour

RangeBuilder : le nouveau compilateur

Autorisation

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

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

removeEditor(emailAddress)

Supprime l'utilisateur donné de la liste des éditeurs pour Document. Cette méthode n'empêche pas les utilisateurs d'accéder à Document s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général, par exemple, si Document est partagé avec l'ensemble du domaine de l'utilisateur ou si Document se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également retiré de la liste des lecteurs.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à supprimer.

Aller-retour

Document : cet élément Document, pour le chaînage.

Autorisation

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

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

removeEditor(user)

Supprime l'utilisateur donné de la liste des éditeurs pour Document. Cette méthode n'empêche pas les utilisateurs d'accéder à Document s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général, par exemple, si Document est partagé avec l'ensemble du domaine de l'utilisateur ou si Document se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également retiré de la liste des lecteurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Aller-retour

Document : cet élément Document, pour le chaînage.

Autorisation

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

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

removeViewer(emailAddress)

Supprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour Document. Cette méthode n'a aucun effet si l'utilisateur est un éditeur, et non un lecteur ou un commentateur. Cette méthode n'empêche pas non plus les utilisateurs d'accéder à Document s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général, par exemple, si Document est partagé avec l'ensemble du domaine de l'utilisateur ou si Document se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également retiré de la liste des éditeurs.

Paramètres

NomTypeDescription
emailAddressStringAdresse e-mail de l'utilisateur à supprimer.

Aller-retour

Document : cet élément (Document) pour le chaînage.

Autorisation

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

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

removeViewer(user)

Supprime l'utilisateur donné de la liste des lecteurs et des commentateurs pour Document. Cette méthode n'a aucun effet si l'utilisateur est éditeur et non lecteur. Cette méthode n'empêche pas non plus les utilisateurs d'accéder à Document s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général, par exemple, si Document est partagé avec l'ensemble du domaine de l'utilisateur ou si Document se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, l'utilisateur est également retiré de la liste des éditeurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Aller-retour

Document : cet élément (Document) pour le chaînage.

Autorisation

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

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

saveAndClose()

Enregistre le Document actuel. Élimine et applique les mises à jour en attente.

La méthode saveAndClose() est automatiquement appelée à la fin de l'exécution du script pour chaque Document modifiable ouvert.

Un Document fermé ne peut pas être modifié. Utilisez DocumentApp.openById() pour rouvrir un document donné en vue de le modifier.

Autorisation

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

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

setCursor(position)

Définit le curseur de l'utilisateur dans le document actif, en fonction d'un Position. Un script ne peut accéder qu'au curseur de l'utilisateur qui l'exécute et uniquement s'il est lié au document.

// Append a paragraph, then place the user's cursor after the first word of the new paragraph.
var doc = DocumentApp.getActiveDocument();
var paragraph = doc.getBody().appendParagraph('My new paragraph.');
var position = doc.newPosition(paragraph.getChild(0), 2);
doc.setCursor(position);

Paramètres

NomTypeDescription
positionPositionla nouvelle position du curseur

Aller-retour

Document : cet élément (Document) pour le chaînage

Autorisation

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

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

setLanguage(languageCode)

Définit le code de langue du document. Il s'agit de la langue affichée dans Fichier > Langue de l'éditeur de documents, qui peut ne pas correspondre à la langue réelle du document. Utilisez getSupportedLanguageCodes() pour obtenir tous les codes de langue valides.

Paramètres

NomTypeDescription
languageCodeStringCode de langue.

Aller-retour

Document : cet élément Document, pour le chaînage.

Autorisation

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

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

setName(name)

Définit le titre du document.

Paramètres

NomTypeDescription
nameStringtitre du nouveau document

Aller-retour

Document : document actuel

Autorisation

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

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

setSelection(range)

Définit la sélection de l'utilisateur dans le document actif, en fonction d'une Range. Un script ne peut accéder qu'à la sélection de l'utilisateur qui l'exécute et uniquement s'il est lié au document.

// Change the user's selection to a range that includes every table in the document.
var doc = DocumentApp.getActiveDocument();
var rangeBuilder = doc.newRange();
var tables = doc.getBody().getTables();
for (var i = 0; i < tables.length; i++) {
  rangeBuilder.addElement(tables[i]);
}
doc.setSelection(rangeBuilder.build());

Paramètres

NomTypeDescription
rangeRangela nouvelle plage d'éléments à sélectionner

Aller-retour

Document : cet élément (Document) pour le chaînage

Autorisation

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

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