Click or drag to resize

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 Hierarchy

Namespace:  Atalasoft.PdfDoc.Generating.Forms
Assembly:  Atalasoft.PdfDoc (in Atalasoft.PdfDoc.dll) Version: 11.0.0.0.0.297 (.NET 4.5.2, x86)
Syntax
public class GenericFormField : BaseFormField

The GenericFormField type exposes the following members.

Constructors
  NameDescription
Public methodGenericFormField
Initializes a new instance of the GenericFormField class
Top
Properties
  NameDescription
Public propertyAdditionalActions
Gets the additional actions that may be used by annotations that are children of this field.
(Inherited from BaseFormField.)
Public propertyChildFields
Gets the child fields for this field.
(Inherited from BaseFormField.)
Public propertyDefaultTextAppearance
Gets or sets the default text appearance that is shared by children of this field.
(Inherited from BaseFormField.)
Public propertyEnforceReadyOnlyWithException
Gets or sets a value indicating whether to enforce ready only with the IsFieldReadOnly propery with an exception.
(Inherited from BaseFormField.)
Public propertyFieldAlternateDescription
Gets or sets the field alternate description for display in the user interface.
(Inherited from BaseFormField.)
Public propertyFieldFullName
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.)
Public propertyFieldName
Gets or sets the name of the field.
(Inherited from BaseFormField.)
Public propertyFieldNameForExport
Gets or sets the field name for export.
(Inherited from BaseFormField.)
Public propertyIsFieldNoExport
Gets or sets a value indicating whether this field should not be export.
(Inherited from BaseFormField.)
Public propertyIsFieldReadOnly
Gets or sets a value indicating whether this field is read only.
(Inherited from BaseFormField.)
Public propertyIsFieldRequired
Gets or sets a value indicating whether this field is required.
(Inherited from BaseFormField.)
Public propertyParentField
Gets or sets the parent field.
(Inherited from BaseFormField.)
Top
Methods
  NameDescription
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodThrowIfReadOnlyT
If EnforceReadyOnlyWithException is true and IsFieldReadOnly is true, throw an InvalidOperationException, otherwise return value.
(Inherited from BaseFormField.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
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