SetHighlight

function SetHighlight(sColor: highlightColor = null): ApiTextPr

Description

Specifies a highlighting color which is applied as a background to the contents of the current run.

Parameters

sColorhighlightColordefault: null

Available highlight color.

Returns

ApiTextPr

Overloads

SetHighlight(sColor)

Specifies a highlighting color which is added to the text properties and applied as a background to the contents of the current run/range/paragraph.

Try It

var oDocument = Api.GetDocument();
var oParagraph = oDocument.GetElement(0);
var oRun = Api.CreateRun();
oRun.AddText("This is just a sample text. ");
oParagraph.AddElement(oRun);
oRun = Api.CreateRun();
oRun.SetHighlight("lightGray");
oRun.AddText("This is a text run with the text highlighted with light gray color.");
oParagraph.AddElement(oRun);

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).