fsdk.Bookmark类 参考

Public 成员函数
def	GetAction ()
	获取动作。 更多...
def	GetColor ()
	获取用于显示标题的颜色。 更多...
def	GetDestination ()
	获取目标。 更多...
def	GetDict ()
	获取当前书签的PDF字典。 更多...
def	GetFirstChild ()
	获取第一个子书签。 更多...
def	GetNextSibling ()
	获取下一个兄弟书签。 更多...
def	GetParent ()
	获取父书签。 更多...
def	GetStyle ()
	获取用于显示标题的样式。 更多...
def	GetTitle ()
	获取标题。 更多...
def	HasChild ()
	检查当前书签是否有子书签。 更多...
def	Insert (title, position)
	根据与当前书签的关系位置插入新书签。 更多...
def	IsEmpty ()
	检查当前对象是否为空。 更多...
def	IsFirstChild ()
	检查当前书签是否为其父书签的第一个子书签。 更多...
def	IsLastChild ()
	检查当前书签是否为其父书签的最后一个子书签。 更多...
def	IsRoot ()
	检查当前书签是否为根书签。 更多...
def	MoveTo (dest_bookmark, position)
	将当前书签移动为另一个书签的子书签或兄弟书签。 更多...
def	RemoveAction ()
	删除动作。 更多...
def	SetAction (action)
	设置动作。 更多...
def	SetColor (color)
	设置用于显示标题的颜色。 更多...
def	SetDestination (destination)
	设置目标。 更多...
def	SetStyle (style)
	设置用于显示标题的样式。 更多...
def	SetTitle (title)
	设置标题。 更多...

详细描述

PDF书签也被称为"大纲"。它是一个树状结构的层次结构。它允许用户通过选择书签轻松地浏览PDF文档。 一个书签包含一个目标或动作，用来指示当用户选择它时如何响应。
为了获取/设置书签树，必须首先调用函数 fsdk.PDFDoc.GetRootBookmark 来 获取整个书签树的根。如果"根书签"不存在，可以调用函数 fsdk.PDFDoc.CreateRootBookmark 来创建一个新的"根书签"。 在这里，"根书签"是一个抽象对象。它代表PDF文档的"大纲"。 有关"大纲"的更多详细信息，请参阅PDF参考文档1.7的第8.2.3节。 "根书签"只能有一些子书签，但没有父书签， 没有下一个兄弟书签或任何数据（包括书签数据、目标数据和动作数据）。 并且"根书签"不能在应用程序UI上显示，因为它没有数据。因此，对于根书签， 只能使用函数 fsdk.Bookmark.GetFirstChild 。
从根书签开始，可以遍历书签树并访问每个书签节点。
此类提供了几个函数来从当前书签获取/设置其他书签。例如：

• 要访问父书签，请使用函数 fsdk.Bookmark.GetParent 。

• 要访问第一个子书签，请使用函数 fsdk.Bookmark.GetFirstChild 。

• 要访问下一个兄弟书签，请使用函数 fsdk.Bookmark.GetNextSibling 。

• 要插入新书签，请使用函数 fsdk.Bookmark.Insert 。

• 要移动书签，请使用函数 fsdk.Bookmark.MoveTo 。

此类还提供了获取/设置PDF书签数据的函数。

参见

PDFDoc

成员函数说明

GetAction()

def fsdk.Bookmark.GetAction

(

)

获取动作。

如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，它没有任何动作信息。在这种情况下，此函数将 返回一个动作对象，其函数 fsdk.Action.IsEmpty 返回 true。

返回

一个动作对象。

GetColor()

def fsdk.Bookmark.GetColor

(

)

获取用于显示标题的颜色。

如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，它没有颜色信息。在这种情况下，此函数将返回0x000000。

返回

颜色值。格式：0xRRGGBB。

GetDestination()

def fsdk.Bookmark.GetDestination

(

)

获取目标。

书签的目标是当前文档中书签可以"跳转到"的某个位置。 如果书签不能"跳转到"当前文档中的任何位置，这意味着无法检索目标信息， 此函数将返回一个目标对象，其函数 fsdk.Destination.IsEmpty 返回 true。
如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，它没有任何目标信息。在这种情况下，此函数将 返回一个目标对象，其函数 fsdk.Destination.IsEmpty 返回 true。

返回

目标对象。

GetDict()

def fsdk.Bookmark.GetDict

(

)

获取当前书签的PDF字典。

返回

PDF字典。如果有任何错误，此函数将返回null。

GetFirstChild()

def fsdk.Bookmark.GetFirstChild

(

)

获取第一个子书签。

返回

第一个子书签对象。

GetNextSibling()

def fsdk.Bookmark.GetNextSibling

(

)

获取下一个兄弟书签。

如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，它没有任何兄弟书签。在这种情况下，此函数将 返回一个书签对象，其函数 fsdk.Bookmark.IsEmpty 返回 true。

返回

下一个兄弟书签对象。

GetParent()

def fsdk.Bookmark.GetParent

(

)

获取父书签。

如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，它没有父书签。在这种情况下，此函数将 返回一个书签对象，其函数 fsdk.Bookmark.IsEmpty 返回 true。

