Class
TextBoxField

Text input field supporting single or multiline entry, optional password masking, file path selection, scrolling, and length limits.

Definition

Constructors

TextBoxField(string)

Create a text box field with the specified fieldName.

Declaration

cs-api-definition
public TextBoxField(string fieldName)

Parameters

fieldName

string

The field name.

Properties

AllowScroll

Whether overflowing content may scroll; when false input is clipped to the widget rectangle.

Declaration

cs-api-definition
public bool AllowScroll { get; set; }

Property Value

bool

true to allow scrolling for content overflow; false to restrict text input to the visible widget rectangle.

FieldType

Form field type identifier (TextBox) used during export and processing.

Declaration

cs-api-definition
public override FormFieldType FieldType { get; }

Property Value

FormFieldType

Overrides FormField.FieldType

IsFileSelect

Whether the field captures a file system path whose contents are submitted.

Declaration

cs-api-definition
public bool IsFileSelect { get; set; }

Property Value

bool

true if the field should allow file selection; false for regular text input.

IsMultiline

Whether multiple lines (with line breaks) are accepted.

Declaration

cs-api-definition
public bool IsMultiline { get; set; }

Property Value

bool

true to allow multiline text entry; false for single-line text input only.

IsPassword

Whether input is obscured (password mode) in the viewer.

Declaration

cs-api-definition
public bool IsPassword { get; set; }

Property Value

bool

true if it is a password; otherwise false.

MaxLengthOfInputCharacters

Maximum allowed character count; null removes the limit.

Declaration

cs-api-definition
public int? MaxLengthOfInputCharacters { get; set; }

Property Value

int?

The maximum character limit, or null to allow unlimited text input.

ShouldSpellCheck

Whether spell checking is enabled by supporting viewers.

Declaration

cs-api-definition
public bool ShouldSpellCheck { get; set; }

Property Value

bool

true to enable spell checking; false to disable spell checking for this field.