Represents a bookmark. More...

Inherits System::Object.

Public Member Functions

System::String get_Action ()
 Gets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: "GoTo", "GoToR", "Launch", "Named". More...
 
void set_Action (System::String value)
 Sets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: "GoTo", "GoToR", "Launch", "Named". More...
 
bool get_BoldFlag ()
 Gets the bold flag of bookmark's title. More...
 
void set_BoldFlag (bool value)
 Sets the bold flag of bookmark's title. More...
 
System::SharedPtr< Bookmarksget_ChildItem ()
 Gets bookmark's children. More...
 
void set_ChildItem (System::SharedPtr< Bookmarks > value)
 Sets bookmark's children. More...
 
System::SharedPtr< Bookmarksget_ChildItems ()
 Gets bookmark's children. More...
 
void set_ChildItems (System::SharedPtr< Bookmarks > value)
 Sets bookmark's children. More...
 
System::String get_Destination ()
 Gets bookmark's destination page. Required if action is set as string.Empty. More...
 
void set_Destination (System::String value)
 Sets bookmark's destination page. Required if action is set as string.Empty. More...
 
bool get_ItalicFlag ()
 Gets the italic flag of bookmark's title. More...
 
void set_ItalicFlag (bool value)
 Sets the italic flag of bookmark's title. More...
 
int32_t get_Level ()
 Gets bookmark's hierarchy level. More...
 
void set_Level (int32_t value)
 Sets bookmark's hierarchy level. More...
 
System::String get_PageDisplay ()
 Gets the type of display bookmark's destination page. More...
 
void set_PageDisplay (System::String value)
 Sets the type of display bookmark's destination page. More...
 
int32_t get_PageDisplay_Bottom ()
 Gets the bottom coordinate of page display. More...
 
void set_PageDisplay_Bottom (int32_t value)
 Sets the bottom coordinate of page display. More...
 
int32_t get_PageDisplay_Left ()
 Gets the left coordinate of page display. More...
 
void set_PageDisplay_Left (int32_t value)
 Sets the left coordinate of page display. More...
 
int32_t get_PageDisplay_Right ()
 Gets the right coordinate of page display. More...
 
void set_PageDisplay_Right (int32_t value)
 Sets the right coordinate of page display. More...
 
int32_t get_PageDisplay_Top ()
 Gets the top coordinate of page display. More...
 
void set_PageDisplay_Top (int32_t value)
 Sets the top coordinate of page display. More...
 
int32_t get_PageDisplay_Zoom ()
 Gets the zoom factor of page display. More...
 
void set_PageDisplay_Zoom (int32_t value)
 Sets the zoom factor of page display. More...
 
int32_t get_PageNumber ()
 Gets the number of bookmark's destination page. More...
 
void set_PageNumber (int32_t value)
 Sets the number of bookmark's destination page. More...
 
System::String get_RemoteFile ()
 Gets the file (path) which is required for "GoToR" action of bookmark. More...
 
void set_RemoteFile (System::String value)
 Sets the file (path) which is required for "GoToR" action of bookmark. More...
 
System::String get_Title ()
 Gets bookmark's title. More...
 
void set_Title (System::String value)
 Sets bookmark's title. More...
 
System::Drawing::Color get_TitleColor ()
 Gets the color of bookmark's title. More...
 
void set_TitleColor (System::Drawing::Color value)
 Sets the color of bookmark's title. More...
 
bool get_Open ()
 Gets bookmark state (open, close). More...
 
void set_Open (bool value)
 Sets bookmark state (open, close). More...
 
 Bookmark ()
 Initializes a new instance of the Bookmark class. More...
 
int32_t CompareTo (System::SharedPtr< Bookmark > const &value)
 
- 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< OutlineItemCollectionToOutlineItemCollection (System::SharedPtr< Document > doc)
 

Static Protected Member Functions

static System::SharedPtr< BookmarkCreate (System::SharedPtr< OutlineItemCollection > item)
 

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

Detailed Description

Represents a bookmark.

Constructor & Destructor Documentation

◆ Bookmark()

Aspose::Pdf::Facades::Bookmark::Bookmark ( )

Initializes a new instance of the Bookmark class.

Member Function Documentation

◆ CompareTo()

int32_t Aspose::Pdf::Facades::Bookmark::CompareTo ( System::SharedPtr< Bookmark > const &  value)

◆ Create()

static System::SharedPtr<Bookmark> Aspose::Pdf::Facades::Bookmark::Create ( System::SharedPtr< OutlineItemCollection item)
staticprotected

◆ get_Action()

System::String Aspose::Pdf::Facades::Bookmark::get_Action ( )

Gets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: "GoTo", "GoToR", "Launch", "Named".

◆ get_BoldFlag()

bool Aspose::Pdf::Facades::Bookmark::get_BoldFlag ( )

Gets the bold flag of bookmark's title.

◆ get_ChildItem()

System::SharedPtr<Bookmarks> Aspose::Pdf::Facades::Bookmark::get_ChildItem ( )

Gets bookmark's children.

Deprecated:
Use ChildItems property instead of this one.

◆ get_ChildItems()

System::SharedPtr<Bookmarks> Aspose::Pdf::Facades::Bookmark::get_ChildItems ( )

Gets bookmark's children.

◆ get_Destination()

System::String Aspose::Pdf::Facades::Bookmark::get_Destination ( )

Gets bookmark's destination page. Required if action is set as string.Empty.

◆ get_ItalicFlag()

bool Aspose::Pdf::Facades::Bookmark::get_ItalicFlag ( )

