Foxit PDF SDK
FSDK::ReadingBookmark类 参考

Public 成员函数

 GetDateTime (is_creation_date)
 获取日期时间信息。 更多...
 
 GetPageIndex ()
 获取目标页面的索引。 更多...
 
 GetTitle ()
 获取标题。 更多...
 
 IsEmpty ()
 检查当前对象是否为空。 更多...
 
 SetDateTime (date_time, is_creation_date)
 设置日期时间信息。 更多...
 
 SetPageIndex (index)
 设置目标页面的索引。 更多...
 
 SetTitle (title)
 设置标题。 更多...
 

详细描述

阅读书签不是 PDF 书签,换句话说,它不是 PDF 大纲。 它是应用级别的书签。它存储在目录的元数据(XML 格式)中。它允许 用户根据其阅读偏好添加或删除阅读书签,并通过选择一个阅读书签轻松导航到一个 PDF 页面。
为了检索阅读书签,可以调用函数 FSDK.PDFDoc.GetReadingBookmarkCount 来 计数阅读书签,并可以调用函数 FSDK.PDFDoc.GetReadingBookmark 来 通过索引获取阅读书签。
此类提供了几个函数来获取/设置阅读书签的属性,例如标题、 目标页面索引和创建/修改日期时间。

参见
FSDK.PDFDoc

成员函数说明

◆ GetDateTime()

FSDK::ReadingBookmark::GetDateTime ( is_creation_date  )

获取日期时间信息。

参数
[in]is_creation_datetrue 表示获取创建日期时间信息, false 表示获取最后修改日期时间信息。
返回
指定的日期和时间。如果找不到指定的日期和时间属性, 此函数将返回所有值为 0 的日期和时间对象。

◆ GetPageIndex()

FSDK::ReadingBookmark::GetPageIndex ( )

获取目标页面的索引。

返回
页面索引,从 0 开始。如果找不到页面索引属性,此函数将返回 -1。

◆ GetTitle()

FSDK::ReadingBookmark::GetTitle ( )

获取标题。

返回
标题字符串。如果找不到标题属性,此函数将返回空字符串。

◆ IsEmpty()

FSDK::ReadingBookmark::IsEmpty ( )

检查当前对象是否为空。

当当前对象为空时,这意味着当前对象无用。

返回
true 表示当前对象为空,而 false 表示不为空。

◆ SetDateTime()

FSDK::ReadingBookmark::SetDateTime ( date_time  ,
is_creation_date   
)

设置日期时间信息。

参数
[in]date_time新日期时间信息。此日期对象的所有值都应有效。 请参阅类 FSDK.DateTime 的注释以获取更多详细信息。
[in]is_creation_datetrue 表示设置创建日期时间信息, false 表示设置最后修改日期时间信息。

return 无。

◆ SetPageIndex()

FSDK::ReadingBookmark::SetPageIndex ( index  )

设置目标页面的索引。

参数
[in]index新目标页面索引。有效范围: 从 0 到 (count-1)。 count 是当前阅读书签所属 PDF 文档的页面计数。 页面计数可由函数 FSDK.PDFDoc.GetPageCount 检索。
返回
无。

◆ SetTitle()

FSDK::ReadingBookmark::SetTitle ( title  )

设置标题。

参数
[in]title新标题字符串。
返回
无。