Class Document

Document

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

Vous pouvez ouvrir ou créer des documents 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 indiqué à la liste des éditeurs pour Document.
addFooter()FooterSectionAjoute une section de pied de page du document, le cas échéant.
addHeader()HeaderSectionAjoute une section d'en-tête de document, le cas échéant.
addNamedRange(name, range)NamedRangeAjout d'un NamedRange, qui est un Range avec un nom et un ID à utiliser pour une récupération ultérieure.
addViewer(emailAddress)DocumentAjoute l'utilisateur donné à la liste des lecteurs pour Document.
addViewer(user)DocumentAjoute l'utilisateur donné à la liste des lecteurs pour 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 l'objet 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 ce Document.
getFooter()FooterSectionRécupère la section de pied de page du document, le cas échéant.
getFootnotes()Footnote[]Récupère tous les éléments Footnote dans le 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 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 ce Document.
newPosition(element, offset)PositionCrée un Position, qui est une référence à un emplacement du 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 indiqué de la liste des éditeurs pour Document.
removeEditor(user)DocumentSupprime l'utilisateur indiqué de la liste des éditeurs pour Document.
removeViewer(emailAddress)DocumentSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de Document.
removeViewer(user)DocumentSupprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de 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'un Range.

Documentation détaillée

addBookmark(position)

Ajoute un Bookmark au Position donné.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body and adds a paragraph.
const paragraph = doc.getBody().appendParagraph('My new paragraph.');

// Creates a position at the first character of the paragraph text.
const position = doc.newPosition(paragraph.getChild(0), 0);

// Adds a bookmark at the first character of the paragraph text.
const bookmark = doc.addBookmark(position);

// Logs the bookmark ID to the console.
console.log(bookmark.getId());

}

Paramètres

NomTypeDescription
positionPositionPosition du nouveau favori.

Renvois

Bookmark : nouveau favori.

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

addEditor(emailAddress)

Ajoute l'utilisateur donné à la liste des éditeurs pour Document. Si l'utilisateur figurait déjà dans la liste des visiteurs, cette méthode l'exclut de la liste.

Paramètres

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

Renvois

Document : Document, pour le chaînage.

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

addEditor(user)

Ajoute l'utilisateur donné à la liste des éditeurs pour Document. Si l'utilisateur figurait déjà dans la liste des visiteurs, cette méthode l'exclut de la liste.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Renvois

Document : Document, pour le chaînage.

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

addEditors(emailAddresses)

Ajoute le tableau d'utilisateurs indiqué à la liste des éditeurs pour Document. Si l'un des utilisateurs figurait déjà dans la liste des lecteurs, cette méthode l'exclut de la liste.

Paramètres

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

Renvois

Document : Document, pour le chaînage.

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

addFooter()

Ajoute une section de pied de page du document, le cas échéant.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Adds a footer to the document.
const footer = doc.addFooter();

// Sets the footer text to 'This is a footer.'
footer.setText('This is a footer');

Renvois

FooterSection : pied de page du 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

addHeader()

Ajoute une section d'en-tête de document, le cas échéant.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Adds a header to the document.
const header = doc.addHeader();

// Sets the header text to 'This is a header.'
header.setText('This is a header');

Renvois

HeaderSection : en-tête du 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

addNamedRange(name, range)

Ajout d'un NamedRange, qui est un Range avec un nom et un ID à utiliser pour une récupération ultérieure. Les noms ne sont pas nécessairement uniques. Plusieurs plages d'un même document peuvent partager le même nom, comme une classe en HTML. En revanche, les identifiants sont uniques au sein d'un document, comme un identifiant en HTML. Une fois que vous avez ajouté un NamedRange à un document, vous ne pouvez plus le modifier. Vous pouvez uniquement le supprimer.

Tout script qui accède au document peut accéder à un NamedRange. Pour éviter les conflits involontaires entre les scripts, envisagez de préfixer les noms de plage avec 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 ne doit pas nécessairement être unique. Les noms de plage doivent comprendre entre 1 et 256 caractères.
rangeRangePlage d'éléments à associer au nom. La plage peut être la sélection active, un résultat de recherche ou construite manuellement avec newRange().

Renvois

NamedRange : NamedRange.

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

addViewer(emailAddress)

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

Paramètres

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

Renvois

Document : Document, pour le chaînage.

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

addViewer(user)

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

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à ajouter.

Renvois

Document : Document, pour le chaînage.

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

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 sur lui.

Paramètres

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

Renvois

Document : Document, pour le chaînage.

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

getAs(contentType)

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document as a PDF.
const pdf = doc.getAs('application/pdf');

// Logs the name of the PDF to the console.
console.log(pdf.getName());

Paramètres

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

Renvois

Blob : document actuel en tant qu'objet blob.


getBlob()

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Retrieves the current document's contents as a blob and logs it to the console.
console.log(doc.getBlob().getContentType());

Renvois

Blob : document actuel en tant qu'objet blob.


getBody()

Récupère l'objet Body du document actif.

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

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the document body.
const body = doc.getBody();

// Gets the body text and logs it to the console.
console.log(body.getText());

Renvois

Body : section du corps du document actif.

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

getBookmark(id)

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the bookmark by its ID.
const bookmark = doc.getBookmark('id.xyz654321');

