Class Bookmark

Signet

Objet représentant un favori.

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

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

Méthodes

MéthodeType renvoyéBrève description
getId()StringRécupère l'ID de Bookmark.
getPosition()PositionRécupère les Position de Bookmark au sein de DocumentTab.
remove()voidSupprime Bookmark.

Documentation détaillée

getId()

Récupère l'ID de Bookmark. Cet identifiant est unique dans DocumentTab.

Renvois

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

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

getPosition()

Récupère les Position de Bookmark au sein de DocumentTab. Le Position reste précis tant que 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 correspondant à un ou plusieurs des champs d'application suivants:

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

remove()

Supprime Bookmark. L'appel de cette méthode sur un Bookmark qui a déjà été supprimée n'a aucun effet.

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