Gets the italic flag of bookmark's title.

◆ get_Level()

int32_t Aspose::Pdf::Facades::Bookmark::get_Level ( )

Gets bookmark's hierarchy level.

◆ get_Open()

bool Aspose::Pdf::Facades::Bookmark::get_Open ( )

Gets bookmark state (open, close).

◆ get_PageDisplay()

System::String Aspose::Pdf::Facades::Bookmark::get_PageDisplay ( )

Gets the type of display bookmark's destination page.

◆ get_PageDisplay_Bottom()

int32_t Aspose::Pdf::Facades::Bookmark::get_PageDisplay_Bottom ( )

Gets the bottom coordinate of page display.

◆ get_PageDisplay_Left()

int32_t Aspose::Pdf::Facades::Bookmark::get_PageDisplay_Left ( )

Gets the left coordinate of page display.

◆ get_PageDisplay_Right()

int32_t Aspose::Pdf::Facades::Bookmark::get_PageDisplay_Right ( )

Gets the right coordinate of page display.

◆ get_PageDisplay_Top()

int32_t Aspose::Pdf::Facades::Bookmark::get_PageDisplay_Top ( )

Gets the top coordinate of page display.

◆ get_PageDisplay_Zoom()

int32_t Aspose::Pdf::Facades::Bookmark::get_PageDisplay_Zoom ( )

Gets the zoom factor of page display.

◆ get_PageNumber()

int32_t Aspose::Pdf::Facades::Bookmark::get_PageNumber ( )

Gets the number of bookmark's destination page.

◆ get_RemoteFile()

System::String Aspose::Pdf::Facades::Bookmark::get_RemoteFile ( )

Gets the file (path) which is required for "GoToR" action of bookmark.

◆ get_Title()

System::String Aspose::Pdf::Facades::Bookmark::get_Title ( )

Gets bookmark's title.

◆ get_TitleColor()

System::Drawing::Color Aspose::Pdf::Facades::Bookmark::get_TitleColor ( )

Gets the color of bookmark's title.

◆ set_Action()

void Aspose::Pdf::Facades::Bookmark::set_Action ( System::String  value)

Sets the action bound with the bookmark. If PageNumber is presented the action can not be specified. The action type includes: "GoTo", "GoToR", "Launch", "Named".

◆ set_BoldFlag()

void Aspose::Pdf::Facades::Bookmark::set_BoldFlag ( bool  value)

Sets the bold flag of bookmark's title.

◆ set_ChildItem()

void Aspose::Pdf::Facades::Bookmark::set_ChildItem ( System::SharedPtr< Bookmarks value)

Sets bookmark's children.

Deprecated:
Use ChildItems property instead of this one.

◆ set_ChildItems()

void Aspose::Pdf::Facades::Bookmark::set_ChildItems ( System::SharedPtr< Bookmarks value)

Sets bookmark's children.

◆ set_Destination()

void Aspose::Pdf::Facades::Bookmark::set_Destination ( System::String  value)

Sets bookmark's destination page. Required if action is set as string.Empty.

◆ set_ItalicFlag()

void Aspose::Pdf::Facades::Bookmark::set_ItalicFlag ( bool  value)

Sets the italic flag of bookmark's title.

◆ set_Level()

void Aspose::Pdf::Facades::Bookmark::set_Level ( int32_t  value)

Sets bookmark's hierarchy level.

◆ set_Open()

void Aspose::Pdf::Facades::Bookmark::set_Open ( bool  value)

Sets bookmark state (open, close).

◆ set_PageDisplay()

void Aspose::Pdf::Facades::Bookmark::set_PageDisplay ( System::String  value)

Sets the type of display bookmark's destination page.

◆ set_PageDisplay_Bottom()

void Aspose::Pdf::Facades::Bookmark::set_PageDisplay_Bottom ( int32_t  value)

Sets the bottom coordinate of page display.

◆ set_PageDisplay_Left()

void Aspose::Pdf::Facades::Bookmark::set_PageDisplay_Left ( int32_t  value)

Sets the left coordinate of page display.

◆ set_PageDisplay_Right()

void Aspose::Pdf::Facades::Bookmark::set_PageDisplay_Right ( int32_t  value)

Sets the right coordinate of page display.

◆ set_PageDisplay_Top()

void Aspose::Pdf::Facades::Bookmark::set_PageDisplay_Top ( int32_t  value)

Sets the top coordinate of page display.

◆ set_PageDisplay_Zoom()

void Aspose::Pdf::Facades::Bookmark::set_PageDisplay_Zoom ( int32_t  value)

Sets the zoom factor of page display.

◆ set_PageNumber()

void Aspose::Pdf::Facades::Bookmark::set_PageNumber ( int32_t  value)

Sets the number of bookmark's destination page.

◆ set_RemoteFile()

void Aspose::Pdf::Facades::Bookmark::set_RemoteFile ( System::String  value)

Sets the file (path) which is required for "GoToR" action of bookmark.

◆ set_Title()

void Aspose::Pdf::Facades::Bookmark::set_Title ( System::String  value)

Sets bookmark's title.

◆ set_TitleColor()

void Aspose::Pdf::Facades::Bookmark::set_TitleColor ( System::Drawing::Color  value)

Sets the color of bookmark's title.

◆ ToOutlineItemCollection()

System::SharedPtr<OutlineItemCollection> Aspose::Pdf::Facades::Bookmark::ToOutlineItemCollection ( System::SharedPtr< Document doc)
protected