Aspose::Pdf::Annotations::AnnotationCollection Class Referencefinal

Class representing annotation collection. More...

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

Public Member Functions

bool get_IsSynchronized ()
 Gets a value indicating whether access to the Aspose.Pdf.Annotations.AnnotationCollection is synchronized (thread safe). More...
 
System::SharedPtr< System::Objectget_SyncRoot ()
 Gets an object that can be used to synchronize access to Aspose.Pdf.Annotations.AnnotationCollection. More...
 
int32_t get_Count () const
 Gets count of annotations in collection. More...
 
bool get_IsReadOnly () const
 Gets a value indicating if collection is readonly. More...
 
void Add (System::SharedPtr< Annotation > annotation, bool considerRotation)
 Adds annotation to the collection. If page is rotated then annotation rectangle will be recalculated accordingly. More...
 
void Add (System::SharedPtr< Annotation > const &annotation)
 Adds annotation to the collection. More...
 
void Delete (int32_t index)
 Deletes annotation from the collection by index. More...
 
void Delete ()
 Deletes all annotations from the collection. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< Annotation >> array, int32_t index)
 Copies array of annotations into collection. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Annotation > > > GetEnumerator ()
 Returns collection enumerator. More...
 
void Accept (System::SharedPtr< AnnotationSelector > visitor)
 Accepts visitor to process annotation. More...
 
void Delete (System::SharedPtr< Annotation > annotation)
 Deletes specified annotation from the collection. More...
 
void Clear ()
 Deletes all annotations from the collection. More...
 
bool Contains (System::SharedPtr< Annotation > const &annotation) const
 Checks if specified annotation belong to collection. More...
 
bool Remove (System::SharedPtr< Annotation > const &annotation)
 Deletes specified annotation from the collection. More...
 
System::SharedPtr< Annotationidx_get (int32_t index)
 The index of the element to get. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Annotations::Annotation > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Annotations::Annotation > > 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

void assert_ ()
 
 AnnotationCollection (System::SharedPtr< Page > page)
 Constructor of AnnotationCollection. Creates annotation collection for annotations on the given page. More...
 
virtual ~AnnotationCollection ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::Annotations::Annotation > >
 ~IEnumerable () override
 Destructor. More...
 

Protected Attributes

System::SharedPtr< Aspose::Pdf::Engine::CommonData::IPage > page
 

Additional Inherited Members

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

Class representing annotation collection.

Constructor & Destructor Documentation

◆ AnnotationCollection()

Aspose::Pdf::Annotations::AnnotationCollection::AnnotationCollection ( System::SharedPtr< Page page)
protected

Constructor of AnnotationCollection. Creates annotation collection for annotations on the given page.

Parameters
pageParent page of annotations.

◆ ~AnnotationCollection()

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

Member Function Documentation

◆ Accept()

void Aspose::Pdf::Annotations::AnnotationCollection::Accept ( System::SharedPtr< AnnotationSelector visitor)

Accepts visitor to process annotation.

Parameters
visitorAnnotation selector object.

◆ Add() [1/2]

void Aspose::Pdf::Annotations::AnnotationCollection::Add ( System::SharedPtr< Annotation annotation,
bool  considerRotation 
)

Adds annotation to the collection. If page is rotated then annotation rectangle will be recalculated accordingly.

Parameters
annotationAnnotation which shall be added.
considerRotationIf true and if page is rotated then annotation position will be recaculated accroding to page rotation.

◆ Add() [2/2]

void Aspose::Pdf::Annotations::AnnotationCollection::Add ( System::SharedPtr< Annotation > const &  annotation)
virtual

Adds annotation to the collection.

Parameters
annotationAnnotation which shall be added.

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

◆ assert_()

void Aspose::Pdf::Annotations::AnnotationCollection::assert_ ( )
protected

◆ Clear()

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

◆ Contains()

bool Aspose::Pdf::Annotations::AnnotationCollection::Contains ( System::SharedPtr< Annotation > const &  annotation) const
virtual

Checks if specified annotation belong to collection.

Parameters
annotationAnnotation to be searched.

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

◆ CopyTo()

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

Copies array of annotations into collection.

Parameters
arrayArray to copy into collection.
indexStarting index where colleciton wil lbe copied.

◆ Delete() [1/3]

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

Deletes annotation from the collection by index.

Parameters
indexIndex of annotation which shall be deleted.

◆ Delete() [2/3]

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

Deletes all annotations from the collection.

◆ Delete() [3/3]

void Aspose::Pdf::Annotations::AnnotationCollection::Delete ( System::SharedPtr< Annotation annotation)

Deletes specified annotation from the collection.

Parameters
annotationAnnotation which shall be deleted.

◆ get_Count()

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

◆ get_IsReadOnly()

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

Gets a value indicating if collection is readonly.

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

◆ get_IsSynchronized()

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

Gets a value indicating whether access to the Aspose.Pdf.Annotations.AnnotationCollection is synchronized (thread safe).

◆ get_SyncRoot()

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

Gets an object that can be used to synchronize access to Aspose.Pdf.Annotations.AnnotationCollection.

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<Annotation> > > Aspose::Pdf::Annotations::AnnotationCollection::GetEnumerator ( )
virtual

Returns collection enumerator.

Returns
Enumerator object

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

◆ idx_get()

System::SharedPtr<Annotation> Aspose::Pdf::Annotations::AnnotationCollection::idx_get ( int32_t  index)

The index of the element to get.

Parameters
indexThe index value started from one.
Returns
Annotation object

◆ Remove()

bool Aspose::Pdf::Annotations::AnnotationCollection::Remove ( System::SharedPtr< Annotation > const &  annotation)
virtual

Deletes specified annotation from the collection.

Parameters
annotationAnnotation which shall be deleted.

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

Member Data Documentation

◆ page

System::SharedPtr<Aspose::Pdf::Engine::CommonData::IPage> Aspose::Pdf::Annotations::AnnotationCollection::page
protected