Aspose::Pdf::OutlineItemCollection Class Referencefinal

Represents outline entry in outline hierarchy of PDF document. More...

Inherits Aspose::Pdf::Outlines.

Public Member Functions

System::String get_Title ()
 Gets the title for this outline item. More...
 
void set_Title (System::String value)
 Sets the title for this outline item. More...
 
System::SharedPtr< Annotations::IAppointmentget_Destination ()
 Gets the destination for this outline item. More...
 
void set_Destination (System::SharedPtr< Annotations::IAppointment > value)
 Sets the destination for this outline item. More...
 
System::SharedPtr< Annotations::PdfActionget_Action ()
 Gets the action for this outline item. More...
 
void set_Action (System::SharedPtr< Annotations::PdfAction > value)
 Sets the action for this outline item. More...
 
System::Drawing::Color get_Color ()
 Gets the color for the title text of this outline item. More...
 
void set_Color (System::Drawing::Color value)
 Sets the color for the title text of this outline item. More...
 
bool get_Italic ()
 Gets italic flag for the title text of this outline item More...
 
void set_Italic (bool value)
 Sets italic flag for the title text of this outline item More...
 
bool get_Bold ()
 Gets bold flag for the title text of this outline item More...
 
void set_Bold (bool value)
 Sets bold flag for the title text of this outline item More...
 
System::SharedPtr< OutlineItemCollectionget_First () const
 Gets the outline item representing the first top-level item in the outline hierarchy. More...
 
System::SharedPtr< OutlineItemCollectionget_Last ()
 Gets the outline item representing the last top-level item in the outline hierarchy. More...
 
System::SharedPtr< OutlineItemCollectionget_Prev ()
 Gets the outline item representing previous item relatively this item in the outline hierarchy. More...
 
System::SharedPtr< OutlineItemCollectionget_Next ()
 Gets the outline item representing next item relatively this item in the outline hierarchy. More...
 
bool get_HasNext ()
 Check if outline item representing next item relatively this item in the outline hierarchy. More...
 
System::SharedPtr< Outlinesget_Parent ()
 Gets the parent object of this outline item in the outline hierarchy. More...
 
virtual int32_t get_VisibleCount ()
 Gets the total number of outline items at all levels in the document outline hierarchy. More...
 
bool get_IsSynchronized ()
 Gets the value indicating whether access to this collection is synchronized (thread safe). More...
 
System::SharedPtr< System::Objectget_SyncRoot ()
 Gets the 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...
 
bool get_Open ()
 Get or sets open status (true/false) for outline item. More...
 
void set_Open (bool value)
 Get or sets open status (true/false) for outline item. 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...
 
int32_t get_Level ()
 Gets hierarchy level of outline item. More...
 
void Delete ()
 Deletes this outline item from the document outline hierarchy. More...
 
 OutlineItemCollection (System::SharedPtr< OutlineCollection > outlines)
 Initializes outline item instance using root hierarchy object. More...
 
void Delete (System::String name)
 Deletes outline entry with specified name from the document outline hierarchy. More...
 
virtual void CopyTo (System::ArrayPtr< System::SharedPtr< OutlineItemCollection >> array, int32_t index)
 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 ()
 Returns an enumerator that iterates through the collection. More...
 
virtual void Add (System::SharedPtr< OutlineItemCollection > const &outline)
 Adds outline item to collection. More...
 
void Insert (int32_t index, System::SharedPtr< OutlineItemCollection > outline)
 Inserts the outline item into collection at the specified place. More...
 
virtual void Clear ()
 Clears all items from the collection. More...
 
virtual bool Contains (System::SharedPtr< OutlineItemCollection > const &item) const
 Checks if collection contains given item. More...
 
virtual bool Remove (System::SharedPtr< OutlineItemCollection > const &item)
 Remove outline collection item. More...
 
void Remove (int32_t index)
 Remove item by index. More...
 
System::SharedPtr< OutlineItemCollectionidx_get (int32_t index)
 Gets outline item from the collection using 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
 
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< Engine::Data::IPdfDictionary > get_EngineDict () const
 
virtual void UpdateVisibleCount ()
 
 OutlineItemCollection (System::SharedPtr< Engine::Data::IPdfObject > outline)
 Initializes new instance of this class using internal engine outline entry object. More...
 
