Forms can contain signing information and can be signed or unsigned. Sometimes view of forms in viewer must depend on whether form is signed or not. This enum enumerates possible rendering modes during convertion of form type in regard to sign. More...

Inherits System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >.

Classes

class  FieldsEnumerator
 
class  FlattenSettings
 

Public Types

enum  SignDependentElementsRenderingModes { SignDependentElementsRenderingModes::RenderFormAsUnsigned, SignDependentElementsRenderingModes::RenderFormAsSigned }
 
- Public Types inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
typedef System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationValueType
 Value type name. More...
 
typedef ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
typedef IEnumerator< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > IEnumeratorType
 Enumerator type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
typedef System::Details::SharedMembersType shared_members_type
 structure to keep list of shared pointers contained in object. More...
 

Public Member Functions

bool get_IsSynchronized ()
 Returns true if object is thread-safe. More...
 
System::SharedPtr< System::Objectget_SyncRoot ()
 Returns synchronization object. More...
 
bool get_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. More...
 
void set_AutoRecalculate (bool 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. More...
 
int32_t get_Count () const
 Gets number of the fields on this form. More...
 
System::SharedPtr< Resourcesget_DefaultResources ()
 Gets default resources placed on this form. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::DefaultAppearanceget_DefaultAppearance ()
 Gets default appearance of the form (object which describes default font, text size and color for fields on the form). More...
 
void set_DefaultAppearance (System::SharedPtr< Aspose::Pdf::Annotations::DefaultAppearance > value)
 Sets default appearance of the form (object which describes default font, text size and color for fields on the form). More...
 
System::SharedPtr< Aspose::Pdf::Forms::XFAget_XFA ()
 Gets XFA data of the form (if presents). More...
 
bool get_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. More...
 
void set_IgnoreNeedsRendering (bool 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. More...
 
bool get_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. More...
 
void set_RemovePermission (bool 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. More...
 
bool get_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. More...
 
void set_EmulateRequierdGroups (bool 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 analogues for the exclGroup during conversion Xfa representation of forms to standard. It is false by default. More...
 
FormType get_Type ()
 Gets type of the form. Possible values are: Standard, Static, Dynamic. More...
 
void set_Type (FormType value)
 Gets type of the form. Possible values are: Standard, Static, Dynamic. More...
 
bool get_IsReadOnly () const
 Determines if collection is readonly. Always returns false. More...
 
System::ArrayPtr< System::SharedPtr< Field > > get_Fields ()
 Gets list of all fields in lowest level of hierarhical form. More...
 
void set_CalculatedFields (System::SharedPtr< System::Collections::Generic::IEnumerable< System::SharedPtr< Field >>> value)
 Allows to set order of field calculation. More...
 
bool get_SignaturesExist ()
 If set, the document contains at least one signature field. More...
 
void set_SignaturesExist (bool value)
 If set, the document contains at least one signature field. More...
 
bool 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. More...
 
void set_SignaturesAppendOnly (bool 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. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< Field >> array, int32_t index)
 Copies fields placed on the form into array. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > > GetEnumerator ()
 Gets enumeration of form fields. More...
 
void Add (System::SharedPtr< Field > field, int32_t pageNumber)
 Adds field on the form. More...
 
void Add (System::SharedPtr< Field > const &field)
 Adds field on the form. More...
 
void Delete (System::SharedPtr< Field > field)
 Delete field from the form. More...
 
void Delete (System::String fieldName)
 Deletes field from the form by its name. More...
 
void Flatten ()
 Removes all form fields and place their values directly on the page. More...
 
void Add (System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > const &field)
 Adds field on the form. More...
 
void Clear ()
 Deletes all fields from form. Not supported. More...
 
bool Contains (System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > const &field) const
 Determines if field is presented on form.. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >> array, int32_t arrayIndex)
 Copies form's fields to array. More...
 
bool Remove (System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > const &field)
 Deletes field from the form. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationidx_get (System::String name)
 Gets field of the form by field name. Throws excpetion if the field was not found. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationidx_get (int32_t index)
 Gets field of the form by field index. More...
 
System::SharedPtr< FieldAdd (System::SharedPtr< Field > field, System::String partialName, int32_t pageNumber)
 Adds new field to the form; If this field is already placed on other or this form, the copy of field is created. More...
 
void AddFieldAppearance (System::SharedPtr< Field > field, int32_t pageNumber, System::SharedPtr< Rectangle > rect)
 Adds additional appearance of the field to specified page of the document in the specified location. More...
 
void AssignXfa (System::SharedPtr< System::Xml::XmlDocument > xml)
 Sets XFA of the form to specified value. More...
 
System::ArrayPtr< System::SharedPtr< Field > > GetFieldsInRect (System::SharedPtr< Rectangle > rect)
 Returns fields inside of specified rectangle. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > array, int arrayIndex)=0
 
ICollectionoperator= (ICollection &&)
 
ICollectionoperator= (const ICollection &)
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&)
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 
- Public Member Functions inherited from System::Object
ASPOSECPP_SHARED_API Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ASPOSECPP_SHARED_API ~Object ()
 Destroys object. Frees all internal data structures. More...
 
ASPOSECPP_SHARED_API Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared refernce counter. More...
 
ASPOSECPP_SHARED_API void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
ASPOSECPP_SHARED_API void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 
template<>
bool Equals (double const &objA, double const &objB)
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 

Public Attributes

Form::SignDependentElementsRenderingModes SignDependentElementsRenderingModeWhenConverted
 

Protected Member Functions

bool get_HasXfa ()
 
void assertDefaultResources ()
 
void ClearCache ()
 Clears cashed fields. This is required when form is flatteing. More...
 
 Form (System::SharedPtr< Document > document)
 
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationget (System::String name)
 Searches field by field name. Returns null if field was not found. More...
 
bool IsButton (System::SharedPtr< System::Xml::XmlNode > fieldTemplate)
 
void FlattenXfa (System::SharedPtr< Form::FlattenSettings > flattenSettings)
 
System::SharedPtr< FieldfindField (System::String name)
 
System::SharedPtr< Fieldremove (System::String name)
 
void addFieldToAcroForm (System::SharedPtr< Field > field)
 
System::SharedPtr< FieldduplicateField (System::SharedPtr< Field > field)
 
void removeFieldFromAnnots (System::SharedPtr< Field > removedField)
 
System::SharedPtr< ResourcesCreateDefaultResources ()
 
void UpdateStaticFormAppearance (int32_t pageIndex)
 
void Recalculate ()
 
bool RecalculateStep ()
 Recalculates calculated fields of the form. More...
 
virtual ~Form ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
 ~IEnumerable () override
 Destructor. More...
 

Static Protected Member Functions

static System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationfindInHash (System::SharedPtr< Aspose::Pdf::Collections::AsposeHashDictionary< System::String, System::SharedPtr< System::Object >>> hash, System::String name)
 
static System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationgetFieldByRemainedName (System::String remainedName, System::SharedPtr< Aspose::Pdf::Collections::AsposeHashDictionary< System::String, System::SharedPtr< System::Object >>> hash, System::SharedPtr< System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >>> fields)
 
static System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfDictionary > GetAcroFormFontsDictionary (System::SharedPtr< Document > document)
 

Protected Attributes

System::WeakPtr< Document_document
 
System::SharedPtr< Aspose::Pdf::Forms::XFA_xfa
 
System::String ApsModelSnapshotFileForTypeConversion
 
System::String ApsModelXpsSnapshotFileForTypeConversion
 
System::String ApsModelPngSnapshotFileForTypeConversion
 
Aspose::Pdf::ApsToXpsSavingMode ApsToXpsSavingMode
 
bool useRadiobuttonExtendedAttibsWhenConvertedToStandardForm
 
System::String ZipFileToSaveConversionData
 

Additional Inherited Members

- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Impleemnts C# typeof(System.Object) construct. More...
 

Detailed Description

Forms can contain signing information and can be signed or unsigned. Sometimes view of forms in viewer must depend on whether form is signed or not. This enum enumerates possible rendering modes during convertion of form type in regard to sign.

Member Enumeration Documentation

◆ SignDependentElementsRenderingModes

Enumerator
RenderFormAsUnsigned 
RenderFormAsSigned 

Constructor & Destructor Documentation

◆ Form()

Aspose::Pdf::Forms::Form::Form ( System::SharedPtr< Document document)
protected

◆ ~Form()

virtual Aspose::Pdf::Forms::Form::~Form ( )
protectedvirtual

Member Function Documentation

◆ Add() [1/4]

void Aspose::Pdf::Forms::Form::Add ( System::SharedPtr< Field field,
int32_t  pageNumber 
)

Adds field on the form.

Parameters
fieldField which must be added.
pageNumberPage index where added field will be placed.

◆ Add() [2/4]

void Aspose::Pdf::Forms::Form::Add ( System::SharedPtr< Field > const &  field)

Adds field on the form.

Parameters
fieldField which must be added.

◆ Add() [3/4]

void Aspose::Pdf::Forms::Form::Add ( System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > const &  field)
virtual

Adds field on the form.

Parameters
fieldField which must be added.

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >.

◆ Add() [4/4]

System::SharedPtr<Field> Aspose::Pdf::Forms::Form::Add ( System::SharedPtr< Field field,
System::String  partialName,
int32_t  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
fieldField name.
partialNameName of field on the form.
pageNumberPage number where field will be added.
Returns
Added field returned. If copy of the field was created it will be returned.

◆ AddFieldAppearance()

void Aspose::Pdf::Forms::Form::AddFieldAppearance ( System::SharedPtr< Field field,
int32_t  pageNumber,
System::SharedPtr< Rectangle rect 
)

Adds additional appearance of the field to specified page of the document in the specified location.

Parameters
fieldField which appearance should be added on form.
pageNumberNumber of the page where field must be placed.
rectRectangle where field will be placed.

◆ addFieldToAcroForm()

void Aspose::Pdf::Forms::Form::addFieldToAcroForm ( System::SharedPtr< Field field)
protected

◆ assertDefaultResources()

void Aspose::Pdf::Forms::Form::assertDefaultResources ( )
protected

◆ AssignXfa()

void Aspose::Pdf::Forms::Form::AssignXfa ( System::SharedPtr< System::Xml::XmlDocument xml)

Sets XFA of the form to specified value.

Parameters
xmlXml document which concains new XFA data.

◆ Clear()

void Aspose::Pdf::Forms::Form::Clear ( )
virtual

◆ ClearCache()

void Aspose::Pdf::Forms::Form::ClearCache ( )
protected

Clears cashed fields. This is required when form is flatteing.

◆ Contains()

bool Aspose::Pdf::Forms::Form::Contains ( System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > const &  field) const
virtual

Determines if field is presented on form..

Parameters
fieldField to search.

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >.

◆ CopyTo() [1/2]

void Aspose::Pdf::Forms::Form::CopyTo ( System::ArrayPtr< System::SharedPtr< Field >>  array,
int32_t  index 
)

Copies fields placed on the form into array.

Parameters
arrayArray where fields must be placed.
indexStarting index.

◆ CopyTo() [2/2]

void Aspose::Pdf::Forms::Form::CopyTo ( System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >>  array,
int32_t  arrayIndex 
)

Copies form's fields to array.

Parameters
arrayArray to copy.
arrayIndexIndex of array's item where copying begins.

◆ CreateDefaultResources()

System::SharedPtr<Resources> Aspose::Pdf::Forms::Form::CreateDefaultResources ( )
protected

◆ Delete() [1/2]

void Aspose::Pdf::Forms::Form::Delete ( System::SharedPtr< Field field)

Delete field from the form.

Parameters
fieldField which must be deleted.

◆ Delete() [2/2]

void Aspose::Pdf::Forms::Form::Delete ( System::String  fieldName)

Deletes field from the form by its name.

Parameters
fieldNameName of the filed which must be deleted.

◆ duplicateField()

System::SharedPtr<Field> Aspose::Pdf::Forms::Form::duplicateField ( System::SharedPtr< Field field)
protected

◆ findField()

System::SharedPtr<Field> Aspose::Pdf::Forms::Form::findField ( System::String  name)
protected

◆ findInHash()

◆ Flatten()

void Aspose::Pdf::Forms::Form::Flatten ( )

Removes all form fields and place their values directly on the page.

◆ FlattenXfa()

void Aspose::Pdf::Forms::Form::FlattenXfa ( System::SharedPtr< Form::FlattenSettings flattenSettings)
protected

◆ get()

System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation> Aspose::Pdf::Forms::Form::get ( System::String  name)
protected

Searches field by field name. Returns null if field was not found.

Parameters
nameField name.
Returns
Field object.

◆ get_AutoRecalculate()

bool Aspose::Pdf::Forms::Form::get_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.

◆ get_Count()

int32_t Aspose::Pdf::Forms::Form::get_Count ( ) const
virtual

◆ get_DefaultAppearance()

System::SharedPtr<Aspose::Pdf::Annotations::DefaultAppearance> Aspose::Pdf::Forms::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()

System::SharedPtr<Resources> Aspose::Pdf::Forms::Form::get_DefaultResources ( )

Gets default resources placed on this form.

◆ get_EmulateRequierdGroups()

bool Aspose::Pdf::Forms::Form::get_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.

◆ get_Fields()

System::ArrayPtr<System::SharedPtr<Field> > Aspose::Pdf::Forms::Form::get_Fields ( )

Gets list of all fields in lowest level of hierarhical form.

◆ get_HasXfa()

bool Aspose::Pdf::Forms::Form::get_HasXfa ( )
protected

◆ get_IgnoreNeedsRendering()

bool Aspose::Pdf::Forms::Form::get_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.

◆ get_IsReadOnly()

bool Aspose::Pdf::Forms::Form::get_IsReadOnly ( ) const
virtual

Determines if collection is readonly. Always returns false.

Reimplemented from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >.

◆ get_IsSynchronized()

bool Aspose::Pdf::Forms::Form::get_IsSynchronized ( )

Returns true if object is thread-safe.

◆ get_RemovePermission()

bool Aspose::Pdf::Forms::Form::get_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.

◆ get_SignaturesAppendOnly()

bool Aspose::Pdf::Forms::Form::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()

bool Aspose::Pdf::Forms::Form::get_SignaturesExist ( )

If set, the document contains at least one signature field.

◆ get_SyncRoot()

System::SharedPtr<System::Object> Aspose::Pdf::Forms::Form::get_SyncRoot ( )

Returns synchronization object.

◆ get_Type()

FormType Aspose::Pdf::Forms::Form::get_Type ( )

Gets type of the form. Possible values are: Standard, Static, Dynamic.

◆ get_XFA()

System::SharedPtr<Aspose::Pdf::Forms::XFA> Aspose::Pdf::Forms::Form::get_XFA ( )

Gets XFA data of the form (if presents).

◆ GetAcroFormFontsDictionary()

static System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> Aspose::Pdf::Forms::Form::GetAcroFormFontsDictionary ( System::SharedPtr< Document document)
staticprotected

◆ GetEnumerator()

◆ getFieldByRemainedName()

◆ GetFieldsInRect()

System::ArrayPtr<System::SharedPtr<Field> > Aspose::Pdf::Forms::Form::GetFieldsInRect ( System::SharedPtr< Rectangle rect)

Returns fields inside of specified rectangle.

Parameters
rectRectangle where fields should be found.
Returns
Array with found fields.

◆ idx_get() [1/2]

System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation> Aspose::Pdf::Forms::Form::idx_get ( System::String  name)

Gets field of the form by field name. Throws excpetion if the field was not found.

Parameters
nameName of the field.
Returns
Retreived field.

◆ idx_get() [2/2]

System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation> Aspose::Pdf::Forms::Form::idx_get ( int32_t  index)

Gets field of the form by field index.

Parameters
indexIndex of the field.
Returns
Retreived field.

◆ IsButton()

bool Aspose::Pdf::Forms::Form::IsButton ( System::SharedPtr< System::Xml::XmlNode fieldTemplate)
protected

◆ Recalculate()

void Aspose::Pdf::Forms::Form::Recalculate ( )
protected

◆ RecalculateStep()

bool Aspose::Pdf::Forms::Form::RecalculateStep ( )
protected

Recalculates calculated fields of the form.

Returns
true if at least one field was changed.

◆ Remove()

bool Aspose::Pdf::Forms::Form::Remove ( System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > const &  field)
virtual

Deletes field from the form.

Parameters
fieldField to delete.
Returns
True if field was deleted. False if field was not found on form.

Implements System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >.

◆ remove()

System::SharedPtr<Field> Aspose::Pdf::Forms::Form::remove ( System::String  name)
protected

◆ removeFieldFromAnnots()

void Aspose::Pdf::Forms::Form::removeFieldFromAnnots ( System::SharedPtr< Field removedField)
protected

◆ set_AutoRecalculate()

void Aspose::Pdf::Forms::Form::set_AutoRecalculate ( bool  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.

◆ set_CalculatedFields()

void Aspose::Pdf::Forms::Form::set_CalculatedFields ( System::SharedPtr< System::Collections::Generic::IEnumerable< System::SharedPtr< Field >>>  value)

Allows to set order of field calculation.

◆ set_DefaultAppearance()

void Aspose::Pdf::Forms::Form::set_DefaultAppearance ( System::SharedPtr< Aspose::Pdf::Annotations::DefaultAppearance value)

Sets default appearance of the form (object which describes default font, text size and color for fields on the form).

◆ set_EmulateRequierdGroups()

void Aspose::Pdf::Forms::Form::set_EmulateRequierdGroups ( bool  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 analogues for the exclGroup during conversion Xfa representation of forms to standard. It is false by default.

◆ set_IgnoreNeedsRendering()

void Aspose::Pdf::Forms::Form::set_IgnoreNeedsRendering ( bool  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.

◆ set_RemovePermission()

void Aspose::Pdf::Forms::Form::set_RemovePermission ( bool  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.

◆ set_SignaturesAppendOnly()

void Aspose::Pdf::Forms::Form::set_SignaturesAppendOnly ( bool  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.

◆ set_SignaturesExist()

void Aspose::Pdf::Forms::Form::set_SignaturesExist ( bool  value)

If set, the document contains at least one signature field.

◆ set_Type()

void Aspose::Pdf::Forms::Form::set_Type ( FormType  value)

Gets type of the form. Possible values are: Standard, Static, Dynamic.

◆ UpdateStaticFormAppearance()

void Aspose::Pdf::Forms::Form::UpdateStaticFormAppearance ( int32_t  pageIndex)
protected

Member Data Documentation

◆ _document

System::WeakPtr<Document> Aspose::Pdf::Forms::Form::_document
protected

◆ _xfa

System::SharedPtr<Aspose::Pdf::Forms::XFA> Aspose::Pdf::Forms::Form::_xfa
protected

◆ ApsModelPngSnapshotFileForTypeConversion

System::String Aspose::Pdf::Forms::Form::ApsModelPngSnapshotFileForTypeConversion
protected

◆ ApsModelSnapshotFileForTypeConversion

System::String Aspose::Pdf::Forms::Form::ApsModelSnapshotFileForTypeConversion
protected

◆ ApsModelXpsSnapshotFileForTypeConversion

System::String Aspose::Pdf::Forms::Form::ApsModelXpsSnapshotFileForTypeConversion
protected

◆ ApsToXpsSavingMode

Aspose::Pdf::ApsToXpsSavingMode Aspose::Pdf::Forms::Form::ApsToXpsSavingMode
protected

◆ SignDependentElementsRenderingModeWhenConverted

Form::SignDependentElementsRenderingModes Aspose::Pdf::Forms::Form::SignDependentElementsRenderingModeWhenConverted

◆ useRadiobuttonExtendedAttibsWhenConvertedToStandardForm

bool Aspose::Pdf::Forms::Form::useRadiobuttonExtendedAttibsWhenConvertedToStandardForm
protected

◆ ZipFileToSaveConversionData

System::String Aspose::Pdf::Forms::Form::ZipFileToSaveConversionData
protected