Represents table of contents info. More...

#include "TOCInfo.h"

Inherits System::Object.

Public Member Functions

ASPOSE_PDF_SHARED_API const System::SharedPtr< Aspose::Pdf::ColumnInfo > & get_ColumnInfo () const
 Gets column info. More...
 
ASPOSE_PDF_SHARED_API void set_ColumnInfo (System::SharedPtr< Aspose::Pdf::ColumnInfo > value)
 Sets column info. More...
 
ASPOSE_PDF_SHARED_API const System::ArrayPtr< System::SharedPtr< LevelFormat > > & get_FormatArray () const
 Gets format array for table of contents. More...
 
ASPOSE_PDF_SHARED_API void set_FormatArray (System::ArrayPtr< System::SharedPtr< LevelFormat >> value)
 Sets format array for table of contents. More...
 
ASPOSE_PDF_SHARED_API int32_t get_FormatArrayLength ()
 Gets format array length More...
 
ASPOSE_PDF_SHARED_API void set_FormatArrayLength (int32_t value)
 Sets format array length More...
 
ASPOSE_PDF_SHARED_API const System::SharedPtr< Text::TextFragment > & get_Title () const
 Gets table of contents title. More...
 
ASPOSE_PDF_SHARED_API void set_Title (System::SharedPtr< Text::TextFragment > value)
 Sets table of contents title. More...
 
ASPOSE_PDF_SHARED_API bool get_IsCountTocPages () const
 Gets is count or passed toc pages. More...
 
ASPOSE_PDF_SHARED_API void set_IsCountTocPages (bool value)
 Sets is count or passed toc pages. More...
 
ASPOSE_PDF_SHARED_API System::String get_PageNumbersPrefix () const
 Gets is prefix before page number. More...
 
ASPOSE_PDF_SHARED_API void set_PageNumbersPrefix (System::String value)
 Sets is prefix before page number. More...
 
ASPOSE_PDF_SHARED_API bool get_IsShowPageNumbers () const
 Gets is show page numbers at Toc. More...
 
ASPOSE_PDF_SHARED_API void set_IsShowPageNumbers (bool value)
 Sets is show page numbers at Toc. More...
 
ASPOSE_PDF_SHARED_API Text::TabLeaderType get_LineDash () const
 Gets TOC line dash. More...
 
ASPOSE_PDF_SHARED_API void set_LineDash (Text::TabLeaderType value)
 Sets TOC line dash. More...
 
ASPOSE_PDF_SHARED_API bool get_CopyToOutlines () const
 Gets is TOC copied to outlines. More...
 
ASPOSE_PDF_SHARED_API void set_CopyToOutlines (bool value)
 Sets is TOC copied to outlines. More...
 
ASPOSE_PDF_SHARED_API TocInfo ()
 Initializes a new instance of the TocInfo class. 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

const System::SharedPtr< System::Collections::Generic::Dictionary< int32_t, int32_t > > & get_AutoNumbers () const
 Gets headings numbers for auto numnering(internal). More...
 
int32_t get_PagesCount () const
 Gets TOC pages count(for internal use). More...
 
void set_PagesCount (int32_t value)
 Sets TOC pages count(for internal use). More...
 
int32_t get_InsertedTocNumber () const
 Gets inserted toc number(for internal use). More...
 
void set_InsertedTocNumber (int32_t value)
 Sets inserted toc number(for internal use). More...
 
System::SharedPtr< Text::TextSegmentGetNumber (int32_t level, System::SharedPtr< Heading > heading)
 

Static Protected Member Functions

static System::String GetLabelNumber (int32_t number, NumberingStyle style)
 

Additional Inherited Members

- 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 table of contents info.

Constructor & Destructor Documentation

◆ TocInfo()

ASPOSE_PDF_SHARED_API Aspose::Pdf::TocInfo::TocInfo ( )

Initializes a new instance of the TocInfo class.

Member Function Documentation

◆ get_AutoNumbers()

const System::SharedPtr<System::Collections::Generic::Dictionary<int32_t, int32_t> >& Aspose::Pdf::TocInfo::get_AutoNumbers ( ) const
protected

Gets headings numbers for auto numnering(internal).

