Class Bookmark

Marcar como favorito

Um objeto que representa um marcador. 

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

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

Documentação detalhada

getId()

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

Retornar

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

Autorização

Os scripts que usam esse método exigem 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 da Bookmark dentro da DocumentTab. O Position permanece preciso enquanto o Bookmark não for excluído, mesmo que o script mude a estrutura do documento.

Retornar

Position: a posição do Bookmark.

Autorização

Os scripts que usam esse método exigem 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 exigem autorização com um ou mais dos seguintes escopos:

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