OdBookmark Class

Syntax

C++

class OdBookmark : public OdObject;

Description

This class implements working with a bookmark encapsulated in a PDF document created with Publish SDK. A bookmark is a kind of link with descriptive text that makes it easy to navigate through a PDF document.

Class Hierarchy

File: PdfPublishBookmark.h

Namespace: OdPdfPublish

Module: API Reference

Methods

Show:Inherited

No members matching the current filter

OdRxObject	Default constructor for this class. (Inherited from OdRxObject)
~OdBookmark	Destroys the bookmark object.
~OdObject	Destroys an instance of a Publish SDK object. (Inherited from OdObject)
~OdRxObject	The virtual destructor for this class. (Inherited from OdRxObject)

Methods

Show:Inherited

No members matching the current filter

addRef	Declares the method incrementing the reference counter in objects derived from this class. (Inherited from OdRxObject)
appendChild	Appends a new child bookmark to the current bookmark.
cast	Casts the specified raw pointer to the smart pointer. (Inherited from OdRxObject)
clear	Clears the Publish SDK object. (Inherited from OdObject)
clone	Creates a clone of this object, and returns a pointer to the clone. (Inherited from OdRxObject)
comparedTo	Compares another object to this one in a some meaning. (Inherited from OdRxObject)
copyFrom	details Copies the contents of the specified object into this object. (Inherited from OdRxObject)
desc	Returns the raw pointer to the class describing instance statically associated with this object as the OdRxClass object. (Inherited from OdRxObject)
getBookmarkType	Returns the type of the bookmark object. The method fills a passed Bookmarks::BookmarkType enumeration value with the current bookmark type value and returns it to a calling subroutine.
getChildren	Returns the descendant bookmarks of the bookmark object. This method fills the passed array with the set of descendant OdBookmark objects and returns it to a calling subroutine.
getPage	Returns the page the bookmark object refers to. The method fills a passed parameter with the smart pointer to an OdPage object and returns it to a calling subroutine.
getParametrs	Returns parameters of the current bookmark. This method fills the passed array of doubles with parameter values and returns it to a calling subroutine.
getTextColor	Returns the current color of the bookmark title. The method fills a passed ODCOLORREF value with the current bookmark title color and returns it to a calling subroutine.
getTextStyle	Returns the font style of the bookmark title. The method fills a passed Text::FontStyle enumeration value and returns it to a calling subroutine.
getTitle	Returns the bookmark title. The method fills a passed string object with the title text and returns this string to a calling subroutine.
isA	Returns the raw pointer to the class describing instance dynamically associated with this object as the OdRxClass object. (Inherited from OdRxObject)
isEmpty	Determines whether the Publish SDK object is empty. (Inherited from OdObject)
isEqualTo	Returns true if and only if the specified object is equal to this one in a some meaning. (Inherited from OdRxObject)
isKindOf	Checks whether the object belongs to the specified class and returns true if and only if this object is an instance of the specified class or a subclass of the specified class. (Inherited from OdRxObject)
isValid	Determines whether the Publish SDK object is valid. (Inherited from OdObject)
numRefs	Returns the value of the reference counter, that is, the number of references to an instance of this class. (Inherited from OdRxObject)
queryX	Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class. (Inherited from OdRxObject)
release	Declares the method decrementing the reference counter in objects derived from this class. (Inherited from OdRxObject)
rxInit	for internal use (Inherited from OdRxObject)
rxUninit	(Inherited from OdRxObject)
setBookmarkType	Sets the bookmark type. Bookmark types are declared in the Bookmarks::BookmarkType enumeration.
setChildren	Sets descendant bookmarks for the current bookmark.
setPage	Sets the page the bookmark object refers to.
setParametrs	Sets parameters for the bookmark object.
setTextColor	Sets the color for the bookmark title.
setTextStyle	Sets the font style for the bookmark title.
setTitle	Sets the bookmark title.
x	Checks whether the object belongs to the specified class and returns a pointer to this object if this object can be converted to the specified class, or throws an exception if it cannot. (Inherited from OdRxObject)

Links

OdBookmark Methods

Relief for ODA Team in Ukraine