SetBackgroundColor
Sets the background color to the current form.
Syntax
expression.SetBackgroundColor(color);
expression - A variable that represents a ApiTextForm class.
Parameters
| Name | Required/Optional | Data type | Default | Description |
|---|---|---|---|---|
| color | Optional | ApiColor | No description provided. |
Returns
boolean
Example
This example sets the background color to the form.
- Code
- Result
// Applies an RGB background color to the text form element.
// How to change background color of the text form.
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);
textForm.SetBackgroundColor(Api.HexColor('#FF6F3D'));