Aspose::Words::Bookmark Class Reference

Represents a single bookmark. More...

#include "Aspose.Words.Cpp/Model/Bookmarks/Bookmark.h"

Inherits System::Object.

Public Member Functions

System::String get_Name ()
 Gets or sets the name of the bookmark. More...
 
void set_Name (System::String value)
 Setter for Aspose::Words::Bookmark::get_Name. More...
 
System::String get_Text ()
 Gets or sets the text enclosed in the bookmark. More...
 
void set_Text (System::String value)
 Setter for Aspose::Words::Bookmark::get_Text. More...
 
System::SharedPtr< Aspose::Words::BookmarkStartget_BookmarkStart () const
 Gets the node that represents the start of the bookmark. More...
 
System::SharedPtr< Aspose::Words::BookmarkEndget_BookmarkEnd ()
 Gets the node that represents the end of the bookmark. More...
 
bool get_IsColumn ()
 
int32_t get_FirstColumn ()
 
int32_t get_LastColumn ()
 
void Remove ()
 Removes the bookmark from the document. Does not remove text inside the bookmark. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 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...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual String ToString () ASPOSE_CONST
 Analog of C# Object.ToString() method. Enables converting custom objects to string. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual 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...
 

Additional Inherited Members

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

Detailed Description

Represents a single bookmark.

Aspose::Words::Bookmark is a "facade" object that encapsulates two nodes Aspose::Words::Bookmark::get_BookmarkStart and Aspose::Words::Bookmark::get_BookmarkEnd in a document tree and allows to work with a bookmark as a single object.

Member Function Documentation

◆ get_BookmarkEnd()

System::SharedPtr<Aspose::Words::BookmarkEnd> Aspose::Words::Bookmark::get_BookmarkEnd ( )

Gets the node that represents the end of the bookmark.

◆ get_BookmarkStart()

System::SharedPtr<Aspose::Words::BookmarkStart> Aspose::Words::Bookmark::get_BookmarkStart ( ) const

Gets the node that represents the start of the bookmark.

◆ get_FirstColumn()

int32_t Aspose::Words::Bookmark::get_FirstColumn ( )

◆ get_IsColumn()

bool Aspose::Words::Bookmark::get_IsColumn ( )

◆ get_LastColumn()

int32_t Aspose::Words::Bookmark::get_LastColumn ( )

◆ get_Name()

System::String Aspose::Words::Bookmark::get_Name ( )

Gets or sets the name of the bookmark.

Note that if you change the name of a bookmark to a name that already exists in the document, no error will be given and only the first bookmark will be stored when you save the document.

◆ get_Text()

System::String Aspose::Words::Bookmark::get_Text ( )

Gets or sets the text enclosed in the bookmark.

◆ Remove()

void Aspose::Words::Bookmark::Remove ( )

Removes the bookmark from the document. Does not remove text inside the bookmark.

◆ set_Name()

void Aspose::Words::Bookmark::set_Name ( System::String  value)

◆ set_Text()

void Aspose::Words::Bookmark::set_Text ( System::String  value)