FormFieldAdapter Class
- Namespace
TXTextControl.DocumentServer. Fields
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WPF. SDK
- Assembly
TXDocumentServer.dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WPF. SDK TXDocumentServer.from the setup.dll
- Inherits
- Field
Adapter - Form
Field Adapter
- Field
- Derived
- Form
Check , FormBox Drop , FormDown Text
Description
The abstract FormFieldAdapter class is the base class of all special DocumentServer form field adapters. It implements the necessary means to access field properties such as the name or the text of a field.
Syntax
public abstract class FormFieldAdapter : FieldAdapterPublic MustInherit Class FormFieldAdapter
Inherits FieldAdapterExamples
The following example includes the name value from a Form Field Adapter object in application diagnostics. The created object is then available to the surrounding document workflow.
Console.WriteLine($"Name: {formFieldAdapter.Name}");
Console.WriteLine("Form Field Adapter is ready for use.");Console.WriteLine($"Name: {formFieldAdapter.Name}")
Console.WriteLine("Form Field Adapter is ready for use.")Members
Constructors
| Constructor | Description |
|---|---|
| FieldAdapter | Initializes a new instance of the FieldAdapter class. (Inherited from FieldAdapter.) |
| FormFieldAdapter | Initializes a new instance of the FormFieldAdapter class. |
Properties
| Property | Description |
|---|---|
| ApplicationField | Gets the adapted ApplicationField of the field. Each special field acts like an adapter for the specific ApplicationField. (Inherited from FieldAdapter.) |
| Bounds | Gets and sets the bounds of the form field. The rectangle's location and the size are specified in twips. |
| CalcOnExit | Gets or sets the CalcOnExit property of the field. |
| Enabled | Specifies whether the field is enabled or not. |
| Font | Gets and sets the font of the form field. |
| HelpText | Gets and sets the help text of the field. |
| ID | Gets the ID of the specific field through its adapter. (Inherited from FieldAdapter.) |
| Length | Gets the number of characters in a text field through its adapter. (Inherited from FieldAdapter.) |
| Name | Gets and sets the name of the form field. |
| Start | Gets the first character position (one-based) of the field through its adapter. (Inherited from FieldAdapter.) |
| StatusText | Gets and sets the status text of the field. |
| Text | Gets and sets the text of the form field. |
| TypeName | Gets the field's type name of the specific field through its adapter. For example for the type name of a Microsoft Word MergeField is MERGEFIELD. If the type name of the field is changed, its parameters must also be changed. (Inherited from FieldAdapter.) |
Methods
| Method | Description |
|---|---|
| ShowDialog | Opens the specific field options dialog box. (Inherited from FieldAdapter.) |
Fields
| Field | Description |
|---|---|
| TYPE_NAME | Represents the name of the respective field type. Every subclass of FieldAdapter overwrites this with its respective type name. (Inherited from FieldAdapter.) |