Represents document outline hierarchy. More...

Inherits Aspose::Pdf::Outlines.

Classes
class	OutlinesEnumerator

Public Member Functions
virtual int32_t	get_VisibleCount ()
	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...

virtual int32_t	get_Count () const
	Count of collection items. Please dont confuse with VisibleCount: VisibleCount gets number of visible outline item on all levels. More...

System::SharedPtr< OutlineItemCollection >	get_First () const
	Gets an outline item representing the first top-level item in the outline. More...

System::SharedPtr< OutlineItemCollection >	get_Last ()
	Gets an outline item representing the last top-level item in the outline. More...

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

System::SharedPtr< System::Object >	get_SyncRoot () const
	Gets an object that can be used to synchronize access to this collection. More...

virtual bool	get_IsReadOnly () const
	Gets a value indicating whether the collection is read-only. More...

virtual void	Add (System::SharedPtr< OutlineItemCollection > const &outline)
	Adds outline item to collection. More...

void	Delete ()
	Deletes all outline items from the document outline. More...

void	Delete (System::String name)
	Deletes the outline item with specified title from the document outline. More...

virtual void	CopyTo (System::ArrayPtr< System::SharedPtr< OutlineItemCollection >> array, int32_t index)
	Copies the outline items to an System.Array, starting at a particular System.Array index. More...

virtual System::SharedPtr< System::Collections::Generic::IEnumerator< System::SharedPtr< OutlineItemCollection > > >	GetEnumerator ()
	Returns an enumerator that iterates through the collection. More...

virtual void	Clear ()
	Clears all items from the collection. More...

virtual bool	Contains (System::SharedPtr< OutlineItemCollection > const &item) const
	Checks does collection contains given item. More...

virtual bool	Remove (System::SharedPtr< OutlineItemCollection > const &item)
	Always throws NotImplementedException More...

void	Remove (int32_t index)
	Remove item by index. More...

System::SharedPtr< OutlineItemCollection >	idx_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

ICollection &	operator= (ICollection &&)

