GenericFormField Class |
While most implementations of BaseFormField imply that their child fields are a particular type,
PDF allows for form fields that have no type associated with them. GenericFormField represents
a parent field that may have child fields of any type.
Inheritance HierarchySystemObject
Atalasoft.PdfDoc.Generating.FormsBaseFormField
Atalasoft.PdfDoc.Generating.FormsGenericFormField
Atalasoft.PdfDoc.Generating.FormsBaseFormField
Atalasoft.PdfDoc.Generating.FormsGenericFormField
Namespace: Atalasoft.PdfDoc.Generating.Forms
Assembly: Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.4.0.9.0.377 (.NET 4.5.2, x86)
SyntaxThe GenericFormField type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | GenericFormField | Initializes a new instance of the GenericFormField class |
Properties| Name | Description | |
|---|---|---|
 | AdditionalActions |
Gets the additional actions that may be used by annotations that are children of this field.
(Inherited from BaseFormField.) |
| ChildFields |
Gets the child fields for this field.
(Inherited from BaseFormField.) |
| DefaultTextAppearance |
Gets or sets the default text appearance that is shared by children of this field.
(Inherited from BaseFormField.) |
| EnforceReadyOnlyWithException |
Gets or sets a value indicating whether to enforce ready only with the IsFieldReadOnly propery with an exception.
(Inherited from BaseFormField.) |
| FieldAlternateDescription |
Gets or sets the field alternate description for display in the user interface.
(Inherited from BaseFormField.) |
| FieldFullName |
Gets the fully qualified name of the field. This value is only correct if
ParentField has been set. When the parent chain is properly
set up, this will return ParentField.FieldFullName + '.' + FieldName
(Inherited from BaseFormField.) |
| FieldName |
Gets or sets the name of the field.
(Inherited from BaseFormField.) |
| FieldNameForExport |
Gets or sets the field name for export.
(Inherited from BaseFormField.) |
| IsFieldNoExport |
Gets or sets a value indicating whether this field should not be export.
(Inherited from BaseFormField.) |
| IsFieldReadOnly |
Gets or sets a value indicating whether this field is read only.
(Inherited from BaseFormField.) |
| IsFieldRequired |
Gets or sets a value indicating whether this field is required.
(Inherited from BaseFormField.) |
| ParentField |
Gets or sets the parent field.
(Inherited from BaseFormField.) |
Methods| Name | Description | |
|---|---|---|
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
 | Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as the default hash function. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| ThrowIfReadOnlyT |
If EnforceReadyOnlyWithException is true and IsFieldReadOnly is true,
throw an InvalidOperationException, otherwise return value.
(Inherited from BaseFormField.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Remarks
While it is possible to put non-matching child fields as the children of any field, this is not considered
good practice.
See Also