Aspose::Words::Fields::FormFieldCollection Class Reference

A collection of FormField objects that represent all the form fields in a range. More...

#include "Aspose.Words.Cpp/Model/Fields/FormFields/FormFieldCollection.h"

Inherits System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Fields::FormField > >.

Public Member Functions

int32_t get_Count ()
 Returns the number of form fields in the collection. More...
 
System::SharedPtr< Aspose::Words::Fields::FormFieldidx_get (int32_t index)
 Returns a form field at the specified index. More...
 
System::SharedPtr< Aspose::Words::Fields::FormFieldidx_get (System::String bookmarkName)
 Returns a form field by bookmark name. More...
 
void Remove (System::String formField)
 Removes a form field with the specified name. More...
 
void RemoveAt (int32_t index)
 Removes a form field at the specified index. More...
 
void Clear ()
 Removes all form fields from this collection and from the document. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Aspose::Words::Fields::FormField > > > GetEnumerator ()
 Returns an enumerator object. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual 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...
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Words::Fields::FormField > >
typedef IEnumerator< System::SharedPtr< Aspose::Words::Fields::FormField > > 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...
 
- 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...
 
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)
 

Detailed Description

A collection of FormField objects that represent all the form fields in a range.

Member Function Documentation

◆ Clear()

void Aspose::Words::Fields::FormFieldCollection::Clear ( )

Removes all form fields from this collection and from the document.

◆ get_Count()

int32_t Aspose::Words::Fields::FormFieldCollection::get_Count ( )

Returns the number of form fields in the collection.

◆ GetEnumerator()

◆ idx_get() [1/2]

System::SharedPtr<Aspose::Words::Fields::FormField> Aspose::Words::Fields::FormFieldCollection::idx_get ( int32_t  index)

Returns a form field at the specified index.

The index is zero-based.

Negative indexes are allowed and indicate access from the back of the collection. For example -1 means the last item, -2 means the second before last and so on.

If index is greater than or equal to the number of items in the list, this returns a null reference.

If index is negative and its absolute value is greater than the number of items in the list, this returns a null reference.

Parameters
indexAn index into the collection.

◆ idx_get() [2/2]

System::SharedPtr<Aspose::Words::Fields::FormField> Aspose::Words::Fields::FormFieldCollection::idx_get ( System::String  bookmarkName)

Returns a form field by bookmark name.

Returns null if the form field with the specified bookmark name cannot be found.

Parameters
bookmarkNameCase-insensitive bookmark name.

◆ Remove()

void Aspose::Words::Fields::FormFieldCollection::Remove ( System::String  formField)

Removes a form field with the specified name.

If there is a bookmark associated with the form field, the bookmark is not removed.

Parameters
formFieldThe case-insensitive name of the form field to remove.

◆ RemoveAt()

void Aspose::Words::Fields::FormFieldCollection::RemoveAt ( int32_t  index)

Removes a form field at the specified index.

If there is a bookmark associated with the form field, the bookmark is not removed.

Parameters
indexThe zero-based index of the form field to remove.