Packages

com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

InvalidFormTypeOperationException

Skip navigation links

java.lang.Object
- com.aspose.pdf.Form

All Implemented Interfaces:

Iterable<WidgetAnnotation>
```
public final class Form
extends Object
implements Iterable<WidgetAnnotation>
```
Class representing form object.

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`Form.FlattenSettings` Class which describes settings for Form flattening procedure.
`static class`	`Form.SignDependentElementsRenderingModes` Forms can contain signing information and can be signed or unsigned.

Field Summary

Fields
Modifier and Type Field and Description

int SignDependentElementsRenderingModeWhenConverted
Forms can contain signing information, i.e. can be signed or unsigned.

Fields
Modifier and Type	Field and Description
`int`	`SignDependentElementsRenderingModeWhenConverted` Forms can contain signing information, i.e. can be signed or unsigned.

Constructor Summary

Constructors
Constructor and Description

Form(IDocument document)
Constructor

Constructors
Constructor and Description
`Form(IDocument document)` Constructor

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Field field)` Adds field on the form.
`void`	`add(Field field, int pageNumber)` Adds field on the form.
`Field`	`add(Field field, String partialName, int pageNumber)` Adds new field to the form; If this field is already placed on other or this form, the copy of field is created.
`boolean`	`add(WidgetAnnotation field)` Adds field on the form.
`void`	`addFieldAppearance(Field field, int pageNumber, Rectangle rect)` Adds additional appearance of the field to specified page of the document in the specified location.
`void`	`addFieldToAcroForm(Field field)` Adds additional appearance of the field to specified page of the document.
`void`	`assignXfa(com.aspose.ms.System.Xml.XmlDocument xml)` Sets XFA of the form to specified value.
`void`	`clear()` Deletes all fields from form.
`boolean`	`contains(WidgetAnnotation field)` Determines if field is presented on form..
`void`	`copyTo(Field[] array, int index)` Copies fields placed on the form into array.
`void`	`copyTo(WidgetAnnotation[] array, int arrayIndex)` Copies form's fields to array.
`void`	`delete(Field field)` Delete field from the form.
`void`	`delete(String fieldName)` Deletes field from the form by its name.
`void`	`flatten()` Removes all static form fields and place their values directly on the page.
`WidgetAnnotation`	`get_Item(int index)` Gets field of the form by field index.
`WidgetAnnotation`	`get_Item(String name)` Gets field of the form by field name.
`XFA`	`get_xfa()` For internal usage only
`WidgetAnnotation`	`get(int index)`
`WidgetAnnotation`	`get(String name)` Searches field by field name.
`boolean`	`getAutoRecalculate()` If set, all form fields will be recalculated when any field is changed.
`DefaultAppearance`	`getDefaultAppearance()` Gets default appearance of the form (object which describes default font, text size and color for fields on the form).
`Resources`	`getDefaultResources()` Gets default resources placed on this form.
`IDocument`	`getDocument()` For internal usage only
`boolean`	`getEmulateRequierdGroups()` 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 analogies for the exclGroup during conversion Xfa representation of forms to standard.
`Field[]`	`getFields()` Gets list of all fields in lowest level of hierarhical form.
`Field[]`	`getFieldsInRect(Rectangle rect)` Returns fields inside of specified rectangle.
`boolean`	`getIgnoreNeedsRendering()` If this property is true the value of NeedsRendering key will be ignored during conversion XFA form to Standard form.
`boolean`	`getRemovePermission()` If this property is true the "Perms" dictionary will be removed from the pdf document after conversion dynamic documents to standard.
`boolean`	`getSignaturesAppendOnly()` 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.
`boolean`	`getSignaturesExist()` If set, the document contains at least one signature field.
`Object`	`getSyncRoot()` Returns synchronization object.
`int`	`getType()` Gets type of the form.
`XFA`	`getXFA()` Gets XFA data of the form (if presents).
`boolean`	`hasXfa()` Returns true if hasXfa
`boolean`	`isReadOnly()` Determines if collection is readonly.
`boolean`	`isSynchronized()` Returns true if object is thread-safe.
`Iterator<WidgetAnnotation>`	`iterator()` Gets enumeration of form fields.
`boolean`	`remove(WidgetAnnotation field)` Deletes field from the form.
`void`	`setAutoRecalculate(boolean value)` If set, all form fields will be recalculated when any field is changed.
`void`	`setCalculatedFields(List<Field> value)` Allows to set order of field calculation.
`void`	`setDefaultAppearance(DefaultAppearance value)` Sets default appearance of the form (object which describes default font, text size and color for fields on the form).
`void`	`setEmulateRequierdGroups(boolean value)` 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 analogies for the exclGroup during conversion Xfa representation of forms to standard.
`void`	`setIgnoreNeedsRendering(boolean value)` If this property is true the value of NeedsRendering key will be ignored during conversion XFA form to Standard form.
`void`	`setRemovePermission(boolean value)` If this property is true the "Perms" dictionary will be removed from the pdf document after conversion dynamic documents to standard.
`void`	`setSignaturesAppendOnly(boolean value)` 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.
`void`	`setSignaturesExist(boolean value)` If set, the document contains at least one signature field.
`void`	`setType(int value)` Gets type of the form.
`int`	`size()` Gets number of the fields on this form.

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - SignDependentElementsRenderingModeWhenConverted
```
public int 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.
    
    See Also:
    
    Form.SignDependentElementsRenderingModes
