Aspose::Words::Saving::BookmarksOutlineLevelCollection Class Reference

Detailed Description

A collection of individual bookmarks outline level.

Key is a case-insensitive string bookmark name. Value is a int bookmark outline level.

Bookmark outline level may be a value from 0 to 9. Specify 0 and Word bookmark will not be displayed in the document outline. Specify 1 and Word bookmark will be displayed in the document outline at level 1; 2 for level 2 and so on.

#include <Aspose.Words.Cpp/Model/Saving/BookmarksOutlineLevelCollection.h>

+ Inheritance diagram for Aspose::Words::Saving::BookmarksOutlineLevelCollection:

Public Member Functions

 BookmarksOutlineLevelCollection ()
 
void Add (String name, int32_t outlineLevel)
 Adds a bookmark to the collection. More...
 
void Clear ()
 Removes all elements from the collection. More...
 
bool Contains (String name)
 Determines whether the collection contains a bookmark with the given name. More...
 
int32_t get_Count ()
 Gets the number of elements contained in the collection. More...
 
SharedPtr< IEnumerator< KeyValuePair< String, int32_t > > > GetEnumerator ()
 
int32_t idx_get (int32_t index)
 Gets or sets a bookmark outline level at the specified index. More...
 
int32_t idx_get (String name)
 Gets or a sets a bookmark outline level by the bookmark name. More...
 
void idx_set (int32_t index, int32_t value)
 Gets or sets a bookmark outline level at the specified index. More...
 
void idx_set (String name, int32_t value)
 Gets or a sets a bookmark outline level by the bookmark name. More...
 
int32_t IndexOfKey (String name)
 Returns the zero-based index of the specified bookmark in the collection. More...
 
void Remove (String name)
 Removes a bookmark with the specified name from the collection. More...
 
void RemoveAt (int32_t index)
 Removes a bookmark at the specified index. More...
 
- Public Member Functions inherited from System::Collections::Generic::IEnumerable< System::Collections::Generic::KeyValuePair< System::String, int32_t > >
EnumeratorBasedIterator< T, IEnumerator< T > > begin () noexcept
 
EnumeratorBasedIterator< T, IEnumerator< T > > cbegin () noexcept
 
EnumeratorBasedIterator< T, IEnumerator< T > > cend () noexcept
 
EnumeratorBasedIterator< T, IEnumerator< T > > end () noexcept
 
bool LINQ_All (std::function< bool(T)> predicate)
 
bool LINQ_Any ()
 
bool LINQ_Any (std::function< bool(T)> predicate)
 
SharedPtr< IEnumerable< ResultType > > LINQ_Cast ()
 
SharedPtr< IEnumerable< Result > > LINQ_Cast ()
 
bool LINQ_Contains (T value)
 
int LINQ_Count ()
 
LINQ_ElementAt (int index)
 
LINQ_First ()
 
LINQ_FirstOrDefault ()
 
LINQ_FirstOrDefault (std::function< bool(T)> predicate)
 
LINQ_Last ()
 
LINQ_LastOrDefault ()
 
SharedPtr< IEnumerable< ResultType > > LINQ_OfType ()
 
SharedPtr< IEnumerable< Result > > LINQ_OfType ()
 
SharedPtr< IEnumerable< Result > > LINQ_Select (const Func< Source, Result > &selector)
 
SharedPtr< IEnumerable< ResultType > > LINQ_Select (const Func< T, ResultType > &selector)
 
ArrayPtr< T > LINQ_ToArray ()
 
SharedPtr< List< T > > LINQ_ToList ()
 
SharedPtr< IEnumerable< T > > LINQ_Where (std::function< bool(T)> predicate)
 
- Public Member Functions inherited from Object
ASPOSECPP_SHARED_API Object ()
 
ASPOSECPP_SHARED_API Object (Object const &x)
 
virtual ASPOSECPP_SHARED_API ~Object ()
 
virtual ASPOSECPP_SHARED_API bool Equals (ptr obj)
 
Detail::SmartPtrCounter * GetCounter ()
 
virtual ASPOSECPP_SHARED_API int GetHashCode () const
 
virtual ASPOSECPP_SHARED_API const TypeInfoGetType () const
 
virtual ASPOSECPP_SHARED_API bool Is (const TypeInfo &targetType) const
 
ASPOSECPP_SHARED_API void Lock ()
 
virtual ASPOSECPP_SHARED_API ptr MemberwiseClone () const
 
Objectoperator= (Object const &x)
 
bool ReferenceEquals (String const &str, std::nullptr_t)
 
