bookmark

A bookmark.

bookmark elements

Name Refer to By
bookmarks by numeric index, by name, as a range of elements, before/after another element,
satisfying a test, by ID

bookmark properties

Property Type Access Description
class integer read The class descriptor type.
destination hyperlink text destination, hyperlink page destination, hyperlink external page
destination, page
read The destination this hyperlink points to.
id integer read A unique number identifying the object.
indent integer read The indent level of this bookmark.
index integer read Index of the object within its parent object.
label string r/w A label that can be set to any string.
name string r/w The name of the object.
object reference object read An object reference for this object.
parent object read The parent of the object.
properties record r/w Property that allows setting of several properties at the same time.

bookmark methods

Method Returns Description
delete Nothing Delete the object.
extract label string Gets the content of the label associated with the specified key (name).
insert label Nothing Sets the content of the label associated with the specified key (name), creating the
label if it does not already exist.
move bookmark Moves the bookmark.
show bookmark Nothing Go to the bookmark.

Leave a Comment

Previous post:

Next post: