DescTools (version 0.99.30)

WrdBookmark: 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

See Also

WrdInsertBookmark

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()
# }