Aspose::Pdf::Outlines Class Referenceabstract

Class describes collection of outlines. More...

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

Inherited by Aspose::Pdf::OutlineCollection, and Aspose::Pdf::OutlineItemCollection.

Public Member Functions

virtual int32_t get_Count () const =0
 
virtual bool get_IsReadOnly () const =0
 Gets a value indicating whether the collection is read-only. More...
 
virtual int32_t get_VisibleCount ()=0
 Gets the total number of outline items at all levels in the document outline hierarchy. More...
 
virtual void Add (System::SharedPtr< OutlineItemCollection > const &item)=0
 Adds outline item to collection. More...
 
virtual void Clear ()=0
 Clears all items from the collection. More...
 
virtual bool Contains (System::SharedPtr< OutlineItemCollection > const &item) const =0
 Always throws NotImplementedException More...
 
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< OutlineItemCollection >> array, int32_t arrayIndex)=0
 Copies the outline entries to an System.Array, starting at a particular System.Array index. More...
 
virtual System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< OutlineItemCollection > > > GetEnumerator ()=0
 Returns an enumerator that iterates through the collection. More...
 
virtual bool Remove (System::SharedPtr< OutlineItemCollection > const &item)=0
 Remove outline collection item. More...
 
- Public Member Functions inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > >
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > > 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

virtual void UpdateVisibleCount ()=0
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::ICollection< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > >
typedef System::SharedPtr< Aspose::Pdf::OutlineItemCollectionValueType
 Value type name. More...
 
typedef ICollection< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > > ThisType
 Collection type name. More...
 
- Public Types inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > >
typedef IEnumerator< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > > 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 describes collection of outlines.

Member Function Documentation

◆ Add()

virtual void Aspose::Pdf::Outlines::Add ( System::SharedPtr< OutlineItemCollection > const &  item)
pure virtual

Adds outline item to collection.

Parameters
outlineThe outline item to be added.

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

Implemented in Aspose::Pdf::OutlineItemCollection, and Aspose::Pdf::OutlineCollection.

◆ Clear()

virtual void Aspose::Pdf::Outlines::Clear ( )
pure virtual

◆ Contains()

virtual bool Aspose::Pdf::Outlines::Contains ( System::SharedPtr< OutlineItemCollection > const &  item) const
pure virtual

Always throws NotImplementedException

Parameters
itemThe object to locate in the collection

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

Implemented in Aspose::Pdf::OutlineItemCollection, and Aspose::Pdf::OutlineCollection.

◆ CopyTo()

virtual void Aspose::Pdf::Outlines::CopyTo ( System::ArrayPtr< System::SharedPtr< OutlineItemCollection >>  array,
int32_t  arrayIndex 
)
pure virtual

Copies the outline entries to an System.Array, starting at a particular System.Array index.

Parameters
arrayThe one-dimensional System.Array that is the destination. Must have zero-based indexing.
indexThe zero-based index in array at which copying begins.

Implemented in Aspose::Pdf::OutlineItemCollection, and Aspose::Pdf::OutlineCollection.

◆ get_Count()

virtual int32_t Aspose::Pdf::Outlines::get_Count ( ) const
pure virtual

◆ get_IsReadOnly()

virtual bool Aspose::Pdf::Outlines::get_IsReadOnly ( ) const
pure virtual

◆ get_VisibleCount()

virtual int32_t Aspose::Pdf::Outlines::get_VisibleCount ( )
pure virtual

Gets the total number of outline items at all levels in the document outline hierarchy.

Implemented in Aspose::Pdf::OutlineItemCollection, and Aspose::Pdf::OutlineCollection.

◆ GetEnumerator()

virtual System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<OutlineItemCollection> > > Aspose::Pdf::Outlines::GetEnumerator ( )
pure virtual

Returns an enumerator that iterates through the collection.

Returns
An System.Collections.IEnumerator object that can be used to iterate through the collection.

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

Implemented in Aspose::Pdf::OutlineItemCollection, and Aspose::Pdf::OutlineCollection.

◆ Remove()

virtual bool Aspose::Pdf::Outlines::Remove ( System::SharedPtr< OutlineItemCollection > const &  item)
pure virtual

◆ UpdateVisibleCount()

virtual void Aspose::Pdf::Outlines::UpdateVisibleCount ( )
protectedpure virtual