Click or drag to resize

BaseFormField Class

BaseFormField is an abstract class used to represent all form fields that will be parents of other fields or widget annotations.
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 abstract class BaseFormField : IFormElement

The BaseFormField type exposes the following members.

Constructors
  NameDescription
Protected methodBaseFormField
Initializes a new instance of the BaseFormField class.
Top
Properties
  NameDescription
Public propertyAdditionalActions
Gets the additional actions that may be used by annotations that are children of this field.
Public propertyChildFields
Gets the child fields for this field.
Public propertyDefaultTextAppearance
Gets or sets the default text appearance that is shared by children of this field.
Public propertyEnforceReadyOnlyWithException
Gets or sets a value indicating whether to enforce ready only with the IsFieldReadOnly propery with an exception.
Public propertyFieldAlternateDescription
Gets or sets the field alternate description for display in the user interface.
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
Public propertyFieldName
Gets or sets the name of the field.
Public propertyFieldNameForExport
Gets or sets the field name for export.
Public propertyIsFieldNoExport
Gets or sets a value indicating whether this field should not be export.
Public propertyIsFieldReadOnly
Gets or sets a value indicating whether this field is read only.
Public propertyIsFieldRequired
Gets or sets a value indicating whether this field is required.
Public propertyParentField
Gets or sets the parent field.
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.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
See Also