Type Alias: TextFieldBaseProperties

type TextFieldBaseProperties = FieldBaseProperties & object;

Defines common properties for TextField and CombTextField.

Type Declaration

defaultValue?

optional defaultValue?: string;

The default value of the field, applied when the field is reset.

maxLen?

optional maxLen?: number;

The maximum length of the field's text, in characters.

multiline?

optional multiline?: boolean;

Indicating whether the field can contain multiple lines of text.

password?

optional password?: boolean;

Indicating whether the field is intended for entering a secure password that should not be echoed visibly to the screen.

rect?

optional rect?: Rect;

Defines the position and dimensions of the field on the page using a bounding rectangle.

Note: If a widget is specified via the 'widget' property, its 'rect' value takes precedence and will override this rectangle definition.

richText?

optional richText?: boolean;

Indicating whether the value of this field should be represented as a rich text string.

scrollable?

optional scrollable?: boolean;

Indicating whether the field is scrollable to accommodate more text than fits within its annotation rectangle.

spellCheck?

optional spellCheck?: boolean;

Indicating whether the text entered in the field is spell-checked.

value?

optional value?: string;

The value of the field.

widget?

optional widget?: 
  | WidgetAnnotation
  | WidgetProperties;

The widget annotation defining view properties of the checkbox field.