Class Bookmark

Adicionar aos favoritos

Um objeto que representa um favorito.

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étodos

MétodoTipo de retornoBreve descrição
getId()StringRecebe o ID do Bookmark.
getPosition()PositionRecebe o Position do Bookmark dentro do DocumentTab.
remove()voidExclui o Bookmark.

Documentação detalhada

getId()

Recebe o ID do Bookmark. O ID é exclusivo no DocumentTab.

Retornar

String: o ID da Bookmark, que é exclusivo no DocumentTab.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

getPosition()

Recebe o Position do Bookmark dentro do DocumentTab. O Position continua preciso desde que o Bookmark não seja excluído, mesmo que o script altera a estrutura do documento.

Retornar

Position: a posição do Bookmark.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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

remove()

Exclui o Bookmark. Chamar esse método em um Bookmark que já foi excluído não tem efeito.

Autorização

Os scripts que usam esse método precisam de autorização com um ou mais dos seguintes escopos:

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