Class representing form object. More...

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

Classes

class  FieldsEnumerator
 
class  FlattenSettings
 Class which describes settings for Form flattening procedure. More...
 

Public Types

enum  SignDependentElementsRenderingModes { SignDependentElementsRenderingModes::RenderFormAsUnsigned, SignDependentElementsRenderingModes::RenderFormAsSigned }
 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...
 
- 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...
 
using ValueType = System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >
 
using iterator = System::Details::VirtualizedIterator< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
 Inner iterator base type. More...
 
using virtualized_iterator_element = System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >
 Inner iterator element type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 

Public Member Functions

ASPOSE_PDF_SHARED_API bool get_IsSynchronized ()
 Returns true if object is thread-safe. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Objectget_SyncRoot () const
 Returns synchronization object. More...
 
ASPOSE_PDF_SHARED_API bool 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. More...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API bool get_AutoRestoreForm () const
 If set, absent form fields will be automatically created if they present in annotations. More...
 
ASPOSE_PDF_SHARED_API void set_AutoRestoreForm (bool value)
 If set, absent form fields will be automatically created if they present in annotations. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Resourcesget_DefaultResources ()
 Gets default resources placed on this form. More...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Forms::XFAget_XFA () const
 Gets XFA data of the form (if presents). More...
 
ASPOSE_PDF_SHARED_API bool 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. More...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API bool 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. More...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API bool 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. More...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API FormType get_Type ()
 Gets type of the form. Possible values are: Standard, Static, Dynamic. More...
 
ASPOSE_PDF_SHARED_API void set_Type (FormType value)
 Gets type of the form. Possible values are: Standard, Static, Dynamic. More...
 
ASPOSE_PDF_SHARED_API System::ArrayPtr< System::SharedPtr< Field > > get_Fields ()
 Gets list of all fields in lowest level of hierarhical form. More...
 
ASPOSE_PDF_SHARED_API void set_CalculatedFields (System::SharedPtr< System::Collections::Generic::IEnumerable< System::SharedPtr< Field >>> value)
 Allows to set order of field calculation. More...
 
ASPOSE_PDF_SHARED_API bool get_SignaturesExist ()
 If set, the document contains at least one signature field. More...
 
ASPOSE_PDF_SHARED_API void set_SignaturesExist (bool value)
 If set, the document contains at least one signature field. More...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API void CopyTo (System::ArrayPtr< System::SharedPtr< Field >> array, int32_t index)
 Copies fields placed on the form into array. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > > GetEnumerator () override
 Gets enumeration of form fields. More...
 
ASPOSE_PDF_SHARED_API void Delete (System::SharedPtr< Field > field)
 Delete field from the form. More...
 
ASPOSE_PDF_SHARED_API void Delete (System::String fieldName)
 Deletes field from the form by its name. More...
 
ASPOSE_PDF_SHARED_API void Flatten ()
 Removes all form fields and place their values directly on the page. More...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationidx_get (int32_t index)
 Gets field of the form by field index. More...
 
ASPOSE_PDF_SHARED_API void Add (System::SharedPtr< Field > field, int32_t pageNumber)
 Adds field on the form. More...
 
ASPOSE_PDF_SHARED_API void Add (const System::SharedPtr< Field > &field)
 Adds field on the form. More...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API 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...
 
ASPOSE_PDF_SHARED_API void AssignXfa (System::SharedPtr< System::Xml::XmlDocument > xml)
 Sets XFA of the form to specified value. More...
 
ASPOSE_PDF_SHARED_API bool HasField (System::SharedPtr< Field > field)
 Check if the form already has specified field. More...
 
ASPOSE_PDF_SHARED_API bool HasField (System::String fieldName)
 Determines if the field with specified name already added to the Form. More...
 
ASPOSE_PDF_SHARED_API System::ArrayPtr< System::SharedPtr< Field > > GetFieldsInRect (System::SharedPtr< Rectangle > rect)
 Returns fields inside of specified rectangle. More...
 