System::SharedPtr< Engine::Data::IPdfObject > createOutline (System::SharedPtr< Engine::Data::ITrailerable > trailer)
 Creates new outline entry object in document outline hierarchy. More...
 
void setParent (System::SharedPtr< System::Object > parent)
 Sets parent to this outline entry. More...
 
void setPrev (System::SharedPtr< OutlineItemCollection > prev)
 Sets parent to this outline entry. More...
 
void setNext (System::SharedPtr< Engine::Data::IPdfObject > next)
 Inserts the specified outline entry before this entry in the document outline hierarchy. More...
 

Protected Attributes

System::SharedPtr< Engine::IPdfDocument > document
 
System::SharedPtr< Engine::Data::IPdfObject > _engineObj
 

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

Represents outline entry in outline hierarchy of PDF document.

Constructor & Destructor Documentation

◆ OutlineItemCollection() [1/2]

Aspose::Pdf::OutlineItemCollection::OutlineItemCollection ( System::SharedPtr< OutlineCollection outlines)

Initializes outline item instance using root hierarchy object.

Parameters
outlinesOutlune collection.

◆ OutlineItemCollection() [2/2]

Aspose::Pdf::OutlineItemCollection::OutlineItemCollection ( System::SharedPtr< Engine::Data::IPdfObject >  outline)
protected

Initializes new instance of this class using internal engine outline entry object.

Parameters
outlineInternal engine object of outline entry.

Member Function Documentation

◆ Add()

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

Adds outline item to collection.

Parameters
outlineThe outline item to be added.

Implements Aspose::Pdf::Outlines.

◆ Clear()

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

Clears all items from the collection.

Implements Aspose::Pdf::Outlines.

◆ Contains()

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

Checks if collection contains given item.

Parameters
itemThe object to locate in the collection

Implements Aspose::Pdf::Outlines.

◆ CopyTo()

virtual void Aspose::Pdf::OutlineItemCollection::CopyTo ( System::ArrayPtr< System::SharedPtr< OutlineItemCollection >>  array,
int32_t  index 
)
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.

Implements Aspose::Pdf::Outlines.

◆ createOutline()

System::SharedPtr<Engine::Data::IPdfObject> Aspose::Pdf::OutlineItemCollection::createOutline ( System::SharedPtr< Engine::Data::ITrailerable >  trailer)
protected

Creates new outline entry object in document outline hierarchy.

Parameters
trailerInternal engine trailer object.
Returns
New created outline entry object.

◆ Delete() [1/2]

void Aspose::Pdf::OutlineItemCollection::Delete ( )

Deletes this outline item from the document outline hierarchy.

◆ Delete() [2/2]

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

Deletes outline entry with specified name from the document outline hierarchy.

Parameters
nameTitle of outline entry will be deleted.

◆ get_Action()

System::SharedPtr<Annotations::PdfAction> Aspose::Pdf::OutlineItemCollection::get_Action ( )

Gets the action for this outline item.

◆ get_Bold()

bool Aspose::Pdf::OutlineItemCollection::get_Bold ( )

Gets bold flag for the title text of this outline item

◆ get_Color()

System::Drawing::Color Aspose::Pdf::OutlineItemCollection::get_Color ( )

Gets the color for the title text of this outline item.

◆ get_Count()

virtual int32_t Aspose::Pdf::OutlineItemCollection::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_Destination()

System::SharedPtr<Annotations::IAppointment> Aspose::Pdf::OutlineItemCollection::get_Destination ( )

Gets the destination for this outline item.

◆ get_EngineDict()

System::SharedPtr<Engine::Data::IPdfDictionary> Aspose::Pdf::OutlineItemCollection::get_EngineDict ( ) const
protected

◆ get_First()

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

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

◆ get_HasNext()

bool Aspose::Pdf::OutlineItemCollection::get_HasNext ( )

Check if outline item representing next item relatively this item in the outline hierarchy.

◆ get_IsReadOnly()

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

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

Implements Aspose::Pdf::Outlines.

◆ get_IsSynchronized()

bool Aspose::Pdf::OutlineItemCollection::get_IsSynchronized ( )

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

◆ get_Italic()

bool Aspose::Pdf::OutlineItemCollection::get_Italic ( )

Gets italic flag for the title text of this outline item

◆ get_Last()

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

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

◆ get_Level()

