Aspose::Pdf::Annotations::ActionCollection Class Referencefinal

Collection of actions More...

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

Public Member Functions

int32_t get_Count () const
 Count of actions on the collection. More...
 
bool get_IsSynchronized ()
 Returns true if object is synchronized. More...
 
System::SharedPtr< System::Objectget_SyncRoot ()
 Gets synchronization object. More...
 
bool get_IsReadOnly () const
 Returns true if collection is readonly. More...
 
void Add (System::SharedPtr< PdfAction > const &action)
 Adds new action into colleciton. More...
 
void Delete (int32_t index)
 Removes action from collection by index. More...
 
void Delete ()
 Delete all actions. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< PdfAction >> array, int32_t index)
 Copies actions array into collection. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< PdfAction > > > GetEnumerator ()
 Returns enumerator for collection. More...
 
void Clear ()
 Clear collection. More...
 
bool Contains (System::SharedPtr< PdfAction > const &item) const
 Returns true if give item presents in the collection. More...
 
bool Remove (System::SharedPtr< PdfAction > const &item)
 Removes item from collection. More...
 
System::SharedPtr< PdfActionidx_get (int32_t index)
 Gets action by its index. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::PdfAction > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Annotations::PdfAction > > 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)
 

Protected Member Functions

 ActionCollection (System::SharedPtr< PdfAction > owner)
 
System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > createActions (System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable > trailer)
 
virtual ~ActionCollection ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::PdfAction > >
 ~IEnumerable () override
 Destructor. More...
 

Protected Attributes

System::SharedPtr< Aspose::Pdf::Engine::Data::IPdfPrimitive > _actions
 
System::WeakPtr< PdfAction_owner
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::PdfAction > >
typedef System::SharedPtr< Aspose::Pdf::Annotations::PdfActionValueType
 Value type name. More...
 
typedef ICollection< System::SharedPtr< Aspose::Pdf::Annotations::PdfAction > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::PdfAction > >
typedef IEnumerator< System::SharedPtr< Aspose::Pdf::Annotations::PdfAction > > 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...
 

Detailed Description

Collection of actions

Constructor & Destructor Documentation

◆ ActionCollection()

Aspose::Pdf::Annotations::ActionCollection::ActionCollection ( System::SharedPtr< PdfAction owner)
protected

◆ ~ActionCollection()

virtual Aspose::Pdf::Annotations::ActionCollection::~ActionCollection ( )
protectedvirtual

Member Function Documentation

◆ Add()

void Aspose::Pdf::Annotations::ActionCollection::Add ( System::SharedPtr< PdfAction > const &  action)
virtual

Adds new action into colleciton.

Parameters
actionAction which should be added.

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

◆ Clear()

void Aspose::Pdf::Annotations::ActionCollection::Clear ( )
virtual

◆ Contains()

bool Aspose::Pdf::Annotations::ActionCollection::Contains ( System::SharedPtr< PdfAction > const &  item) const
virtual

Returns true if give item presents in the collection.

Parameters
item
Returns

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

◆ CopyTo()

void Aspose::Pdf::Annotations::ActionCollection::CopyTo ( System::ArrayPtr< System::SharedPtr< PdfAction >>  array,
int32_t  index 
)

Copies actions array into collection.

Parameters
arrayArray of actions which must be copied into collection.
indexIndex starting from which array will be copied.

◆ createActions()

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfPrimitive> Aspose::Pdf::Annotations::ActionCollection::createActions ( System::SharedPtr< Aspose::Pdf::Engine::Data::ITrailerable >  trailer)
protected

◆ Delete() [1/2]

void Aspose::Pdf::Annotations::ActionCollection::Delete ( int32_t  index)

Removes action from collection by index.

Parameters
indexIndex of action to remove.

◆ Delete() [2/2]

void Aspose::Pdf::Annotations::ActionCollection::Delete ( )

Delete all actions.

◆ get_Count()

int32_t Aspose::Pdf::Annotations::ActionCollection::get_Count ( ) const
virtual

◆ get_IsReadOnly()

bool Aspose::Pdf::Annotations::ActionCollection::get_IsReadOnly ( ) const
virtual

◆ get_IsSynchronized()

bool Aspose::Pdf::Annotations::ActionCollection::get_IsSynchronized ( )

Returns true if object is synchronized.

◆ get_SyncRoot()

System::SharedPtr<System::Object> Aspose::Pdf::Annotations::ActionCollection::get_SyncRoot ( )

Gets synchronization object.

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<PdfAction> > > Aspose::Pdf::Annotations::ActionCollection::GetEnumerator ( )
virtual

◆ idx_get()

System::SharedPtr<PdfAction> Aspose::Pdf::Annotations::ActionCollection::idx_get ( int32_t  index)

Gets action by its index.

Parameters
indexIndex of action.
Returns
Retreived action.

◆ Remove()

bool Aspose::Pdf::Annotations::ActionCollection::Remove ( System::SharedPtr< PdfAction > const &  item)
virtual

Removes item from collection.

Parameters
itemItem to delete.
Returns

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

Member Data Documentation

◆ _actions

System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfPrimitive> Aspose::Pdf::Annotations::ActionCollection::_actions
protected

◆ _owner

System::WeakPtr<PdfAction> Aspose::Pdf::Annotations::ActionCollection::_owner
protected