ASPOSE_PDF_SHARED_API int32_t get_Count () const override
 Gets number of the fields on this form. 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
 Copies all collection elements to existing array elements. More...
 
ICollectionoperator= (ICollection &&) noexcept
 Move assignment operator. More...
 
ICollectionoperator= (const ICollection &)
 Move assignment operator. More...
 
 ICollection ()
 Default constructor. More...
 
 ICollection (const ICollection &)
 Copy constructor. More...
 
 ICollection (ICollection &&) noexcept
 Move constructor. More...
 
virtual ~ICollection ()
 Destructor. More...
 
SharedPtr< Objectget_SyncRoot () const
 Gets the object the collection is being synchronized through. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationLINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationLINQ_First ()
 Returns the first element of a sequence. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationLINQ_First (const Func< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationLINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationLINQ_FirstOrDefault (std::function< bool(System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >)> predicate)
 Returns the first element of the sequence that satisfies a condition or a default value if no such element is found. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationLINQ_Last ()
 Returns the last element of a sequence. More...
 
System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotationLINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > > LINQ_ToList ()
 Creates a List<T> from a sequence. More...
 
int LINQ_Count ()
 Returns the number of elements in the sequence (calculated via direct counting). More...
 
int LINQ_Count (const Func< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >)> predicate)
 Determines whether all elements of a sequence satisfy a condition. More...
 
bool LINQ_Any ()
 Determines whether a sequence contains any elements. More...
 
bool LINQ_Any (std::function< bool(System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > > LINQ_Where (std::function< bool(System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > value)
 Determines if a sequence contains a specified value. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 Casts the elements to the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > > LINQ_OrderBy (const Func< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >, Key > &keySelector)
 Sorts the elements of a sequence in ascending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderBy (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > > LINQ_OrderByDescending (const Func< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >, Key > &keySelector)
 Sorts the elements of a sequence in descending order according to the key values selected by keySelector. More...
 
SharedPtr< IEnumerable< Source > > LINQ_OrderByDescending (const Func< Source, Key > &keySelector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 Filters the elements of the sequence based on the specified type. More...
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >, int32_t, ResultType > &selector)
 Transforms each element of a sequence into a new form by incorporating the element's index. More...
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, int32_t, Result > &selector)
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > > LINQ_Concat (SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >> sequence)
 Concatenates two sequences. More...
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > > > > > LINQ_GroupBy (System::Func< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >, Key > keyPredicate)
 Groups the elements of a sequence. More...
 
SharedPtr< IEnumerable< SharedPtr< System::Linq::IGrouping< Key, Source > > > > LINQ_GroupBy (System::Func< Source, Key > keyPredicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_SelectMany (const Func< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation >, SharedPtr< IEnumerable< ResultType >>> &selector)
 Projects each element of a sequence and combines the resulting sequences into one sequence. More...
 
SharedPtr< IEnumerable< Result > > LINQ_SelectMany (const Func< Source, SharedPtr< IEnumerable< Result >>> &selector)
 
iterator begin () noexcept
 Gets iterator pointing to the first element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator begin () const noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
iterator end () noexcept
 Gets iterator pointing right after the last element (if any) of the collection. This iterator can't be used to change a referenced object because GetEnumerator() returns a copy-object of T. More...
 
const_iterator end () const noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 Gets iterator pointing right after the last const-qualified element (if any) of the collection. More...
 
virtual virtualized_iteratorvirtualizeBeginIterator ()
 Gets the implementation of begin iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndIterator ()
 Gets the implementation of end iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeBeginConstIterator () const
 Gets the implementation of begin const iterator for the current container. More...
 
virtual virtualized_iteratorvirtualizeEndConstIterator () const
 Gets the implementation of end const iterator for the current container. 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 reference 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 int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ASPOSECPP_SHARED_API String ToString () 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 (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual ASPOSECPP_SHARED_API bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Public Attributes

Form::SignDependentElementsRenderingModes 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. More...
 

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)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (Form, CODEPORTING_ARGS(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 ASPOSE_PDF_SHARED_API ~Form ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::WidgetAnnotation > >
 ~IEnumerable () override
 Destructor. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator ()
 Gets enumerator instance and prepares it to be used as iterator kernel. More...
 
virtualized_iteratorGetEnumeratorAsVirtualizedIterator () const
 Gets enumerator instance and prepares it to be used as iterator kernel. 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 ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Class representing form object.

Member Enumeration Documentation

◆ SignDependentElementsRenderingModes

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.

Enumerator
RenderFormAsUnsigned 

Render form as unsigned.

RenderFormAsSigned 

Render form as signed.

Constructor & Destructor Documentation

◆ Form()

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

◆ ~Form()

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

Member Function Documentation

◆ Add() [1/3]

ASPOSE_PDF_SHARED_API 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/3]

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

Adds field on the form.

Parameters
fieldField which must be added.

◆ Add() [3/3]

ASPOSE_PDF_SHARED_API 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()

ASPOSE_PDF_SHARED_API 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()

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

◆ ClearCache()

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

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

◆ CopyTo()

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

◆ CreateDefaultResources()

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

◆ Delete() [1/2]

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

Delete field from the form.

Parameters
fieldField which must be deleted.

◆ Delete() [2/2]

ASPOSE_PDF_SHARED_API 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()

ASPOSE_PDF_SHARED_API 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()

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

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Forms::Form::get_AutoRestoreForm ( ) const

If set, absent form fields will be automatically created if they present in annotations.

◆ get_Count()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Forms::Form::get_Count ( ) const
overridevirtual

◆ get_DefaultAppearance()

ASPOSE_PDF_SHARED_API 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()

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

Gets default resources placed on this form.

◆ get_EmulateRequierdGroups()

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

ASPOSE_PDF_SHARED_API 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()

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

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

Returns true if object is thread-safe.

◆ get_RemovePermission()

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

ASPOSE_PDF_SHARED_API 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()

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

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

◆ get_SyncRoot()

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

Returns synchronization object.

◆ get_Type()

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

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

◆ get_XFA()

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

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()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<Aspose::Pdf::Annotations::WidgetAnnotation> > > Aspose::Pdf::Forms::Form::GetEnumerator ( )
overridevirtual

◆ getFieldByRemainedName()

◆ GetFieldsInRect()

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

◆ HasField() [1/2]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Forms::Form::HasField ( System::SharedPtr< Field field)

Check if the form already has specified field.

Parameters
fieldField to check.
Returns
true if the specified field name added to Form; otherwise, false.

◆ HasField() [2/2]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Forms::Form::HasField ( System::String  fieldName)

Determines if the field with specified name already added to the Form.

Parameters
fieldNamePartialName of the field.
Returns
true if the specified field name added to Form; otherwise, false.

◆ idx_get() [1/2]

ASPOSE_PDF_SHARED_API 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]

ASPOSE_PDF_SHARED_API 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

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::Forms::Form::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( Form  ,
CODEPORTING_ARGS(System::SharedPtr< Document > document)   
)
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()

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()

ASPOSE_PDF_SHARED_API 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_AutoRestoreForm()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Forms::Form::set_AutoRestoreForm ( bool  value)

If set, absent form fields will be automatically created if they present in annotations.

◆ set_CalculatedFields()

ASPOSE_PDF_SHARED_API 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()

ASPOSE_PDF_SHARED_API 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()

ASPOSE_PDF_SHARED_API 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()

ASPOSE_PDF_SHARED_API 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()

ASPOSE_PDF_SHARED_API 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()

ASPOSE_PDF_SHARED_API 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()

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

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

◆ set_Type()

ASPOSE_PDF_SHARED_API 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

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.

◆ useRadiobuttonExtendedAttibsWhenConvertedToStandardForm

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

◆ ZipFileToSaveConversionData

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