Class TextBoxField

Represents a text box form field that allows users to enter single-line or multi-line text input with optional password masking and character 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)

Initializes a new instance of TextBoxField class.

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

The field name.

Properties

AllowScroll

Gets or sets boolean value indicating whether to allow scrolling for bigger text content. If the scrolling is not allowed then the maximum text input is restricted to the Widget annotation 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

Gets the field type.

Declaration
public override FormFieldType FieldType { get; }
Property Value
FormFieldType

Overrides

IsFileSelect

Gets or sets boolean value indicating whether the field represents pathname of a file whose contents are to be submitted as the value of the field.

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

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

IsMultiline

Gets or sets a value indicating whether the text box allows multiple lines of text input with line breaks.

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

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

IsPassword

Gets or sets a value indicating whether the text input is a password field.

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

true if it is a password; otherwise false.

MaxLengthOfInputCharacters

Gets or sets the max length of the input characters. If null then the text input is not restricted from these value.

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

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

ShouldSpellCheck

Gets or sets boolean value indicating whether the inputted text should be spell checked.

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

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