SetHighlight

function SetHighlight(sColor: highlightColor = null): ApiTextPr

Description

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.

Parameters

sColorhighlightColordefault: null

Available highlight color.

Returns

ApiTextPr

Try It

var oPresentation = Api.GetPresentation();
var oSlide = oPresentation.GetSlideByIndex(0);
oSlide.RemoveAllObjects();
var oFill = Api.CreateSolidFill(Api.CreateRGBColor(255, 111, 61));
var oStroke = Api.CreateStroke(0, Api.CreateNoFill());
var oShape = Api.CreateShape("flowChartMagneticTape", 300 * 36000, 130 * 36000, oFill, oStroke);
oShape.SetPosition(608400, 1267200);
var oDocContent = oShape.GetDocContent();
var oParagraph = oDocContent.GetElement(0);
var oRun = Api.CreateRun();
var oTextPr = oRun.GetTextPr();
oTextPr.SetFontSize(50);
oTextPr.SetHighlight("lightGray");
oParagraph.SetJc("left");
oRun.AddText("This is a sample text inside the shape with the text highlighted with light gray color using the text properties.");
oParagraph.AddElement(oRun);
oSlide.AddObject(oShape);

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