Class TextBoxField

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

Inheritance
System.Object
FormField
FormField<VariableContentWidget>
TextField
TextBoxField
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.Windows.Documents.Fixed.Model.InteractiveForms
Assembly: Telerik.Windows.Documents.Fixed.dll

Syntax

public sealed class TextBoxField : TextField, IInstanceIdOwner, IStructuralElement, IWidgetCreator<VariableContentWidget>

Constructors

TextBoxField(String)

Create a text box field with the specified fieldName.

Declaration
public TextBoxField(string fieldName)
Parameters
System.String fieldName

The field name.

Properties

AllowScroll

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

Declaration
public bool AllowScroll { get; set; }
Property Value
System.Boolean

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
public override FormFieldType FieldType { get; }
Property Value
FormFieldType

Overrides

IsFileSelect

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

Declaration
public bool IsFileSelect { get; set; }
Property Value
System.Boolean

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

IsMultiline

Whether multiple lines (with line breaks) are accepted.

Declaration
public bool IsMultiline { get; set; }
Property Value
System.Boolean

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

IsPassword

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

Declaration
public bool IsPassword { get; set; }
Property Value
System.Boolean

true if it is a password; otherwise false.

MaxLengthOfInputCharacters

Maximum allowed character count; null removes the limit.

Declaration
public int? MaxLengthOfInputCharacters { get; set; }
Property Value
System.Nullable<System.Int32>

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

ShouldSpellCheck

Whether spell checking is enabled by supporting viewers.

Declaration
public bool ShouldSpellCheck { get; set; }
Property Value
System.Boolean

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