foxit.pdf.ReadingBookmark Class Reference
Inheritance diagram for foxit.pdf.ReadingBookmark:
foxit.common.Base

Public Member Functions

 ReadingBookmark (ReadingBookmark other)
 Constructor, with another ReadingBookmark object. More...
 
DateTime GetDateTime (bool is_creation_date)
 Get date time information. More...
 
int GetPageIndex ()
 Get the index of the destination page. More...
 
string GetTitle ()
 Get the title. More...
 
bool IsEmpty ()
 Check whether current object is empty or not. More...
 
void SetDateTime (DateTime date_time, bool is_creation_date)
 Set date time information. More...
 
void SetPageIndex (int index)
 Set the index of the destination page. More...
 
void SetTitle (string title)
 Set the title. More...
 

Detailed Description

Reading bookmark is not a PDF bookmark, in other words, it is not PDF outlines. It is the bookmark in applicable level. It is stored in the metadata (XML format) of catalog. It allows user to add or remove a reading bookmark according to their reading preferences and navigate one PDF page easily by selecting one reading bookmark.
In order to retrieve the reading bookmark, function pdf::PDFDoc::GetReadingBookmarkCount could be called to count the reading bookmarks, and function pdf::PDFDoc::GetReadingBookmark could be called to get a reading bookmark by index.
This class offers several functions to get/set properties of reading bookmarks, such as title, destination page index and creation/modified date time.

See also
pdf::PDFDoc

Constructor & Destructor Documentation

◆ ReadingBookmark()

foxit.pdf.ReadingBookmark.ReadingBookmark ( ReadingBookmark  other)
inline

Constructor, with another ReadingBookmark object.

Parameters
otherAnother ReadingBookmark object.

Member Function Documentation

◆ GetDateTime()

DateTime foxit.pdf.ReadingBookmark.GetDateTime ( bool  is_creation_date)
inline

Get date time information.

Parameters
is_creation_datetrue means to get creation date time information, and false means to get last modified date time information.
Returns
The specified date and time. If no specified date and time property can be found, this function will return a DateTime object with all values 0.

◆ GetPageIndex()

int foxit.pdf.ReadingBookmark.GetPageIndex ( )
inline

Get the index of the destination page.

Returns
The page index, starting from 0. If no page index property can be found, this function will return -1.

◆ GetTitle()

string foxit.pdf.ReadingBookmark.GetTitle ( )
inline

Get the title.

Returns
Title string. If no title property can be found, this function will return an empty string.

◆ IsEmpty()

bool foxit.pdf.ReadingBookmark.IsEmpty ( )
inline

Check whether current object is empty or not.

When the current object is empty, that means current object is useless.

Returns
true means current object is empty, while false means not.

◆ SetDateTime()

void foxit.pdf.ReadingBookmark.SetDateTime ( DateTime  date_time,
bool  is_creation_date 
)
inline

Set date time information.

Parameters
date_timeNew date time information. All the values of this date obejct should be valid. Please refer to comment of class DateTime for more details.
is_creation_datetrue means to get creation date time information, and false means to get last modified date time information.
return None.

◆ SetPageIndex()

void foxit.pdf.ReadingBookmark.SetPageIndex ( int  index)
inline

Set the index of the destination page.

Parameters
indexThe new destination page index. Valid range: from 0 to (count-1). count is the page count of the PDF document to which current reading bookmark belongs. The page count can be retrieved by function pdf::PDFDoc::GetPageCount.
Returns
None.

◆ SetTitle()

void foxit.pdf.ReadingBookmark.SetTitle ( string  title)
inline

Set the title.

Parameters
titleNew title string.
Returns
None.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.