Skip to main content

SetFormsHighlight

Sets the highlight to the forms in the document.

Syntax

expression.SetFormsHighlight(r, g, b, bNone);

expression - A variable that represents a ApiDocument class.

Parameters

NameRequired/OptionalData typeDefaultDescription
rRequiredbyteRed color component value.
gRequiredbyteGreen color component value.
bRequiredbyteBlue color component value.
bNoneOptionalbooleanfalseDefines that highlight will not be set.

Returns

This method doesn't return any data.

Example

This example sets the highlight to the forms in the document.

let doc = Api.GetDocument();
let textForm = Api.CreateTextForm({"key": "Personal information", "tip": "Enter your first name", "required": true, "placeholder": "First name", "comb": true, "maxCharacters": 10, "cellWidth": 3, "multiLine": false, "autoFit": false});
let paragraph = doc.GetElement(0);
paragraph.AddElement(textForm);
doc.SetFormsHighlight(255, 111, 61);