TX Text Control .NET for Windows Forms

FormField Class

Class|Introduced in 28.0
Namespace
TXTextControl
Package
TXTextControl.TextControl.WinForms.SDK from the private NuGet feed or Text Control Offline Packages
Assembly
TXTextControl.dll
Install
dotnet add package TXTextControl.TextControl.WinForms.SDK .NET 8 and later. For .NET Framework, reference TXTextControl.dll from the setup.
Inherits
  1. TextField
  2. FormField
Derived
CheckFormField, DateFormField, SelectionFormField, TextFormField

Description

The FormField class is the base class of all form fields.

Syntax

public class FormField : TextField

Examples

The following example retrieves the form field at the current input position and inspects it.

CheckFormField field = new(false) { Name = "AcceptTerms" };
textControl.FormFields.Add(field);
FormField formField = textControl.FormFields.GetItem();

Members

Constructors

ConstructorDescription
TextFieldCreates a new instance of the TextField class. (Inherited from TextField.)

Properties

PropertyDescription
BoundsGets the bounding rectangle of a text field. The bounding rectangle is the smallest rectangle which contains all characters of the field's text. The rectangle is given in twips with an origin at the upper left corner of the document. (Inherited from TextField.)
ContainsInputPositionReturns true, if the Textfield contains the current text input position. (Inherited from TextField.)
DeleteableSpecifies whether a text field can be deleted by the end-user while a TX Text Control document is being edited. The default setting of this property is true. (Inherited from TextField.)
DescriptiveTextGets or sets a descriptive text for a form field. An empty string indicates that the form field has no such text. An empty string can also be used to delete a previously set text.
DoubleClickEventSpecifies whether a TextControl.TextFieldDoubleClicked event is raised, if the end-user doubleclicks the text field. If an event is raised, the normal double-click processing, which selects a single word in the text is suppressed. The default setting of this property is true. (Inherited from TextField.)
DoubledInputPositionSpecifies whether a text field has a doubled input position in front of its first character and behind its last character. This enables an end-user to decide whether inserted text at these positions will belong to the text field or not. The default setting of this property is false. For all form fields to work properly this property is set to true and cannot be changed to false. (Inherited from TextField.)
EditableSpecifies whether the text of a text field can be changed by the end-user while a TX Text Control document is being edited. The default setting of this property is true. (Inherited from TextField.)
EnabledGets or set a value indicating whether the form field is enabled. This property has only an effect, when the when the TextControl.EditMode is set to ReadAndSelect and the DocumentPermissions.AllowEditingFormFields property has been set to true. In this case a Formfield can only be edited, when its Enabled property is true. When a FormField is disabled, the TextFieldClicked and TextFieldDoubleClicked of the Formfield are suppressed. The default value of this property is true.
FormattingBoundsGets the formatting rectangle of a text field. The formatting rectangle is the largest rectangle to which the area covered by the field can grow. The rectangle is given in twips with an origin at the upper left corner of the document. (Inherited from TextField.)
HighlightColorGets or sets the highlight color for the text field. The color's alpha value must be less than 255 (opaque) so that the text field's text remains visible. The default value is black with an alpha value of 60 (light gray). (Inherited from TextField.)
HighlightModeGets or sets a value indicating when the text field is highlighted. (Inherited from TextField.)
IDGets or sets an identifier for a text field. This identifier can be used to uniquely identify a text field. (Inherited from TextField.)
IsSpellCheckingEnabledSpecifies whether a text field's text is checked on misspelled words. The default setting of this property is true. (Inherited from TextField.)
LengthGets the number of characters in a text field. (Inherited from TextField.)
NameRelates a user-defined name to a text field. This can be any kind of text. This name can be used to uniquely identify a text field. (Inherited from TextField.)
ShowActivatedObsolete. Specifies whether a text field toggles its background to gray, if the current input position is in the field. The default setting of this property is false. This property is obsolete and has been superseded by the HighlightColor and HighlightMode properties. (Inherited from TextField.)
StartGets the first character position (one-based) of a text field. (Inherited from TextField.)
TextReturns or sets the text which is contained within a text field. This property is not supported for the DocumentTarget class. (Inherited from TextField.)

Methods

MethodDescription
FormFieldDialogOpens a dialog box to alter the formatting attributes of the form field.
ScrollToSets the current input position to the beginning of a text field and scrolls it into the visible part of the document. (Inherited from TextField.)

Further Reading