Aspose::Pdf::XFormCollection Class Referencefinal

Class represents collection of XFormCollection. More...

#include "XFormCollection.h"

Inherits System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::XForm > >, and Aspose::Pdf::ISupportsMemoryCleanup.

Public Member Functions

ASPOSE_PDF_SHARED_API int32_t get_Count () const override
 Gets count of XForms in collection. More...
 
ASPOSE_PDF_SHARED_API bool get_IsSynchronized ()
 Returns true if object is synchronized. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Objectget_SyncRoot () const
 Synchronization object. More...
 
ASPOSE_PDF_SHARED_API bool get_IsReadOnly () const override
 Gets a value indicating whether the collection is read-only. More...
 
ASPOSE_PDF_SHARED_API void Add (const System::SharedPtr< XForm > &item) override
 Adds new XForm into collection. More...
 
ASPOSE_PDF_SHARED_API void Delete (int32_t index)
 Delete XForm from collection More...
 
ASPOSE_PDF_SHARED_API void Delete ()
 Deletes all XForms from the collection. More...
 
ASPOSE_PDF_SHARED_API void CopyTo (System::ArrayPtr< System::SharedPtr< XForm >> array, int32_t index) override
 Copies XFormCollection into collection. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< XForm > > > GetEnumerator () override
 Returns collection enumerator. More...
 
ASPOSE_PDF_SHARED_API void Delete (System::String name)
 Deletes XForm from collection by form name. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< XFormidx_get (int32_t index)
 Returns XForm by index. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< XFormidx_get (System::String name)
 Returns XForm by its name. Exception is thrown if XForm with specified name is not found. More...
 
ASPOSE_PDF_SHARED_API System::String GetFormName (System::SharedPtr< XForm > form)
 Returns name of the form in this form collection. More...
 
ASPOSE_PDF_SHARED_API void Clear () override
 Clears all items from the collection. More...
 
ASPOSE_PDF_SHARED_API bool Contains (const System::SharedPtr< XForm > &item) const override
 Determines whether the collection contains a specific value. More...
 
ASPOSE_PDF_SHARED_API bool Remove (const System::SharedPtr< XForm > &item) override
 Deletes specified item from collection. More...
 
ASPOSE_PDF_SHARED_API void cpp_set_xfrom_weak (System::SharedPtr< XForm > form)
 
ASPOSE_PDF_SHARED_API void FreeMemory () override
 Clears cached data, frees memory etc. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::XForm > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::XForm > > 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::XForm > >
System::SharedPtr< Aspose::Pdf::XFormLINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
System::SharedPtr< Aspose::Pdf::XFormLINQ_First ()
 Returns the first element of a sequence. More...
 