int32_t Aspose::Pdf::OutlineItemCollection::get_Level ( )

Gets hierarchy level of outline item.

◆ get_Next()

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

Gets the outline item representing next item relatively this item in the outline hierarchy.

◆ get_Open()

bool Aspose::Pdf::OutlineItemCollection::get_Open ( )

Get or sets open status (true/false) for outline item.

◆ get_Parent()

System::SharedPtr<Outlines> Aspose::Pdf::OutlineItemCollection::get_Parent ( )

Gets the parent object of this outline item in the outline hierarchy.

◆ get_Prev()

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

Gets the outline item representing previous item relatively this item in the outline hierarchy.

◆ get_SyncRoot()

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

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

◆ get_Title()

System::String Aspose::Pdf::OutlineItemCollection::get_Title ( )

Gets the title for this outline item.

◆ get_VisibleCount()

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

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

Implements Aspose::Pdf::Outlines.

◆ GetEnumerator()

virtual System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<OutlineItemCollection> > > Aspose::Pdf::OutlineItemCollection::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.

System.Collections.IEnumerator System.Collections.IEnumerable.GetEnumerator() { return new OutlineCollection.OutlinesEnumerator(EngineDict, document); }

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::OutlineItemCollection::idx_get ( int32_t  index)

Gets outline item from the collection using index.

Parameters
indexIndex within the collection.
Returns
OutlineItemCollection object.

◆ Insert()

void Aspose::Pdf::OutlineItemCollection::Insert ( int32_t  index,
System::SharedPtr< OutlineItemCollection outline 
)

Inserts the outline item into collection at the specified place.

Parameters
indexThe index specifying place for inserting.
outlineThe outline item should be inserted.

◆ Remove() [1/2]

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

Remove outline collection item.

Parameters
itemItem to delete.

Implements Aspose::Pdf::Outlines.

◆ Remove() [2/2]

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

Remove item by index.

Parameters
indexIndex of item to be deleted.

◆ set_Action()

void Aspose::Pdf::OutlineItemCollection::set_Action ( System::SharedPtr< Annotations::PdfAction value)

Sets the action for this outline item.

◆ set_Bold()

void Aspose::Pdf::OutlineItemCollection::set_Bold ( bool  value)

Sets bold flag for the title text of this outline item

◆ set_Color()

void Aspose::Pdf::OutlineItemCollection::set_Color ( System::Drawing::Color  value)

Sets the color for the title text of this outline item.

◆ set_Destination()

void Aspose::Pdf::OutlineItemCollection::set_Destination ( System::SharedPtr< Annotations::IAppointment value)

Sets the destination for this outline item.

◆ set_Italic()

void Aspose::Pdf::OutlineItemCollection::set_Italic ( bool  value)

Sets italic flag for the title text of this outline item

◆ set_Open()

void Aspose::Pdf::OutlineItemCollection::set_Open ( bool  value)

Get or sets open status (true/false) for outline item.

◆ set_Title()

void Aspose::Pdf::OutlineItemCollection::set_Title ( System::String  value)

Sets the title for this outline item.

◆ setNext()

void Aspose::Pdf::OutlineItemCollection::setNext ( System::SharedPtr< Engine::Data::IPdfObject >  next)
protected

Inserts the specified outline entry before this entry in the document outline hierarchy.

Parameters
nextOutline entry will be inserted.

◆ setParent()

void Aspose::Pdf::OutlineItemCollection::setParent ( System::SharedPtr< System::Object parent)
protected

Sets parent to this outline entry.

Parameters
parentNew parent object of this outline entry.

◆ setPrev()

void Aspose::Pdf::OutlineItemCollection::setPrev ( System::SharedPtr< OutlineItemCollection prev)
protected

Sets parent to this outline entry.

Parameters
prevNew parent object of this outline entry.

◆ UpdateVisibleCount()

virtual void Aspose::Pdf::OutlineItemCollection::UpdateVisibleCount ( )
protectedvirtual

Implements Aspose::Pdf::Outlines.

Member Data Documentation

◆ _engineObj

System::SharedPtr<Engine::Data::IPdfObject> Aspose::Pdf::OutlineItemCollection::_engineObj
protected

◆ document

System::SharedPtr<Engine::IPdfDocument> Aspose::Pdf::OutlineItemCollection::document
protected