Class Bookmark

Ajouter aux favoris

Objet représentant un favori.

const doc = DocumentApp.getActiveDocument();
const documentTab = doc.getActiveTab().asDocumentTab();

// Insert a bookmark at the cursor position (in the active tab) and log its ID.
const cursor = doc.getCursor();
const bookmark = documentTab.addBookmark(cursor);
Logger.log(bookmark.getId());

Méthodes

MéthodeType renvoyéBrève description
getId()StringRécupère l'ID du Bookmark.
getPosition()PositionRécupère le Position de l'Bookmark dans le DocumentTab.
remove()voidSupprime la Bookmark.

Documentation détaillée

getId()

Récupère l'ID du Bookmark. L'ID est unique dans la DocumentTab.

Renvois

String : ID de Bookmark, qui est unique dans DocumentTab.

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

getPosition()

Récupère le Position de l'Bookmark dans le DocumentTab. Le Position reste précis tant que le Bookmark n'est pas supprimé, même si le script modifie la structure du document.

Renvois

Position : position de l'Bookmark.

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

remove()

Supprime la Bookmark. Appeler cette méthode sur un Bookmark déjà supprimé n'a aucun effet.

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