System::SharedPtr< Aspose::Pdf::XFormLINQ_First (const Func< System::SharedPtr< Aspose::Pdf::XForm >, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
System::SharedPtr< Aspose::Pdf::XFormLINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
System::SharedPtr< Aspose::Pdf::XFormLINQ_FirstOrDefault (std::function< bool(System::SharedPtr< Aspose::Pdf::XForm >)> 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::XFormLINQ_Last ()
 Returns the last element of a sequence. More...
 
System::SharedPtr< Aspose::Pdf::XFormLINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< System::SharedPtr< Aspose::Pdf::XForm > > > 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::XForm >, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< System::SharedPtr< Aspose::Pdf::XForm > > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(System::SharedPtr< Aspose::Pdf::XForm >)> 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::XForm >)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::XForm > > > LINQ_Where (std::function< bool(System::SharedPtr< Aspose::Pdf::XForm >)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (System::SharedPtr< Aspose::Pdf::XForm > 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::XForm > > > LINQ_OrderBy (const Func< System::SharedPtr< Aspose::Pdf::XForm >, 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::XForm > > > LINQ_OrderByDescending (const Func< System::SharedPtr< Aspose::Pdf::XForm >, 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::XForm >, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< System::SharedPtr< Aspose::Pdf::XForm >, 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::XForm > > > LINQ_Concat (SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::XForm > >> sequence)
 Concatenates two sequences. More...
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, System::SharedPtr< Aspose::Pdf::XForm > > > > > LINQ_GroupBy (System::Func< System::SharedPtr< Aspose::Pdf::XForm >, 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::XForm >, 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 ()
 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
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
iterator end ()
 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
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const
 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...
 

Protected Member Functions

void Add (System::String name, System::SharedPtr< Engine::Data::IPdfObject > formObj)
 
 XFormCollection (System::SharedPtr< Resources > parent, System::SharedPtr< Engine::Data::IPdfDictionary > xObject)
 XForm constructor More...
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (XFormCollection, CODEPORTING_ARGS(System::SharedPtr< Resources > parent, System::SharedPtr< Engine::Data::IPdfDictionary > xObject))
 
bool HasForm (System::String formName)
 
virtual ASPOSE_PDF_SHARED_API ~XFormCollection ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::XForm > >
 ~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...
 

Protected Attributes

System::SharedPtr< ResourcesParent
 Resources where XForm objects are situated. More...
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::XForm > >
typedef System::SharedPtr< Aspose::Pdf::XFormValueType
 Value type name. More...
 
typedef ICollection< System::SharedPtr< Aspose::Pdf::XForm > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::XForm > >
typedef IEnumerator< System::SharedPtr< Aspose::Pdf::XForm > > IEnumeratorType
 Enumerator type. More...
 
using ValueType = System::SharedPtr< Aspose::Pdf::XForm >
 
using iterator = System::Details::VirtualizedIterator< System::SharedPtr< Aspose::Pdf::XForm > >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< System::SharedPtr< Aspose::Pdf::XForm > >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< System::SharedPtr< Aspose::Pdf::XForm > >
 Inner iterator base type. More...
 
using virtualized_iterator_element = System::SharedPtr< Aspose::Pdf::XForm >
 Inner iterator element type. More...
 
- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. 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 ()
 Implements C# typeof(System.Object) construct. More...
 

Detailed Description

Class represents collection of XFormCollection.

Constructor & Destructor Documentation

◆ XFormCollection()

Aspose::Pdf::XFormCollection::XFormCollection ( System::SharedPtr< Resources parent,
System::SharedPtr< Engine::Data::IPdfDictionary >  xObject 
)
protected

XForm constructor

Parameters
parentResources object which contains forms
xObjectDictionary object which contains XFormCollection

◆ ~XFormCollection()

virtual ASPOSE_PDF_SHARED_API Aspose::Pdf::XFormCollection::~XFormCollection ( )
protectedvirtual

Member Function Documentation

◆ Add() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XFormCollection::Add ( const System::SharedPtr< XForm > &  item)
overridevirtual

Adds new XForm into collection.

Parameters
itemXForm to add into collection.

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

◆ Add() [2/2]

void Aspose::Pdf::XFormCollection::Add ( System::String  name,
System::SharedPtr< Engine::Data::IPdfObject >  formObj 
)
protected

◆ Clear()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XFormCollection::Clear ( )
overridevirtual

◆ Contains()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::XFormCollection::Contains ( const System::SharedPtr< XForm > &  item) const
overridevirtual

Determines whether the collection contains a specific value.

Parameters
itemThe object to locate in the collection
Returns
true if item is found in the collection; otherwise, false.

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

◆ CopyTo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XFormCollection::CopyTo ( System::ArrayPtr< System::SharedPtr< XForm >>  array,
int32_t  index 
)
override

Copies XFormCollection into collection.

Parameters
arrayArray of XForm to be copied
indexIndex where XFormCollection will be copied

◆ cpp_set_xfrom_weak()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XFormCollection::cpp_set_xfrom_weak ( System::SharedPtr< XForm form)

◆ Delete() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XFormCollection::Delete ( int32_t  index)

Delete XForm from collection

Parameters
indexIndex of XForm which must be deleted

◆ Delete() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XFormCollection::Delete ( )

Deletes all XForms from the collection.

◆ Delete() [3/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XFormCollection::Delete ( System::String  name)

Deletes XForm from collection by form name.

Parameters
nameName of XForm to be deleted.

◆ FreeMemory()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::XFormCollection::FreeMemory ( )
overridevirtual

Clears cached data, frees memory etc.

Implements Aspose::Pdf::ISupportsMemoryCleanup.

◆ get_Count()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::XFormCollection::get_Count ( ) const
overridevirtual

◆ get_IsReadOnly()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::XFormCollection::get_IsReadOnly ( ) const
overridevirtual

Gets a value indicating whether the collection is read-only.

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

◆ get_IsSynchronized()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::XFormCollection::get_IsSynchronized ( )

Returns true if object is synchronized.

◆ get_SyncRoot()

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

Synchronization object.

◆ GetEnumerator()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<XForm> > > Aspose::Pdf::XFormCollection::GetEnumerator ( )
overridevirtual

Returns collection enumerator.

Returns
Enumerator for collection

Implements System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::XForm > >.

◆ GetFormName()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::XFormCollection::GetFormName ( System::SharedPtr< XForm form)

Returns name of the form in this form collection.

Parameters
formForm which name is searched.
Returns
Form name in the collection; Null if form is not contained in the collection.

◆ HasForm()

bool Aspose::Pdf::XFormCollection::HasForm ( System::String  formName)
protected

◆ idx_get() [1/2]

ASPOSE_PDF_SHARED_API System::SharedPtr<XForm> Aspose::Pdf::XFormCollection::idx_get ( int32_t  index)

Returns XForm by index.

Parameters
indexIndex of XFormCollection. XForms numbering is started from 1.
Returns
Retrieved XForm.

◆ idx_get() [2/2]

ASPOSE_PDF_SHARED_API System::SharedPtr<XForm> Aspose::Pdf::XFormCollection::idx_get ( System::String  name)

Returns XForm by its name. Exception is thrown if XForm with specified name is not found.

Parameters
nameName of the XForm.
Returns
Retrieved XForm.

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION()

Aspose::Pdf::XFormCollection::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( XFormCollection  ,
CODEPORTING_ARGS(System::SharedPtr< Resources > parent, System::SharedPtr< Engine::Data::IPdfDictionary > xObject)   
)
protected

◆ Remove()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::XFormCollection::Remove ( const System::SharedPtr< XForm > &  item)
overridevirtual

Deletes specified item from collection.

Parameters
itemThe object to delete
Returns
true if item was deleted from collection; otherwise, false.

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

Member Data Documentation

◆ Parent

System::SharedPtr<Resources> Aspose::Pdf::XFormCollection::Parent
protected

Resources where XForm objects are situated.