Represents document outline hierarchy. More...

Inherits Aspose::Pdf::Outlines.

Classes

class  OutlinesEnumerator
 
class  OutlinesEnumeratorUnrestricted
 

Public Member Functions

ASPOSE_PDF_SHARED_API int32_t get_VisibleCount () override
 Count is the sum of the number of visible descendent outline items at all levels. Note: please don't confuse with Count which is number if items in collection. More...
 
ASPOSE_PDF_SHARED_API int32_t get_Count () const override
 Count of collection items. Please dont confuse with VisibleCount: VisibleCount gets number of visible outline item on all levels. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< OutlineItemCollectionget_First () const
 Gets an outline item representing the first top-level item in the outline. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< OutlineItemCollectionget_Last ()
 Gets an outline item representing the last top-level item in the outline. More...
 
ASPOSE_PDF_SHARED_API bool get_IsSynchronized ()
 Gets a value indicating whether access to this collection is synchronized (thread safe). More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< System::Objectget_SyncRoot () const
 Gets an object that can be used to synchronize access to this collection. More...
 
ASPOSE_PDF_SHARED_API bool get_IsReadOnly () const override
 Gets a value indicating whether the collection is read-only. More...
 
ASPOSE_PDF_SHARED_API void Add (const System::SharedPtr< OutlineItemCollection > &outline) override
 Adds outline item to collection. More...
 
ASPOSE_PDF_SHARED_API void Delete ()
 Deletes all outline items from the document outline. More...
 
ASPOSE_PDF_SHARED_API void Delete (System::String name)
 Deletes the outline item with specified title from the document outline. More...
 
ASPOSE_PDF_SHARED_API void CopyTo (System::ArrayPtr< System::SharedPtr< OutlineItemCollection >> array, int32_t index) override
 Copies the outline items 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
 Returns an enumerator that iterates through the collection. More...
 
ASPOSE_PDF_SHARED_API void Clear () override
 Clears all items from the collection. More...
 
ASPOSE_PDF_SHARED_API bool Contains (const System::SharedPtr< OutlineItemCollection > &item) const override
 Checks does collection contains given item. More...
 
ASPOSE_PDF_SHARED_API bool Remove (const System::SharedPtr< OutlineItemCollection > &item) override
 Always throws
Exceptions
NotImplementedExceptionNotImplementedException
More...
 
ASPOSE_PDF_SHARED_API void Remove (int32_t index)
 Remove item by index. More...
 
ASPOSE_PDF_SHARED_API System::SharedPtr< OutlineItemCollectionidx_get (int32_t index)
 Gets outline item from collection by index. 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

bool get_IsEmpty ()
 Returns true if outlines is empty. More...
 
 OutlineCollection (System::SharedPtr< Document > document)
 Initializes a new instance of OutlineCollection class using document object. More...
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (OutlineCollection, CODEPORTING_ARGS(System::SharedPtr< Document > document))
 
void Add (System::SharedPtr< OutlineItemCollection > outline, bool updateData)
 Add new bookmark. More...
 
void UpdateLast ()
 
System::SharedPtr< Engine::Data::IPdfObject > GetOutlinesObject () const
 
ASPOSE_PDF_SHARED_API void UpdateVisibleCount () override
 
 OutlineCollection (System::SharedPtr< Engine::IPdfDocument > document)
 
 MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION (OutlineCollection, CODEPORTING_ARGS(System::SharedPtr< Engine::IPdfDocument > document))
 
virtual ASPOSE_PDF_SHARED_API ~OutlineCollection ()
 
- Protected Member Functions inherited from Aspose::Pdf::Outlines
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...
 

Static Protected Member Functions

static void Delete (System::SharedPtr< Engine::Data::IPdfDictionary > outlines, System::String name)
 Deletes the outline item with specified title from the specified OutlineCollection instance. More...
 
static void Remove (System::SharedPtr< Engine::Data::IPdfObject > parent, System::SharedPtr< Engine::Data::IPdfObject > prev, System::SharedPtr< Engine::Data::IPdfObject > item, System::SharedPtr< Engine::Data::IPdfObject > next)
 

Protected Attributes

System::WeakPtr< Engine::IPdfDocument > document
 Document instance. 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

Represents document outline hierarchy.

Constructor & Destructor Documentation

◆ OutlineCollection() [1/2]

Aspose::Pdf::OutlineCollection::OutlineCollection ( System::SharedPtr< Document document)
protected

Initializes a new instance of OutlineCollection class using document object.

Parameters
documentDocument instance.

◆ OutlineCollection() [2/2]

Aspose::Pdf::OutlineCollection::OutlineCollection ( System::SharedPtr< Engine::IPdfDocument >  document)
protected

◆ ~OutlineCollection()

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

Member Function Documentation

◆ Add() [1/2]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::OutlineCollection::Add ( const System::SharedPtr< OutlineItemCollection > &  outline)
overridevirtual

Adds outline item to collection.

Parameters
outlineThe outline item to be added.

Implements Aspose::Pdf::Outlines.

◆ Add() [2/2]

void Aspose::Pdf::OutlineCollection::Add ( System::SharedPtr< OutlineItemCollection outline,
bool  updateData 
)
protected

Add new bookmark.

Parameters
outlineBookmark.
updateDataIf true, required data validation (last and count) will be performed. This should be false for massive operations (when set of multiple bookmarks are added) for performance reasons.

◆ Clear()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::OutlineCollection::Clear ( )
overridevirtual

Clears all items from the collection.