- Constructor Detail
  - Form
```
public Form(IDocument document)
```
    Constructor
    
    Parameters:
    
    document - IDocument object
- Method Detail
  - getDocument
```
public IDocument getDocument()
```
    For internal usage only
    
    Returns:
    
    IDocument object
  - get_xfa
```
public XFA get_xfa()
```
    For internal usage only
    
    Returns:
    
    XFA object
  - isSynchronized
```
public boolean isSynchronized()
```
    Returns true if object is thread-safe.
    
    Returns:
    
    boolean value
  - getSyncRoot
```
public Object getSyncRoot()
```
    Returns synchronization object.
    
    Returns:
    
    Object for synchronization
  - getAutoRecalculate
```
public final boolean getAutoRecalculate()
```
    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.
    
    Returns:
    
    boolean value
  - setAutoRecalculate
```
public final void setAutoRecalculate(boolean value)
```
    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.
    
    Parameters:
    
    value - boolean value
  - size
```
public int size()
```
    Gets number of the fields on this form.
    
    Returns:
    
    int value
  - getDefaultResources
```
public Resources getDefaultResources()
```
    Gets default resources placed on this form.
    
    Returns:
    
    Resources value
  - getDefaultAppearance
```
public DefaultAppearance getDefaultAppearance()
```
    Gets default appearance of the form (object which describes default font, text size and color for fields on the form).
    
    Returns:
    
    DefaultAppearance object
  - setDefaultAppearance
```
public void setDefaultAppearance(DefaultAppearance value)
```
    Sets default appearance of the form (object which describes default font, text size and color for fields on the form).
    
    Parameters:
    
    value - DefaultAppearance object
  - getXFA
```
public XFA getXFA()
```
    Gets XFA data of the form (if presents).
    
    Returns:
    
    XFA value
  - getIgnoreNeedsRendering
```
public boolean getIgnoreNeedsRendering()
```
    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.
    
    Returns:
    
    boolean value
  - setIgnoreNeedsRendering
```
public void setIgnoreNeedsRendering(boolean value)
```
    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.
    
    Parameters:
    
    value - boolean value
  - getRemovePermission
```
public boolean getRemovePermission()
```
    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.
    
    Returns:
    
    boolean value
  - setRemovePermission
```
public void setRemovePermission(boolean value)
```
    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.
    
    Parameters:
    
    value - boolean value
  - getEmulateRequierdGroups
```
public boolean getEmulateRequierdGroups()
```
    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 analogies for the exclGroup during conversion Xfa representation of forms to standard. It is false by default.
    
    Returns:
    
    boolean value
  - setEmulateRequierdGroups
```
public void setEmulateRequierdGroups(boolean value)
```
    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 analogies for the exclGroup during conversion Xfa representation of forms to standard. It is false by default.
    
    Parameters:
    
    value - boolean value
  - getType
```
public int getType()
```
    Gets type of the form. Possible values are: Standard, Static, Dynamic.
    
    Returns:
    
    FormType value
    
    See Also:
    
    FormType
  - setType
```
public void setType(int value)
```
    Gets type of the form. Possible values are: Standard, Static, Dynamic.
    
    Parameters:
    
    value - FormType value
    
    See Also:
    
    FormType
  - copyTo
```
public void copyTo(Field[] array,
                   int index)
```
    Copies fields placed on the form into array.
    
    Parameters:
    
    array - Array where fields must be placed.
    
    index - Starting index.
  - iterator
```
public Iterator<WidgetAnnotation> iterator()
```
    Gets enumeration of form fields.
    
    Specified by:
    
    iterator in interface Iterable<WidgetAnnotation>
    
    Returns:
    
    Field enumerator.
  - get
```
public WidgetAnnotation get(String name)
```
    Searches field by field name. Returns null if field was not found.
    
    Parameters:
    
    name - Field name.
    
    Returns:
    
    Field object.
  - get
```
public WidgetAnnotation get(int index)
```
  - add
```
public void add(Field field,
                int pageNumber)
```
    Adds field on the form.
    
    Parameters:
    
    field - Field which must be added.
    
    pageNumber - Page index where added field will be placed.
  - add
```
public void add(Field field)
```
    Adds field on the form.
    
    Parameters:
    
    field - Field which must be added.
  - delete
```
public void delete(Field field)
```
    Delete field from the form.
    
    Parameters:
    
    field - Field which must be deleted.
  - delete
```
public void delete(String fieldName)
```
    Deletes field from the form by its name.
    
    Parameters:
    
    fieldName - Name of the filed which must be deleted.
  - flatten
```
public void flatten()
```
    Removes all static form fields and place their values directly on the page.
  - add