// If the bookmark exists, logs the character offset of its position to the console.
// otherwise, logs 'No bookmark exists with the given ID.' to the console.
if (bookmark) {
  console.log(bookmark.getPosition().getOffset());
} else {
  console.log('No bookmark exists with the given ID.');
}

Paramètres

NomTypeDescription
idStringID de Bookmark.

Renvois

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 associée à 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.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
const doc = DocumentApp.openById('abc123456');

// Gets all of the bookmarks in the document.
const bookmarks = doc.getBookmarks();

// Logs the number of bookmarks in the document to the console.
console.log(bookmarks.length);

Renvois

Bookmark[] : tableau des objets Bookmark dans le 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

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 exécute le script, 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.');
}

Renvois

Position : représentation du curseur de l'utilisateur, ou null si l'utilisateur n'a pas de curseur placé 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 associée à 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 ce Document.

Renvois

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

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

getFooter()

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the text of the document's footer and logs it to the console.
console.log(doc.getFooter().getText());

Renvois

FooterSection : pied de page du 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

getFootnotes()

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

Les appels à getFootnotes entraînent une itération des éléments du document. Pour les documents volumineux, évitez les appels inutiles à cette méthode.

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the first footnote.
const footnote = doc.getFootnotes()[0];

// Logs footnote contents to the console.
console.log(footnote.getFootnoteContents().getText());

Renvois

Footnote[] : notes de bas de page du 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

getHeader()

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

// Opens the Docs file by its ID. If you created your script from within
// a Google Docs file, you can use DocumentApp.getActiveDocument() instead.
// TODO(developer): Replace the ID with your own.
const doc = DocumentApp.openById('abc123456');

// Gets the text of the document's header and logs it to the console.
console.log(doc.getHeader().getText());

Renvois

HeaderSection : en-tête du 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

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.

Renvois

String : ID du 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

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.

Renvois

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 associée à 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.

Renvois

String : titre du 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

getNamedRangeById(id)

Récupère les NamedRange avec l'ID donné. Cette méthode renvoie null si aucun NamedRange n'existe. Les noms ne sont pas nécessairement uniques. Plusieurs plages d'un même document peuvent partager le même nom, comme une classe en HTML. En revanche, les identifiants sont uniques au sein du document, comme un identifiant en HTML.

Paramètres

NomTypeDescription
idStringl'ID de plage, qui est unique dans le document

Renvois

NamedRange : NamedRange avec l'ID donné ou null si aucune plage n'existe.

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

getNamedRanges()

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

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

Renvois

NamedRange[] : tableau des objets NamedRange dans le document, pouvant inclure plusieurs plages portant le même nom.

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

getNamedRanges(name)

Récupère tous les objets NamedRange portant le nom donné. Les noms ne sont pas nécessairement uniques. Plusieurs plages d'un même document peuvent partager le même nom, à l'instar d'une classe en HTML. En revanche, les identifiants sont uniques au sein d'un document, tout comme les identifiants en HTML.

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

Paramètres

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

Renvois

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

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

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.');
}

Renvois

Range : représentation de la sélection de l'utilisateur, ou null si l'utilisateur n'a rien sélectionné dans le document, si seule 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 associée à 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.

Renvois

String[] : tableau de codes de langue.

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

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

Renvois

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

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

getViewers()

Récupère la liste des lecteurs et des commentateurs de ce Document.

Renvois

User[] : tableau des utilisateurs disposant d'une autorisation d'affichage ou de commentaire.

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

newPosition(element, offset)

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

// 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 tel que 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

Renvois

Position : le nouveau Position

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

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

Renvois

RangeBuilder : le nouveau compilateur

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

removeEditor(emailAddress)

Supprime l'utilisateur indiqué de la liste des éditeurs pour Document. Cette méthode n'empêche pas les utilisateurs d'accéder au 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, cela supprime également l'utilisateur de la liste des lecteurs.

Paramètres

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

Renvois

Document : Document, pour le chaînage.

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

removeEditor(user)

Supprime l'utilisateur indiqué de la liste des éditeurs pour Document. Cette méthode n'empêche pas les utilisateurs d'accéder au 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, cela supprime également l'utilisateur de la liste des lecteurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Renvois

Document : Document, pour le chaînage.

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

removeViewer(emailAddress)

Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de 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 au 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, cela supprime également l'utilisateur de la liste des éditeurs.

Paramètres

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

Renvois

Document : Document pour le chaînage.

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

removeViewer(user)

Supprime l'utilisateur indiqué de la liste des lecteurs et des commentateurs de Document. Cette méthode n'a aucun effet si l'utilisateur est un éditeur, et non un lecteur. Cette méthode n'empêche pas non plus les utilisateurs d'accéder au 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, cela supprime également l'utilisateur de la liste des éditeurs.

Paramètres

NomTypeDescription
userUserReprésentation de l'utilisateur à supprimer.

Renvois

Document : Document pour le chaînage.

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

saveAndClose()

Enregistre le Document actuel. Entraîne le vidage et l'application des 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é pour le modifier.

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

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
positionPositionle nouvel emplacement du curseur

Renvois

Document : cette Document, pour le chaînage

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

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.

Renvois

Document : Document, pour le chaînage.

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

setName(name)

Définit le titre du document.

Paramètres

NomTypeDescription
nameStringTitre du nouveau document

Renvois

Document : document actuel

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

setSelection(range)

Définit la sélection de l'utilisateur dans le document actif, en fonction d'un 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

Renvois

Document : cette Document, pour le chaînage

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