Implements Aspose::Pdf::Outlines.

◆ Contains()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::OutlineCollection::Contains ( const System::SharedPtr< OutlineItemCollection > &  item) const
overridevirtual

Checks does collection contains given item.

Parameters
itemThe object to locate in the collection
Returns
True - if item found; otherwise, false.

Implements Aspose::Pdf::Outlines.

◆ CopyTo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::OutlineCollection::CopyTo ( System::ArrayPtr< System::SharedPtr< OutlineItemCollection >>  array,
int32_t  index 
)
overridevirtual

Copies the outline items 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.

Implements Aspose::Pdf::Outlines.

◆ Delete() [1/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::OutlineCollection::Delete ( )

Deletes all outline items from the document outline.

◆ Delete() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::OutlineCollection::Delete ( System::String  name)

Deletes the outline item with specified title from the document outline.

Parameters
nameThe title of outline item to be deleted

◆ Delete() [3/3]

static void Aspose::Pdf::OutlineCollection::Delete ( System::SharedPtr< Engine::Data::IPdfDictionary >  outlines,
System::String  name 
)
staticprotected

Deletes the outline item with specified title from the specified OutlineCollection instance.

Parameters
outlinesOutlineCollection instance
nameThe title of outline item to be deleted.

◆ get_Count()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::OutlineCollection::get_Count ( ) const
overridevirtual

Count of collection items. Please dont confuse with VisibleCount: VisibleCount gets number of visible outline item on all levels.

Implements Aspose::Pdf::Outlines.

◆ get_First()

ASPOSE_PDF_SHARED_API System::SharedPtr<OutlineItemCollection> Aspose::Pdf::OutlineCollection::get_First ( ) const

Gets an outline item representing the first top-level item in the outline.

◆ get_IsEmpty()

bool Aspose::Pdf::OutlineCollection::get_IsEmpty ( )
protected

Returns true if outlines is empty.

◆ get_IsReadOnly()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::OutlineCollection::get_IsReadOnly ( ) const
overridevirtual

Gets a value indicating whether the collection is read-only.

Implements Aspose::Pdf::Outlines.

◆ get_IsSynchronized()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::OutlineCollection::get_IsSynchronized ( )

Gets a value indicating whether access to this collection is synchronized (thread safe).

◆ get_Last()

ASPOSE_PDF_SHARED_API System::SharedPtr<OutlineItemCollection> Aspose::Pdf::OutlineCollection::get_Last ( )

Gets an outline item representing the last top-level item in the outline.

◆ get_SyncRoot()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Object> Aspose::Pdf::OutlineCollection::get_SyncRoot ( ) const

Gets an object that can be used to synchronize access to this collection.

◆ get_VisibleCount()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::OutlineCollection::get_VisibleCount ( )
overridevirtual

Count is the sum of the number of visible descendent outline items at all levels. Note: please don't confuse with Count which is number if items in collection.

Implements Aspose::Pdf::Outlines.

◆ GetEnumerator()

ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<OutlineItemCollection> > > Aspose::Pdf::OutlineCollection::GetEnumerator ( )
overridevirtual

Returns an enumerator that iterates through the collection.

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

Returns an enumerator that iterates through the collection.

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

Implements Aspose::Pdf::Outlines.

◆ GetOutlinesObject()

System::SharedPtr<Engine::Data::IPdfObject> Aspose::Pdf::OutlineCollection::GetOutlinesObject ( ) const
protected

◆ idx_get()

ASPOSE_PDF_SHARED_API System::SharedPtr<OutlineItemCollection> Aspose::Pdf::OutlineCollection::idx_get ( int32_t  index)

Gets outline item from collection by index.

Parameters
indexIndex of requested item.
Returns

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [1/2]

Aspose::Pdf::OutlineCollection::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( OutlineCollection  ,
CODEPORTING_ARGS(System::SharedPtr< Document > document  
)
protected

◆ MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION() [2/2]

Aspose::Pdf::OutlineCollection::MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION ( OutlineCollection  ,
CODEPORTING_ARGS(System::SharedPtr< Engine::IPdfDocument > document  
)
protected

◆ Remove() [1/3]

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::OutlineCollection::Remove ( const System::SharedPtr< OutlineItemCollection > &  item)
overridevirtual

Always throws

Exceptions
NotImplementedExceptionNotImplementedException
Parameters
itemThe object to locate in the collection
Returns
Exceptions
NotImplementedExceptionNotImplementedException

Implements Aspose::Pdf::Outlines.

◆ Remove() [2/3]

ASPOSE_PDF_SHARED_API void Aspose::Pdf::OutlineCollection::Remove ( int32_t  index)

Remove item by index.

Parameters
indexIndex of the item to be removed.

◆ Remove() [3/3]

static void Aspose::Pdf::OutlineCollection::Remove ( System::SharedPtr< Engine::Data::IPdfObject >  parent,
System::SharedPtr< Engine::Data::IPdfObject >  prev,
System::SharedPtr< Engine::Data::IPdfObject >  item,
System::SharedPtr< Engine::Data::IPdfObject >  next 
)
staticprotected

◆ UpdateLast()

void Aspose::Pdf::OutlineCollection::UpdateLast ( )
protected

◆ UpdateVisibleCount()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::OutlineCollection::UpdateVisibleCount ( )
overrideprotectedvirtual

Implements Aspose::Pdf::Outlines.

Member Data Documentation

◆ document

System::WeakPtr<Engine::IPdfDocument> Aspose::Pdf::OutlineCollection::document
protected

Document instance.