```
public boolean add(WidgetAnnotation field)
```
    Adds field on the form.
    
    Parameters:
    
    field - Field which must be added.
    
    Returns:
    
    boolean value
  - clear
```
public void clear()
```
    Deletes all fields from form. Not supported.
  - contains
```
public boolean contains(WidgetAnnotation field)
```
    Determines if field is presented on form..
    
    Parameters:
    
    field - Field to search.
    
    Returns:
    
    boolean value
  - copyTo
```
public void copyTo(WidgetAnnotation[] array,
                   int arrayIndex)
```
    Copies form's fields to array.
    
    Parameters:
    
    array - Array to copy.
    
    arrayIndex - Index of array's item where copying begins.
  - isReadOnly
```
public boolean isReadOnly()
```
    Determines if collection is readonly. Always returns false.
    
    Returns:
    
    boolean value
  - remove
```
public boolean remove(WidgetAnnotation field)
```
    Deletes field from the form.
    
    Parameters:
    
    field - Field to delete.
    
    Returns:
    
    True if field was deleted. False if field was not found on form.
  - get_Item
```
public WidgetAnnotation get_Item(String name)
```
    Gets field of the form by field name. Throws excpetion if the field was not found.
    
    Parameters:
    
    name - Name of the field.
    
    Returns:
    
    Retreived field.
  - get_Item
```
public WidgetAnnotation get_Item(int index)
```
    Gets field of the form by field index.
    
    Parameters:
    
    index - Index of the field.
    
    Returns:
    
    Retreived field.
  - add
```
public Field add(Field field,
                 String partialName,
                 int pageNumber)
```
    Adds new field to the form; If this field is already placed on other or this form, the copy of field is created.
    
    Parameters:
    
    field - Field name.
    
    partialName - Name of field on the form.
    
    pageNumber - Page number where field will be added.
    
    Returns:
    
    Added field returned. If copy of the field was created it will be returned.
  - addFieldAppearance
```
public void addFieldAppearance(Field field,
                               int pageNumber,
                               Rectangle rect)
```
    Adds additional appearance of the field to specified page of the document in the specified location.
    
    Parameters:
    
    field - Field which appearance should be added on form.
    
    pageNumber - Number of the page where field must be placed.
    
    rect - Rectangle where field will be placed.
  - addFieldToAcroForm
```
public void addFieldToAcroForm(Field field)
```
    Adds additional appearance of the field to specified page of the document.
    
    Parameters:
    
    field - Field object
  - hasXfa
```
public boolean hasXfa()
```
    Returns true if hasXfa
    
    Returns:
    
    boolean value
  - assignXfa
```
public void assignXfa(com.aspose.ms.System.Xml.XmlDocument xml)
```
    Sets XFA of the form to specified value.
    
    Parameters:
    
    xml - Xml document which concains new XFA data.
  - getFields
```
public Field[] getFields()
```
    Gets list of all fields in lowest level of hierarhical form.
    
    Returns:
    
    Array with found fields.
  - getFieldsInRect
```
public Field[] getFieldsInRect(Rectangle rect)
```
    Returns fields inside of specified rectangle.
    
    Parameters:
    
    rect - Rectangle where fields should be found.
    
    Returns:
    
    Array with found fields.
  - setCalculatedFields
```
public void setCalculatedFields(List<Field> value)
```
    Allows to set order of field calculation.
    
    Parameters:
    
    value - java.util.List object.
  - getSignaturesExist
```
public final boolean getSignaturesExist()
```
    If set, the document contains at least one signature field.
    
    Returns:
    
    boolean value
  - setSignaturesExist
```
public final void setSignaturesExist(boolean value)
```
    If set, the document contains at least one signature field.
    
    Parameters:
    
    value - boolean value
  - getSignaturesAppendOnly
```
public final boolean getSignaturesAppendOnly()
```
    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.
    
    Returns:
    
    boolean value
  - setSignaturesAppendOnly
```
public final void setSignaturesAppendOnly(boolean value)
```
    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.
    
    Parameters:
    
    value - boolean value

Packages

com.aspose.pdf

Interfaces

Classes

Enums

Exceptions

Class Form

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

SignDependentElementsRenderingModeWhenConverted

Constructor Detail

Form

Method Detail

getDocument

get_xfa

isSynchronized

getSyncRoot

getAutoRecalculate

setAutoRecalculate

size

getDefaultResources

getDefaultAppearance

setDefaultAppearance

getXFA

getIgnoreNeedsRendering

setIgnoreNeedsRendering

getRemovePermission

setRemovePermission

getEmulateRequierdGroups

setEmulateRequierdGroups

getType

setType

copyTo

iterator

get

get

add

add

delete

delete

flatten

add

clear

contains

copyTo

isReadOnly

remove

get_Item

get_Item

add

addFieldAppearance

addFieldToAcroForm

hasXfa

assignXfa

getFields

getFieldsInRect

setCalculatedFields

getSignaturesExist

setSignaturesExist

getSignaturesAppendOnly

setSignaturesAppendOnly