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

ASPOSE_PDF_SHARED_API int32_t get_Count () const override=0
 Gets count. More...
 
ASPOSE_PDF_SHARED_API bool get_IsReadOnly () const override=0
 Gets a value indicating whether the collection is read-only. More...
 
virtual ASPOSE_PDF_SHARED_API int32_t get_VisibleCount ()=0
 Gets the total number of outline items at all levels in the document outline hierarchy. More...
 
ASPOSE_PDF_SHARED_API void Add (const System::SharedPtr< OutlineItemCollection > &item) override=0
 Adds outline item to collection. More...
 
ASPOSE_PDF_SHARED_API void Clear () override=0
 Clears all items from the collection. More...
 
ASPOSE_PDF_SHARED_API bool Contains (const System::SharedPtr< OutlineItemCollection > &item) const override=0
 Always throws NotImplementedException. More...
 
ASPOSE_PDF_SHARED_API void CopyTo (System::ArrayPtr< System::SharedPtr< OutlineItemCollection >> array, int32_t arrayIndex) override=0
 Copies the outline entries to an System.Array, starting at a particular System.Array index. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< OutlineItemCollection > > > GetEnumerator () override=0
 Returns an enumerator that iterates through the collection. More...
 
ASPOSE_PDF_SHARED_API bool Remove (const System::SharedPtr< OutlineItemCollection > &item) override=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
 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::OutlineItemCollection > >
System::SharedPtr< Aspose::Pdf::OutlineItemCollectionLINQ_ElementAt (int index)
 Returns the element at a specified index in a sequence. More...
 
System::SharedPtr< Aspose::Pdf::OutlineItemCollectionLINQ_First ()
 Returns the first element of a sequence. More...
 
System::SharedPtr< Aspose::Pdf::OutlineItemCollectionLINQ_First (const Func< System::SharedPtr< Aspose::Pdf::OutlineItemCollection >, bool > &predicate)
 Returns the first element of a sequence that satisfy the specified condition. More...
 
System::SharedPtr< Aspose::Pdf::OutlineItemCollectionLINQ_FirstOrDefault ()
 Returns the first element of a sequence, or a default value if the sequence is empty. More...
 
System::SharedPtr< Aspose::Pdf::OutlineItemCollectionLINQ_FirstOrDefault (std::function< bool(System::SharedPtr< Aspose::Pdf::OutlineItemCollection >)> 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::OutlineItemCollectionLINQ_Last ()
 Returns the last element of a sequence. More...
 
System::SharedPtr< Aspose::Pdf::OutlineItemCollectionLINQ_LastOrDefault ()
 Returns the last element of a sequence, or a default value if the sequence is empty. More...
 
SharedPtr< List< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > > > 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::OutlineItemCollection >, bool > &predicate)
 Returns the number of elements in the sequence that satisfy the specified condition. More...
 
System::ArrayPtr< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > > LINQ_ToArray ()
 Creates an array from a sequence. More...
 
bool LINQ_All (std::function< bool(System::SharedPtr< Aspose::Pdf::OutlineItemCollection >)> 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::OutlineItemCollection >)> predicate)
 Determines whether any element of a sequence exists or satisfies a condition. More...
 
SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > > > LINQ_Where (std::function< bool(System::SharedPtr< Aspose::Pdf::OutlineItemCollection >)> predicate)
 Filters a sequence based on the specified predicate. More...
 
bool LINQ_Contains (System::SharedPtr< Aspose::Pdf::OutlineItemCollection > 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::OutlineItemCollection > > > LINQ_OrderBy (const Func< System::SharedPtr< Aspose::Pdf::OutlineItemCollection >, 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::OutlineItemCollection > > > LINQ_OrderByDescending (const Func< System::SharedPtr< Aspose::Pdf::OutlineItemCollection >, 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::OutlineItemCollection >, ResultType > &selector)
 Transforms elements of a sequence. More...
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< System::SharedPtr< Aspose::Pdf::OutlineItemCollection >, 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::OutlineItemCollection > > > LINQ_Concat (SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > >> sequence)
 Concatenates two sequences. More...
 
System::SharedPtr< IEnumerable< System::SharedPtr< System::Linq::IGrouping< Key, System::SharedPtr< Aspose::Pdf::OutlineItemCollection > > > > > LINQ_GroupBy (System::Func< System::SharedPtr< Aspose::Pdf::OutlineItemCollection >, 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::OutlineItemCollection >, 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 () noexcept
 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 noexcept
 Gets iterator pointing to the first element (if any) of the const-qualified instance of the collection. More...
 
iterator end () noexcept
 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 noexcept
 Gets iterator pointing right after the last element (if any) of the const-qualified instance of the collection. More...
 
const_iterator cbegin () const noexcept
 Gets iterator pointing to the first const-qualified element (if any) of the collection. More...
 
const_iterator cend () const noexcept
 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

virtual void UpdateVisibleCount ()=0
 
virtual ASPOSE_PDF_SHARED_API ~Outlines ()
 
- Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > >
 ~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...
 

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...
 
using ValueType = System::SharedPtr< Aspose::Pdf::OutlineItemCollection >
 
using iterator = System::Details::VirtualizedIterator< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > >
 Iterator type. More...
 
using const_iterator = System::Details::VirtualizedConstIterator< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > >
 Const iterator type. More...
 
using virtualized_iterator = System::Details::VirtualizedIteratorBase< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > >
 Inner iterator base type. More...
 
using virtualized_iterator_element = System::SharedPtr< Aspose::Pdf::OutlineItemCollection >
 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 describes collection of outlines.

Constructor & Destructor Documentation

◆ ~Outlines()

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

Member Function Documentation

◆ Add()

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

Adds outline item to collection.

Parameters
itemThe 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()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Outlines::Clear ( )
overridepure virtual

◆ Contains()

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

Always throws NotImplementedException.

Parameters
itemThe object to locate in the collection
Returns
Exceptions
NotImplementedExceptionNotImplementedException

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

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

◆ CopyTo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::Outlines::CopyTo ( System::ArrayPtr< System::SharedPtr< OutlineItemCollection >>  array,
int32_t  arrayIndex 
)
overridepure 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.
arrayIndexThe zero-based index in array at which copying begins.

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

◆ get_Count()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::Outlines::get_Count ( ) const
overridepure virtual

◆ get_IsReadOnly()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::Outlines::get_IsReadOnly ( ) const
overridepure virtual

◆ get_VisibleCount()

virtual ASPOSE_PDF_SHARED_API 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()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<OutlineItemCollection> > > Aspose::Pdf::Outlines::GetEnumerator ( )
overridepure 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()

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

Remove outline collection item.

Parameters
itemItem to delete.
Returns
True - if item removed; otherwise, false.

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

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

◆ UpdateVisibleCount()

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