Form Class
Class representing form object.
Inheritance Hierarchy
SystemObject
  Aspose.Pdf.FormsForm

Namespace: Aspose.Pdf.Forms
Assembly: Aspose.PDF (in Aspose.PDF.dll) Version: 20.6
Syntax
public sealed class Form : ICollection<WidgetAnnotation>, 
	IEnumerable<WidgetAnnotation>, IEnumerable

The Form type exposes the following members.

Properties
  NameDescription
Public propertyAutoRecalculate
If set, all form fields will be recalculated when any field is changed. Default value is true. Set to false in order to increase performance when filling form with large amount of calculated fields.
Public propertyCalculatedFields
Allows to set order of field calculation.
Public propertyCount
Gets number of the fields on this form.
Public propertyDefaultAppearance
Gets or sets default appearance of the form (object which describes default font, text size and color for fields on the form).
Public propertyDefaultResources
Gets default resources placed on this form.
Public propertyEmulateRequierdGroups
If this property is true then additional red boundary rectangles will be drawn for required Xfa exclGroup elements containers This property was introduced because absences of analogues for the exclGroup during conversion Xfa representation of forms to standard. It is false by default.
Public propertyFields
Gets list of all fields in lowest level of hierarhical form.
Public propertyIgnoreNeedsRendering
If this property is true the value of NeedsRendering key will be ignored during conversion XFA form to Standard form. It is false by default.
Public propertyIsSynchronized
Returns true if object is thread-safe.
Public propertyItemInt32
Gets field of the form by field index.
Public propertyItemString
Gets field of the form by field name. Throws excpetion if the field was not found.
Public propertyRemovePermission
If this property is true the "Perms" dictionary will be removed from the pdf document after conversion dynamic documents to standard. The "Perms" dictionary can contain a rules that disturb displaying selection of mandatory fields in Adobe Acrobat reader. It is false by default.
Public propertySignaturesAppendOnly
If set, the document contains signatures that may be invalidated if the file is saved (written) in a way that alters its previous contents, as opposed to an incremental update.
Public propertySignaturesExist
If set, the document contains at least one signature field.
Public propertySyncRoot
Returns synchronization object.
Public propertyType
Gets type of the form. Possible values are: Standard, Static, Dynamic.
Public propertyXFA
Gets XFA data of the form (if presents).
Methods
  NameDescription
Public methodAdd(Field)
Adds field on the form.
Public methodAdd(Field, Int32)
Adds field on the form.
Public methodAdd(Field, String, Int32)
Adds new field to the form; If this field is already placed on other or this form, the copy of field is created.
Public methodAddFieldAppearance
Adds additional appearance of the field to specified page of the document in the specified location.
Public methodAssignXfa
Sets XFA of the form to specified value.
Public methodCopyTo
Copies fields placed on the form into array.
Public methodDelete(String)
Deletes field from the form by its name.
Public methodDelete(Field)
Delete field from the form.
Public methodEquals (Inherited from Object.)
Public methodFlatten
Removes all form fields and place their values directly on the page.
Public methodGetEnumerator
Gets enumeration of form fields.
Public methodGetFieldsInRect
Returns fields inside of specified rectangle.
Public methodGetHashCode (Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodToString (Inherited from Object.)
Fields
  NameDescription
Public fieldSignDependentElementsRenderingModeWhenConverted
Forms can contain signing information, i.e. can be signed or unsigned. And form's view sometimes must depend on whether form is signed or not. This property tells to form's converter (f.e. during conversion XFA form to Standard form) whether result form must be rendered as signed or as unsigned.
See Also