Skip to main content

GetAllBookmarksNames

Returns an array with names of all bookmarks in the current document.

Syntax​

expression.GetAllBookmarksNames();

expression - A variable that represents a ApiDocument class.

Parameters​

This method doesn't have any parameters.

Returns​

string[]

Example​

This example shows how to get an array with names of all bookmarks in the document.

// Get the list with all bookmark names and print them in the document.

// Add bookmarks to the ranges and display their names.

let doc = Api.GetDocument(); 
let paragraph = doc.GetElement(0); 
paragraph.AddText("ONLYOFFICE Document Builder"); 
let range1 = doc.GetRange(0, 9); 
range1.AddBookmark("Bookmark 1");
let range2 = doc.GetRange(11, 18); 
range2.AddBookmark("Bookmark 2");
let bookmarks = doc.GetAllBookmarksNames();
paragraph.AddLineBreak();
paragraph.AddText("Bookmark names: ");
for (let i = 0; i < 2; i++ ){
	paragraph.AddText(bookmarks[i] + "," + " ");
}