AddBookmarkCrossRef

function AddBookmarkCrossRef(
  sRefTo: bookmarkRefTo = null,
  sBookmarkName: string = null,
  bLink: boolean = true,
  bAboveBelow: boolean = false,
  sSepWith: string = "",
): boolean

Description

Adds a bookmark cross-reference to the current paragraph. Please note that this paragraph must be in the document.

Parameters

sRefTobookmarkRefTodefault: null

The text or numeric value of a bookmark reference you want to insert.

sBookmarkNamestringdefault: null

The name of the bookmark to be referred to (must be in the document).

bLinkbooleandefault: true

Specifies if the reference will be inserted as a hyperlink.

bAboveBelowbooleandefault: false

Specifies if the above/below words indicating the position of the reference should be included (don't used with the "text" and "aboveBelow" sRefType).

sSepWithstringdefault: ""

A number separator (used only with the "fullCtxParaNum" sRefType).

Returns

boolean

Try It

var oDocument = Api.GetDocument(); 
var oParagraph = oDocument.GetElement(0); 
oParagraph.AddText("ONLYOFFICE Document Builder"); 
var oRange = oDocument.GetRange(0, 9); 
oRange.AddBookmark("Bookmark");
var aBookmarks = oDocument.GetAllBookmarksNames();
oParagraph = Api.CreateParagraph();
oParagraph.AddText("A bookmark was added ");
oDocument.Push(oParagraph);
oParagraph.AddBookmarkCrossRef("aboveBelow", aBookmarks[0]);

Get Help

  • If you have any questions about ONLYOFFICE Docs, try the FAQ section first.
  • You can request a feature or report a bug by posting an issue on GitHub.
  • You can also ask our developers on ONLYOFFICE forum (registration required).