Esta página foi traduzida pela API Cloud Translation.

Class Bookmark

Um objeto que representa um favorito.

// Insert a bookmark at the cursor position and log its ID.
var doc = DocumentApp.getActiveDocument();
var cursor = doc.getCursor();
var bookmark = doc.addBookmark(cursor);
Logger.log(bookmark.getId());

Métodos

Método	Tipo de retorno	Breve descrição
`getId()`	`String`	Recebe o ID do `Bookmark`.
`getPosition()`	`Position`	Recebe o `Position` do `Bookmark` no `Document`.
`remove()`	`void`	Exclui o `Bookmark`.

Documentação detalhada

`getId()`

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

Retorno

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

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 do Bookmark no Document. O Position permanece preciso desde que o Bookmark não seja excluído, mesmo que o script mude a estrutura do documento.

Retorno

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