Aspose::Pdf::ArtifactCollection Class Reference

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

Public Member Functions

bool get_IsSynchronized ()
 Is this object synchronized. More...
 
int32_t get_Count () const
 Gets count of artifacts in collection. More...
 
System::SharedPtr< System::Objectget_SyncRoot ()
 Gets synchronization object of the collection. More...
 
bool get_IsReadOnly () const
 Gets if collection is readonly. Always returns false. More...
 
void CopyTo (System::ArrayPtr< System::SharedPtr< Artifact >> dest, int32_t index)
 Copies colection into an array. More...
 
System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< Artifact > > > GetEnumerator ()
 Gets enumerator for the collection. More...
 
System::SharedPtr< Artifactidx_get (int32_t index)
 Gets artifact by index. Index is started from 1. More...
 
void Add (System::SharedPtr< Artifact > const &artifact)
 Adds artifacts to the collection. More...
 
System::SharedPtr< System::Collections::Generic::List< System::SharedPtr< Artifact > > > FindByValue (System::String name, System::String expectedValue)
 Finds artifacts by custom value. More...
 
void Delete (System::SharedPtr< Artifact > artifact)
 Deletes specified artifact. More...
 
void Update (System::SharedPtr< Artifact > artifact)
 Update artifact inside the collection. More...
 
void Delete (int32_t index)
 Deletes artifact by its index. More...
 
void Clear ()
 Clears collection. Method is not supported. More...
 
bool Contains (System::SharedPtr< Artifact > const &item) const
 Checks if collection contains specified artifact. More...
 
bool Remove (System::SharedPtr< Artifact > const &item)
 Deletes specified artifact. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::Artifact > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::Artifact > > 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

System::SharedPtr< Aspose::Pdf::Pageget_Page ()
 
 ArtifactCollection (System::SharedPtr< Aspose::Pdf::Page > page)
 

Additional Inherited Members

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

Constructor & Destructor Documentation

◆ ArtifactCollection()

Aspose::Pdf::ArtifactCollection::ArtifactCollection ( System::SharedPtr< Aspose::Pdf::Page page)
protected

Member Function Documentation

◆ Add()

void Aspose::Pdf::ArtifactCollection::Add ( System::SharedPtr< Artifact > const &  artifact)
virtual

Adds artifacts to the collection.

Parameters
artifactArtifact which sould be added to collection.

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

◆ Clear()

void Aspose::Pdf::ArtifactCollection::Clear ( )
virtual

Clears collection. Method is not supported.

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

◆ Contains()

bool Aspose::Pdf::ArtifactCollection::Contains ( System::SharedPtr< Artifact > const &  item) const
virtual

Checks if collection contains specified artifact.

Parameters
itemArtifact to search.

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

◆ CopyTo()

void Aspose::Pdf::ArtifactCollection::CopyTo ( System::ArrayPtr< System::SharedPtr< Artifact >>  dest,
int32_t  index 
)

Copies colection into an array.

Parameters
destDestination array.
indexStarting index.

◆ Delete() [1/2]

void Aspose::Pdf::ArtifactCollection::Delete ( System::SharedPtr< Artifact artifact)

Deletes specified artifact.

Parameters
artifactArtifact which will be deleted.

◆ Delete() [2/2]

void Aspose::Pdf::ArtifactCollection::Delete ( int32_t  index)

Deletes artifact by its index.

Parameters
indexIndex of artifact to delete.

◆ FindByValue()

System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Artifact> > > Aspose::Pdf::ArtifactCollection::FindByValue ( System::String  name,
System::String  expectedValue 
)

Finds artifacts by custom value.

Parameters
nameName of custom value.
expectedValueValue to find.
Returns
List of found artifacts.

◆ get_Count()

int32_t Aspose::Pdf::ArtifactCollection::get_Count ( ) const
virtual

◆ get_IsReadOnly()

bool Aspose::Pdf::ArtifactCollection::get_IsReadOnly ( ) const
virtual

Gets if collection is readonly. Always returns false.

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

◆ get_IsSynchronized()

bool Aspose::Pdf::ArtifactCollection::get_IsSynchronized ( )

Is this object synchronized.

◆ get_Page()

System::SharedPtr<Aspose::Pdf::Page> Aspose::Pdf::ArtifactCollection::get_Page ( )
protected

◆ get_SyncRoot()

System::SharedPtr<System::Object> Aspose::Pdf::ArtifactCollection::get_SyncRoot ( )

Gets synchronization object of the collection.

◆ GetEnumerator()

System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<Artifact> > > Aspose::Pdf::ArtifactCollection::GetEnumerator ( )
virtual

Gets enumerator for the collection.

Returns
Enumerator object.

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

◆ idx_get()

System::SharedPtr<Artifact> Aspose::Pdf::ArtifactCollection::idx_get ( int32_t  index)

Gets artifact by index. Index is started from 1.

Parameters
indexIndex of the artifact.
Returns
Artifact on the page.

◆ Remove()

bool Aspose::Pdf::ArtifactCollection::Remove ( System::SharedPtr< Artifact > const &  item)
virtual

Deletes specified artifact.

Parameters
itemArtifact which will be deleted.

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

◆ Update()

void Aspose::Pdf::ArtifactCollection::Update ( System::SharedPtr< Artifact artifact)

Update artifact inside the collection.

Parameters
artifactArtifact to be updated.