◆ get_ColumnInfo()

ASPOSE_PDF_SHARED_API const System::SharedPtr<Aspose::Pdf::ColumnInfo>& Aspose::Pdf::TocInfo::get_ColumnInfo ( ) const

Gets column info.

◆ get_CopyToOutlines()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::TocInfo::get_CopyToOutlines ( ) const

Gets is TOC copied to outlines.

◆ get_FormatArray()

ASPOSE_PDF_SHARED_API const System::ArrayPtr<System::SharedPtr<LevelFormat> >& Aspose::Pdf::TocInfo::get_FormatArray ( ) const

Gets format array for table of contents.

◆ get_FormatArrayLength()

ASPOSE_PDF_SHARED_API int32_t Aspose::Pdf::TocInfo::get_FormatArrayLength ( )

Gets format array length

◆ get_InsertedTocNumber()

int32_t Aspose::Pdf::TocInfo::get_InsertedTocNumber ( ) const
protected

Gets inserted toc number(for internal use).

◆ get_IsCountTocPages()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::TocInfo::get_IsCountTocPages ( ) const

Gets is count or passed toc pages.

◆ get_IsShowPageNumbers()

ASPOSE_PDF_SHARED_API bool Aspose::Pdf::TocInfo::get_IsShowPageNumbers ( ) const

Gets is show page numbers at Toc.

◆ get_LineDash()

ASPOSE_PDF_SHARED_API Text::TabLeaderType Aspose::Pdf::TocInfo::get_LineDash ( ) const

Gets TOC line dash.

◆ get_PageNumbersPrefix()

ASPOSE_PDF_SHARED_API System::String Aspose::Pdf::TocInfo::get_PageNumbersPrefix ( ) const

Gets is prefix before page number.

◆ get_PagesCount()

int32_t Aspose::Pdf::TocInfo::get_PagesCount ( ) const
protected

Gets TOC pages count(for internal use).

◆ get_Title()

ASPOSE_PDF_SHARED_API const System::SharedPtr<Text::TextFragment>& Aspose::Pdf::TocInfo::get_Title ( ) const

Gets table of contents title.

◆ GetLabelNumber()

static System::String Aspose::Pdf::TocInfo::GetLabelNumber ( int32_t  number,
NumberingStyle  style 
)
staticprotected

◆ GetNumber()

System::SharedPtr<Text::TextSegment> Aspose::Pdf::TocInfo::GetNumber ( int32_t  level,
System::SharedPtr< Heading heading 
)
protected

◆ set_ColumnInfo()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::TocInfo::set_ColumnInfo ( System::SharedPtr< Aspose::Pdf::ColumnInfo value)

Sets column info.

◆ set_CopyToOutlines()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::TocInfo::set_CopyToOutlines ( bool  value)

Sets is TOC copied to outlines.

◆ set_FormatArray()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::TocInfo::set_FormatArray ( System::ArrayPtr< System::SharedPtr< LevelFormat >>  value)

Sets format array for table of contents.

◆ set_FormatArrayLength()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::TocInfo::set_FormatArrayLength ( int32_t  value)

Sets format array length

◆ set_InsertedTocNumber()

void Aspose::Pdf::TocInfo::set_InsertedTocNumber ( int32_t  value)
protected

Sets inserted toc number(for internal use).

◆ set_IsCountTocPages()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::TocInfo::set_IsCountTocPages ( bool  value)

Sets is count or passed toc pages.

◆ set_IsShowPageNumbers()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::TocInfo::set_IsShowPageNumbers ( bool  value)

Sets is show page numbers at Toc.

◆ set_LineDash()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::TocInfo::set_LineDash ( Text::TabLeaderType  value)

Sets TOC line dash.

◆ set_PageNumbersPrefix()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::TocInfo::set_PageNumbersPrefix ( System::String  value)

Sets is prefix before page number.

◆ set_PagesCount()

void Aspose::Pdf::TocInfo::set_PagesCount ( int32_t  value)
protected

Sets TOC pages count(for internal use).

◆ set_Title()

ASPOSE_PDF_SHARED_API void Aspose::Pdf::TocInfo::set_Title ( System::SharedPtr< Text::TextFragment value)

Sets table of contents title.