CheckFormField Class
- Namespace
TXTextControl
- Package
TXTextControl.from the private NuGet feed or Text Control Offline PackagesTextControl. WinForms. SDK
- Assembly
TXTextControl.dll
- Install
dotnet add package TXTextControl..NET 8 and later. For .NET Framework, referenceTextControl. WinForms. SDK TXTextControl.from the setup.dll
Description
The CheckFormField class represents a checkbox in a document. The checkbox can be checked or unchecked through the end-user.
Syntax
public class CheckFormField : FormFieldPublic Class CheckFormField
Inherits FormFieldExamples
The following example adds a terms-and-conditions check box to a form.
CheckFormField checkFormField = new(false) { Name = "AcceptTerms" };
textControl.FormFields.Add(checkFormField);Dim checkFormField As New CheckFormField(False) With { .Name = "AcceptTerms" }
textControl.FormFields.Add(checkFormField)Members
Constructors
| Constructor | Description |
|---|---|
| CheckFormField | Initializes a new instance of the CheckFormField class. |
Properties
| Property | Description |
|---|---|
| Checked | Gets or set a value indicating whether the checkbox is in the checked state. |
| CheckedCharacter | Gets or sets the character which is used to display the checkbox in the checked state. |
| DescriptiveText | Gets 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. (Inherited from FormField.) |
| Enabled | Gets 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. (Inherited from FormField.) |
| SupportedCheckedCharacters | Gets possible characters which can be used to display the checkbox in the checked state. The characters depend on the font used to display the text field. |
| SupportedUncheckedCharacters | Gets possible characters which can be used to display the checkbox in the unchecked state. The characters depend on the font used to display the text field. |
| UncheckedCharacter | Gets or sets the character which is used to display the checkbox in the unchecked state. |
Methods
| Method | Description |
|---|---|
| FormFieldDialog | Opens a dialog box to alter the formatting attributes of the form field. (Inherited from FormField.) |
Fields
| Field | Description |
|---|---|
| DefaultCheckedCharacter | Represents the default character which is used to display the checkbox in the checked state. |
| DefaultUncheckedCharacter | Represents the default character which is used to display the checkbox in the unchecked state. |