R: Return a Handle to a Word Bookmark Given as Name

WrdBookmark {DescTools}

R Documentation

Return a Handle to a Word Bookmark Given as Name

Description

Accessing bookmarks by name is only possible by browsing the bookmark names. This function returns a handle to a bookmark by name.

Usage

WrdBookmark(bookmark, wrd = DescToolsOptions("lastWord"))

Arguments

`bookmark`	character, the bookmark name
`wrd`	the pointer to a word instance, typically an existing one, created by `GetCurrWrd()`. Default is the last created pointer stored in `DescToolsOptions("lastWord")`.

Value

a handle to the bookmark

Author(s)

Andri Signorell <andri@signorell.net>

Examples

## Not run: 
# we can't get this through the CRAN test - run it with copy/paste to console

wrd <- GetNewWrd()
WrdInsertBookmark("mybookmark")
ToWrd("A longer text\n\n\n")

# Now returning the bookmark
bm <- WrdBookmark("mybookmark")

# get the automatically created name of the bookmark
bm$name()

## End(Not run)

[Package DescTools version 0.99.32 Index]