返回

父书签对象。

GetStyle()

def fsdk.Bookmark.GetStyle

(

)

获取用于显示标题的样式。

如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，它没有样式信息。在这种情况下，此函数将返回 fsdk.BookmarkE_StyleNormal 。

返回

样式值。请参阅从 fsdk.BookmarkE_StyleNormal 开始的值， 这可以是这些值中的一个或它们的组合。

GetTitle()

def fsdk.Bookmark.GetTitle

(

)

获取标题。

如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，它没有标题。在这种情况下，此函数将返回一个空字符串。

返回

标题字符串。

HasChild()

def fsdk.Bookmark.HasChild

(

)

检查当前书签是否有子书签。

返回

true表示当前书签有子书签，false表示 当前书签没有任何子书签。

Insert()

def fsdk.Bookmark.Insert	(		title,
			position
	)

根据与当前书签的关系位置插入新书签。

对于新书签，颜色默认为0x000000，样式默认为 fsdk.BookmarkE_StyleNormal 。

参数

[in]	title	新书签的标题字符串。它不应该是空字符串。
[in]	position	要插入的新书签项目的位置，基于当前书签。 请参阅从 fsdk.BookmarkE_PosFirstChild 开始的值， 这应该是这些值中的一个。 如果当前书签只是"根书签"，参数position只能是 fsdk.BookmarkE_PosFirstChild 或 fsdk.BookmarkE_PosLastChild 。

返回

一个新的书签对象。

IsEmpty()

def fsdk.Bookmark.IsEmpty

(

)

检查当前对象是否为空。

当当前对象为空时，意味着当前对象是无用的。

返回

true表示当前对象为空，false表示不为空。

IsFirstChild()

def fsdk.Bookmark.IsFirstChild

(

)

检查当前书签是否为其父书签的第一个子书签。

返回

true表示当前书签是其父书签的第一个子书签， false表示不是。

IsLastChild()

def fsdk.Bookmark.IsLastChild

(

)

检查当前书签是否为其父书签的最后一个子书签。

返回

true表示当前书签是其父书签的最后一个子书签， false表示不是。

IsRoot()

def fsdk.Bookmark.IsRoot

(

)

检查当前书签是否为根书签。

"根书签"是一个抽象对象。它代表PDF文档的"大纲"。 有关"大纲"的更多详细信息，请参阅PDF参考文档1.7的第8.2.3节。 "根书签"只能有一些子书签，但没有父书签， 没有下一个兄弟书签或任何数据（包括书签数据、目标数据和动作数据）。 并且"根书签"不能在应用程序UI上显示，因为它没有数据。

返回

true表示当前书签是根书签，false表示不是。

MoveTo()

def fsdk.Bookmark.MoveTo	(		dest_bookmark,
			position
	)

将当前书签移动为另一个书签的子书签或兄弟书签。

如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，不能移动。在这种情况下，此函数将返回false。

参数

[in]	dest_bookmark	目标书签，当前书签将移动为其子书签或兄弟书签。
[in]	position	当前书签与目标书签的位置关系。 请参阅从 fsdk.BookmarkE_PosFirstChild 开始的值， 这应该是这些值中的一个。

返回

true表示成功，false表示失败。

RemoveAction()

def fsdk.Bookmark.RemoveAction

(

)

删除动作。

如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，它没有任何动作信息。在这种情况下，此函数将 直接返回true。

返回

true表示成功，false表示失败。

SetAction()

def fsdk.Bookmark.SetAction

(

action

)

设置动作。

如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，它没有任何动作信息。在这种情况下，此函数将 直接返回而不做任何事情。

参数

[in]

action

一个有效的动作对象。

返回

无。

SetColor()

def fsdk.Bookmark.SetColor

(

color

)

设置用于显示标题的颜色。

如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，它没有颜色信息。在这种情况下，此函数将直接返回而不做任何事情。

参数

[in]

color

颜色值。格式：0xRRGGBB。

返回

无。

SetDestination()

def fsdk.Bookmark.SetDestination

(

destination

)

设置目标。

书签的目标是当前文档中书签可以"跳转到"的某个位置。
如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，它没有任何目标信息。在这种情况下，此函数将 直接返回而不做任何事情。

参数

[in]

destination

一个有效的目标。

返回

无。

SetStyle()

def fsdk.Bookmark.SetStyle

(

style

)

设置用于显示标题的样式。

如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，它没有样式信息。在这种情况下，此函数将直接返回而不做任何事情。

参数

[in]

style

样式值。请参阅从 fsdk.BookmarkE_StyleNormal 开始的值， 这可以是这些值中的一个或它们的组合。 如果style无效，默认情况下将设置 fsdk.BookmarkE_StyleNormal 。

返回

无。

SetTitle()

def fsdk.Bookmark.SetTitle

(

title

)

设置标题。

如果当前书签由函数 fsdk.PDFDoc.GetRootBookmark 或 fsdk.PDFDoc.CreateRootBookmark 返回， 这意味着它是"根书签"，它没有标题。在这种情况下，此函数将直接返回而不做任何事情。

参数

[in]

title

新的标题字符串。它不应该是空字符串。

返回

无。