Class Bookmark

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()StringObtient l'ID du Bookmark.
getPosition()PositionObtient le Position du Bookmark dans le DocumentTab.
remove()voidSupprime le Bookmark.

Documentation détaillée

getId()

Obtient l'ID du Bookmark. L'ID est unique dans le DocumentTab.

Renvois

String : ID du Bookmark, qui est unique dans le 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()

Obtient la Position du Bookmark dans le DocumentTab. La Position reste précise tant que le Bookmark n'est pas supprimé, même si le script modifie la structure du document.

Renvois

Position : position du 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 le Bookmark. L'appel de 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