bool ReferenceEquals (String const &str1, String const &str2)
 
int RemovedSharedRefs (int count)
 
virtual ASPOSECPP_SHARED_API void SetTemplateWeakPtr (unsigned int argument)
 
int SharedCount () const
 
ObjectSharedRefAdded ()
 
int SharedRefRemovedSafe ()
 
virtual ASPOSECPP_SHARED_API String ToString () const
 
ASPOSECPP_SHARED_API void Unlock ()
 
Detail::SmartPtrCounter * WeakRefAdded ()
 
void WeakRefRemoved ()
 

Additional Inherited Members

- Public Types inherited from System::Collections::Generic::IEnumerable< System::Collections::Generic::KeyValuePair< System::String, int32_t > >
typedef IEnumerator< T > IEnumeratorType
 
typedef T ValueType
 
- Public Types inherited from Object
typedef SmartPtr< Objectptr
 
typedef System::Details::SharedMembersType shared_members_type
 
- Static Public Member Functions inherited from Object
bool Equals (double const &objA, double const &objB)
 
bool Equals (float const &objA, float const &objB)
 
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 
static const TypeInfoType ()
 

Constructor & Destructor Documentation

◆ BookmarksOutlineLevelCollection()

Aspose::Words::Saving::BookmarksOutlineLevelCollection::BookmarksOutlineLevelCollection ( )

Member Function Documentation

◆ Add()

void Aspose::Words::Saving::BookmarksOutlineLevelCollection::Add ( System::String  name,
int32_t  outlineLevel 
)

Adds a bookmark to the collection.

Parameters
nameThe case-insensitive name of the bookmark to add.
outlineLevelThe outline level of the bookmark. Valid range is 0 to 9.

◆ Clear()

void Aspose::Words::Saving::BookmarksOutlineLevelCollection::Clear ( )

Removes all elements from the collection.

◆ Contains()

bool Aspose::Words::Saving::BookmarksOutlineLevelCollection::Contains ( System::String  name)

Determines whether the collection contains a bookmark with the given name.

Parameters
nameCase-insensitive name of the bookmark to locate.
Returns
True if item is found in the collection; otherwise, false.

◆ get_Count()

int32_t Aspose::Words::Saving::BookmarksOutlineLevelCollection::get_Count ( )

Gets the number of elements contained in the collection.

◆ GetEnumerator()

◆ idx_get() [1/2]

int32_t Aspose::Words::Saving::BookmarksOutlineLevelCollection::idx_get ( int32_t  index)

Gets or sets a bookmark outline level at the specified index.

Parameters
indexZero-based index of the bookmark.
Returns
The outline level of the bookmark. Valid range is 0 to 9.

◆ idx_get() [2/2]

int32_t Aspose::Words::Saving::BookmarksOutlineLevelCollection::idx_get ( System::String  name)

Gets or a sets a bookmark outline level by the bookmark name.

Parameters
nameCase-insensitive name of the bookmark.
Returns
The outline level of the bookmark. Valid range is 0 to 9.

◆ idx_set() [1/2]

void Aspose::Words::Saving::BookmarksOutlineLevelCollection::idx_set ( int32_t  index,
int32_t  value 
)

Gets or sets a bookmark outline level at the specified index.

Parameters
indexZero-based index of the bookmark.
Returns
The outline level of the bookmark. Valid range is 0 to 9.
Parameters
valueThe value to set.

◆ idx_set() [2/2]

void Aspose::Words::Saving::BookmarksOutlineLevelCollection::idx_set ( System::String  name,
int32_t  value 
)

Gets or a sets a bookmark outline level by the bookmark name.

Parameters
nameCase-insensitive name of the bookmark.
Returns
The outline level of the bookmark. Valid range is 0 to 9.
Parameters
valueThe value to set.

◆ IndexOfKey()

int32_t Aspose::Words::Saving::BookmarksOutlineLevelCollection::IndexOfKey ( System::String  name)

Returns the zero-based index of the specified bookmark in the collection.

Parameters
nameThe case-insensitive name of the bookmark.
Returns
The zero based index. Negative value if not found.

◆ Remove()

void Aspose::Words::Saving::BookmarksOutlineLevelCollection::Remove ( System::String  name)

Removes a bookmark with the specified name from the collection.

Parameters
nameThe case-insensitive name of the bookmark.

◆ RemoveAt()

void Aspose::Words::Saving::BookmarksOutlineLevelCollection::RemoveAt ( int32_t  index)

Removes a bookmark at the specified index.

Parameters
indexThe zero based index.