SetName

Changes the bookmark name.

Syntax

expression.SetName(sNewName);

expression - A variable that represents a ApiBookmark class.

Parameters

Name	Required/Optional	Data type	Default	Description
sNewName	Required	string		A new bookmark name.

Returns

boolean

Example

This example shows how to set bookmark name.

• Code
• Result

// How to rename a bookmark.

// Get a bookmark from the document by its name then set a new name to it.

let doc = Api.GetDocument();
let paragraph = doc.GetElement(0);
paragraph.AddText("ONLYOFFICE Document Builder");
let range1 = doc.GetRange(0, 11);
range1.AddBookmark("Bookmark_A");
let bookmark = doc.GetBookmark("Bookmark_A");
let oldName = bookmark.GetName();
bookmark.SetName("Bookmark_B");
paragraph.AddLineBreak();
paragraph.AddText("Bookmark name changed from: '" + oldName + "' to: '" + bookmark.GetName() + "'");