Bookmark Class
A bookmark in the document.
Declaration
export class Bookmark
Inheritance
Bookmark
Properties
index Property
Gets the bookmark’s index in a bookmark collection.
Declaration
readonly index: number
Property Value
Type | Description |
---|---|
number | A zero-based index. |
interval Property
Gets the text buffer interval that contains the bookmark.
Declaration
readonly interval: Interval
Property Value
Type | Description |
---|---|
Interval | The text buffer interval. |
Remarks
// Returns a text of the specified bookmark
richEdit.document.getText(richEdit.document.bookmarks.getByIndex(1).interval);
name Property
Returns a name of the bookmark.
Declaration
readonly name: string
Property Value
Type | Description |
---|---|
string | The bookmark name. |
Remarks
A bookmark name should start with a letter and must be unique in the collection of bookmarks in the current document.
subDocument Property
Gets a sub-document where the bookmark is placed.
Declaration
readonly subDocument: SubDocument
Property Value
Type | Description |
---|---|
SubDocument | The sub-document that contains the bookmark. |
Methods
delete Method
Deletes the bookmark.
Declaration
delete(): void