Aspose::Pdf::Forms::Form class
Contents
[
Hide
]Form class
Class representing form object.
class Form : public System::Collections::Generic::ICollection<System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation>>
Methods
| Method | Description |
|---|---|
| Add(System::SharedPtr<Field>, int32_t) | Adds field on the form. |
| Add(const System::SharedPtr<Field>&) | Adds field on the form. |
| Add(System::SharedPtr<Field>, System::String, int32_t) | Adds new field to the form; If this field is already placed on other or this form, the copy of field is created. |
| AddFieldAppearance(System::SharedPtr<Field>, int32_t, System::SharedPtr<Rectangle>) | Adds additional appearance of the field to specified page of the document in the specified location. |
| AssignXfa(System::SharedPtr<System::Xml::XmlDocument>) | Sets XFA of the form to specified value. |
| CopyTo(System::ArrayPtr<System::SharedPtr<Field>>, int32_t) | Copies fields placed on the form into array. |
| Delete(System::SharedPtr<Field>) | Delete field from the form. |
| Delete(System::String) | Deletes field from the form by its name. |
| Flatten() | Removes all form fields and place their values directly on the page. |
| get_AutoRecalculate() const | 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. |
| get_AutoRestoreForm() const | If set, absent form fields will be automatically created if they present in annotations. |
| get_Count() const override | Gets number of the fields on this form. |
| get_DefaultAppearance() | Gets default appearance of the form (object which describes default font, text size and color for fields on the form). |
| get_DefaultResources() | Gets default resources placed on this form. |
| get_EmulateRequierdGroups() const | 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. |
| get_Fields() | Gets list of all fields in lowest level of hierarhical form. |
| get_IgnoreNeedsRendering() const | 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. |
| get_IsSynchronized() | Returns true if object is thread-safe. |
| get_RemovePermission() const | 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. |
| get_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. |
| get_SignaturesExist() | If set, the document contains at least one signature field. |
| get_SyncRoot() const | Returns synchronization object. |
| get_Type() | Gets type of the form. Possible values are: Standard, Static, Dynamic. |
| get_XFA() const | Gets XFA data of the form (if presents). |
| GetEnumerator() override | Gets enumeration of form fields. |
| GetFieldsInRect(System::SharedPtr<Rectangle>) | Returns fields inside of specified rectangle. |
| HasField(System::SharedPtr<Field>) | Check if the form already has specified field. |
| HasField(System::String) | Determines if the field with specified name already added to the Form. |
| HasField(System::String, bool) | Determines if the field with specified name already added to the Form, with ability to look into children hierarchy of fields. |
| idx_get(System::String) | Gets field of the form by field name. Throws excpetion if the field was not found. |
| idx_get(int32_t) | Gets field of the form by field index. |
| MakeFormAnnotationsIndependent(System::SharedPtr<Page>) | Makes form fields annotations independent. |
| RemoveFieldAppearance(System::SharedPtr<Field>, int32_t) | Removes appearance of the field at specified index. If only one child appearance left, method embeds it into the field. |
| set_AutoRecalculate(bool) | 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. |
| set_AutoRestoreForm(bool) | If set, absent form fields will be automatically created if they present in annotations. |
| set_CalculatedFields(System::SharedPtr<System::Collections::Generic::IEnumerable<System::SharedPtr<Field>>>) | Allows to set order of field calculation. |
| set_DefaultAppearance(System::SharedPtr<Aspose::Pdf::Annotations::DefaultAppearance>) | Sets default appearance of the form (object which describes default font, text size and color for fields on the form). |
| set_EmulateRequierdGroups(bool) | 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. |
| set_IgnoreNeedsRendering(bool) | 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. |
| set_RemovePermission(bool) | 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. |
| set_SignaturesAppendOnly(bool) | 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. |
| set_SignaturesExist(bool) | If set, the document contains at least one signature field. |
| set_Type(FormType) | Gets type of the form. Possible values are: Standard, Static, Dynamic. |
See Also
- Namespace Aspose::Pdf::Forms
- Library Aspose.PDF for C++