Skip to main content

IsComb

Checks if the text field is a comb of characters with the same cell width.

Syntax

expression.IsComb();

expression - A variable that represents a ApiTextForm class.

Parameters

This method doesn't have any parameters.

Returns

boolean

Example

This example checks if the text field is a comb of characters with the same cell width.

let doc = Api.GetDocument();
let textForm = Api.CreateTextForm({"key": "Personal information", "tip": "Enter your first name", "required": true, "placeholder": "First name", "maxCharacters": 10, "multiLine": false, "autoFit": false});
let paragraph = doc.GetElement(0);
paragraph.AddElement(textForm);
textForm.SetComb(true);
let comb = textForm.IsComb();
paragraph = Api.CreateParagraph();
paragraph.AddText("The first text form from this document is comb: " + comb);
doc.Push(paragraph);