Form Class - Aspose.PDF for .NET

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.3

Syntax

C++

public sealed class Form : ICollection<WidgetAnnotation>, 
	IEnumerable<WidgetAnnotation>, IEnumerable

Public NotInheritable Class Form
	Implements ICollection(Of WidgetAnnotation), IEnumerable(Of WidgetAnnotation), 
	IEnumerable

public ref class Form sealed : ICollection<WidgetAnnotation^>, 
	IEnumerable<WidgetAnnotation^>, IEnumerable

[<SealedAttribute>]
type Form =  
    class
        interface ICollection<WidgetAnnotation>
        interface IEnumerable<WidgetAnnotation>
        interface IEnumerable
    end

The Form type exposes the following members.

Properties

	Name	Description
	AutoRecalculate	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.
	CalculatedFields	Allows to set order of field calculation.
	Count	Gets number of the fields on this form.
	DefaultAppearance	Gets or sets default appearance of the form (object which describes default font, text size and color for fields on the form).
	DefaultResources	Gets default resources placed on this form.
	EmulateRequierdGroups	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.
	Fields	Gets list of all fields in lowest level of hierarhical form.
	IgnoreNeedsRendering	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.
	IsSynchronized	Returns true if object is thread-safe.
	ItemInt32	Gets field of the form by field index.
	ItemString	Gets field of the form by field name. Throws excpetion if the field was not found.
	RemovePermission	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.
	SignaturesAppendOnly	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.
	SignaturesExist	If set, the document contains at least one signature field.
	SyncRoot	Returns synchronization object.
	Type	Gets type of the form. Possible values are: Standard, Static, Dynamic.
	XFA	Gets XFA data of the form (if presents).

Methods

	Name	Description
	Add(Field)	Adds field on the form.
	Add(Field, Int32)	Adds field on the form.
	Add(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.
	AddFieldAppearance	Adds additional appearance of the field to specified page of the document in the specified location.
	AssignXfa	Sets XFA of the form to specified value.
	CopyTo	Copies fields placed on the form into array.
	Delete(String)	Deletes field from the form by its name.
	Delete(Field)	Delete field from the form.
	Equals	(Inherited from Object.)
	Flatten	Removes all form fields and place their values directly on the page.
	GetEnumerator	Gets enumeration of form fields.
	GetFieldsInRect	Returns fields inside of specified rectangle.
	GetHashCode	(Inherited from Object.)
	GetType	(Inherited from Object.)
	ToString	(Inherited from Object.)

Fields

	Name	Description
	SignDependentElementsRenderingModeWhenConverted	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.

Reference

Aspose.Pdf.Forms Namespace