ICollection &	operator= (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::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > >
System::SharedPtr< Aspose::Pdf::OutlineItemCollection >	LINQ_ElementAt (int index)

System::SharedPtr< Aspose::Pdf::OutlineItemCollection >	LINQ_First ()

System::SharedPtr< Aspose::Pdf::OutlineItemCollection >	LINQ_FirstOrDefault ()

System::SharedPtr< Aspose::Pdf::OutlineItemCollection >	LINQ_FirstOrDefault (std::function< bool(System::SharedPtr< Aspose::Pdf::OutlineItemCollection >)> predicate)

System::SharedPtr< Aspose::Pdf::OutlineItemCollection >	LINQ_Last ()

System::SharedPtr< Aspose::Pdf::OutlineItemCollection >	LINQ_LastOrDefault ()

SharedPtr< List< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > > >	LINQ_ToList ()

int	LINQ_Count ()

System::ArrayPtr< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > >	LINQ_ToArray ()

bool	LINQ_All (std::function< bool(System::SharedPtr< Aspose::Pdf::OutlineItemCollection >)> predicate)

bool	LINQ_Any ()

bool	LINQ_Any (std::function< bool(System::SharedPtr< Aspose::Pdf::OutlineItemCollection >)> predicate)

SharedPtr< IEnumerable< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > > >	LINQ_Where (std::function< bool(System::SharedPtr< Aspose::Pdf::OutlineItemCollection >)> predicate)

bool	LINQ_Contains (System::SharedPtr< Aspose::Pdf::OutlineItemCollection > value)

SharedPtr< IEnumerable< ResultType > >	LINQ_Cast ()

SharedPtr< IEnumerable< Result > >	LINQ_Cast ()

SharedPtr< IEnumerable< ResultType > >	LINQ_OfType ()

SharedPtr< IEnumerable< Result > >	LINQ_OfType ()

SharedPtr< IEnumerable< ResultType > >	LINQ_Select (const Func< System::SharedPtr< Aspose::Pdf::OutlineItemCollection >, ResultType > &selector)

SharedPtr< IEnumerable< Result > >	LINQ_Select (const Func< Source, Result > &selector)

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...

Object &	operator= (Object const &x)
	Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...

Object *	SharedRefAdded ()
	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 () 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 TypeInfo &	GetType () 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
	OutlineCollection (System::SharedPtr< Document > document)
	Initializes a new instance of OutlineCollection class using document object. More...

System::SharedPtr< Engine::Data::IPdfObject >	createOutlines (System::SharedPtr< Engine::Data::ITrailerable > trailer) const

virtual void	UpdateVisibleCount ()

	OutlineCollection (System::SharedPtr< Engine::IPdfDocument > document)

virtual	~OutlineCollection ()

Protected Member Functions inherited from System::Collections::Generic::IEnumerable< System::SharedPtr< Aspose::Pdf::OutlineItemCollection > >
	~IEnumerable () override
	Destructor. 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::OutlineItemCollection >	ValueType
	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 >

Public Types inherited from System::Object
typedef SmartPtr< Object >	ptr
	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 TypeInfo &	Type ()
	Impleemnts 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

document Document instance.

◆ OutlineCollection() [2/2]

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

protected

◆ ~OutlineCollection()

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

protectedvirtual

Member Function Documentation

◆ Add()

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

virtual

Adds outline item to collection.

Parameters

outline The outline item to be added.

Implements Aspose::Pdf::Outlines.

◆ Clear()

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

virtual

Clears all items from the collection.

Implements Aspose::Pdf::Outlines.

◆ Contains()

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

virtual

Checks does collection contains given item.

Parameters

item	The object to locate in the collection

Implements Aspose::Pdf::Outlines.

◆ CopyTo()

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

virtual

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

Parameters

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

Implements Aspose::Pdf::Outlines.

◆ createOutlines()

System::SharedPtr<Engine::Data::IPdfObject> Aspose::Pdf::OutlineCollection::createOutlines ( System::SharedPtr< Engine::Data::ITrailerable > trailer ) const

protected

◆ Delete() [1/3]

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

Deletes all outline items from the document outline.

◆ Delete() [2/3]

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

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

Parameters

name	The 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

outlines	OutlineCollection instance
name	The title of outline item to be deleted.

◆ get_Count()

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

virtual

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

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

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

◆ get_IsReadOnly()

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

virtual

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

Implements Aspose::Pdf::Outlines.

◆ get_IsSynchronized()

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

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

◆ get_Last()

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

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

◆ get_SyncRoot()

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

virtual int32_t Aspose::Pdf::OutlineCollection::get_VisibleCount ( )

virtual

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

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

virtual

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.

◆ idx_get()

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

Gets outline item from collection by index.

Parameters

index Index of requested item.

Returns

◆ Remove() [1/3]

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

virtual

Always throws NotImplementedException

Parameters

item	The object to locate in the collection

Implements Aspose::Pdf::Outlines.

◆ Remove() [2/3]

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

Remove item by index.

Parameters

index Index 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

◆ UpdateVisibleCount()

virtual void Aspose::Pdf::OutlineCollection::UpdateVisibleCount ( )

protectedvirtual

Implements Aspose::Pdf::Outlines.

Member Data Documentation

◆ document

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

protected

Document instance.

Classes

Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ OutlineCollection() [1/2]

◆ OutlineCollection() [2/2]

◆ ~OutlineCollection()

Member Function Documentation

◆ Add()

◆ Clear()

◆ Contains()

◆ CopyTo()

◆ createOutlines()

◆ Delete() [1/3]

◆ Delete() [2/3]

◆ Delete() [3/3]

◆ get_Count()

◆ get_First()

◆ get_IsReadOnly()

◆ get_IsSynchronized()

◆ get_Last()

◆ get_SyncRoot()

◆ get_VisibleCount()

◆ GetEnumerator()

◆ idx_get()

◆ Remove() [1/3]

◆ Remove() [2/3]

◆ Remove() [3/3]

◆ UpdateVisibleCount()

Member Data Documentation

◆ document