Public 成员函数
def	AddMenuItem (menu_item_config, is_prepend)
	向菜单添加菜单项的回调函数。更多...

def	AddSearchIndex (di_path, is_selected)
	添加搜索索引的回调函数。更多...

def	AddSubMenu (menu_item_config)
	向应用程序添加带有子菜单的菜单项的回调函数。更多...

def	AddToolButton (button_item)
	添加工具按钮的回调函数。更多...

def	Alert (msg, title, type, icon)
	弹出对话框显示警告或提示的回调函数。更多...

def	Beep (type)
	使系统播放声音的回调函数。更多...

def	BrowseFile (a, interface)
	显示文件选择对话框的回调函数，选择的文件路径应该被返回。更多...

def	BrowseFile (is_open_dialog, file_format, file_filter)
	显示文件选择对话框的回调函数。更多...

def	CloseDoc (document, is_prompt_to_save)
	关闭文档的回调函数。更多...

def	CreateBlankDoc ()
	创建空白PDF文档对象的回调函数。更多...

def	EnablePageLoop (is_loop)
	设置标志的回调函数，该标志指定在全屏模式下，文档是否会循环回到文档开头以响应页面前进（无论是由鼠标点击、键盘还是计时器生成）。更多...

def	ExecuteNamedAction (document, named_action)
	执行命名操作的回调函数。更多...

def	GetAppInfo (type)
	获取应用程序信息的回调函数。更多...

def	GetAttachmentsFilePath (pdf_doc, name)
	获取附件文件路径的回调函数。更多...

def	GetCurrentDoc ()
	接收当前PDF文档对象的回调函数。更多...

def	GetCurrentPage (document)
	用于接收当前页面索引的回调函数。更多...

def	GetDocChangeMark (document)
	接收更改标记的回调函数，该标记指示文档内容是否已更改。更多...

def	GetExtractedEmbeddedFilePath (pdf_doc, name)
	获取提取的嵌入文件路径的回调函数。更多...

def	GetFilePath (document)
	获取当前PDF文档文件路径的回调函数。更多...

def	GetFullScreen ()
	获取是否设置了全屏模式的回调函数。更多...

def	GetIdentityProperties ()
	获取当前用户身份属性的回调函数。更多...

def	GetLanguage ()
	获取正在运行的查看器应用程序语言的回调函数。更多...

def	GetLayoutMode ()
	获取当前文档页面布局的回调函数。更多...

def	GetMenuItemNameList ()
	获取菜单项名称列表的回调函数。更多...

def	GetMousePosition ()
	获取当前鼠标位置的回调函数。更多...

def	GetOpenedDoc (index)
	通过索引接收已打开PDF文档对象的回调函数。更多...

def	GetOpenedDocCount ()
	接收已打开文档数量的回调函数。更多...

def	GetPageRotation (document, page_index)
	用于接收PDF查看器中页面当前显示旋转值的回调函数。更多...

def	GetPageScale ()
	获取当前页面缩放值的回调函数。更多...

def	GetPageWindowRect (pdf_doc, page_index)
	获取页面视图窗口矩形的回调函数。页面视图窗口是内部文档窗口中显示PDF内容的区域。更多...

def	GetPageZoomMode ()
	获取当前页面缩放模式的回调函数。更多...

def	GetPrinterNameList ()
	获取打印机名称列表的回调函数。更多...

def	GetSignatureAPStyleNameList ()
	获取签名外观样式名称列表的回调函数。更多...

def	GetTemporaryDirectory ()
	获取临时目录的回调函数。更多...

def	GetTemporaryFileName (document, file_suffix_name)
	获取临时文件路径的回调函数。临时文件名将文档名与文件后缀名组合。更多...

def	GetUntitledBookmarkName ()
	获取无标题书签新名称的回调函数。更多...

def	GetVisiblePage (document, index)
	获取可见页的回调。更多...

def	GetVisiblePageCount (document)
	获取可见页页数的回调。更多...

def	InitModifyItem (document, item_type, page_index, dict_name)
	初始化修改项的回调。更多...

def	InvalidateRect (document, page_index, pdf_rect)
	使指定矩形内的客户区域无效的回调函数。更多...

def	IsCurrentDocOpenedInBrowser ()
	获取标志的回调函数，该标志指定当前文档是否在浏览器中打开。更多...

def	IsLocalFile (document)
	检查文件是否为本地文件的回调函数。更多...

def	IsPageLoop ()
	获取标志的回调函数，该标志指定文档是否会循环回到文档开头以响应页面前进。更多...

def	LaunchURL (url)
	启动到指定URL的回调函数。更多...

def	MailData (data, data_type, is_ui, to, subject, cc, bcc, message)
	发送数据或消息的回调函数，可以带有或不带有用户交互。更多...

def	MailDoc (document, to_address, cc_address, bcc_address, subject, message, is_ui)
	将文档作为附件发送邮件的回调函数。更多...

def	NotifyAfterDataChange (document, modify_item_info)
	用于通知JS执行后内容已经被修改的回调函数。更多...

def	NotifyBeginDoJob (document, event_type)
	用于通知JS开始执行的回调函数。更多...

def	NotifyEndDoJob (document, event_type)
	用于通知JS已经执行结束。更多...

def	OnFieldValueChanged (field_name, type, value_before_changed, value_after_changed)
	通知字段值变化的回调函数。更多...

def	OpenDoc (file_path, password)
	打开PDF文件的回调函数。更多...

def	OpenMediaPlayer (player_args)
	打开媒体播放器的回调函数。更多...

def	PostMessageToHtml (message)
	向PDF文档的宿主容器的消息处理程序异步发送消息的回调函数。更多...

def	Print (document, is_ui, page_range, is_silent, is_shrunk_to_fit, is_printed_as_image, is_reversed, is_to_print_annots)
	打印指定索引范围内页面的回调函数。更多...

def	Print (document, print_params)
	使用打印参数打印文档的回调函数。更多...

def	Query (keywords, search_scope, search_option, di_path)
	查询文本关键字的回调函数。更多...

def	Release ()
	用于释放当前回调对象本身的回调函数。更多...

def	RemoveSearchIndex (search_index_config)
	（保留，尚不支持）移除搜索索引的回调函数。更多...

def	RemoveToolButtom (button_name)
	移除通过函数 fsdk.ActionCallback.AddToolButton 添加的工具按钮的回调函数。更多...

def	ResetModifyItem (document)
	重置修改项的回调。更多...

def	Response (question, title, default_value, label, is_password)
	显示包含问题和输入字段供用户回复问题的对话框的回调函数。更多...

def	Scroll (point)
	将当前页面上指定点滚动到当前视图中央的回调函数。更多...

def	SelectPageNthWord (page_index, start_offset, end_offset, is_show_selection)
	更改当前页码并选择页面上指定单词的回调函数。更多...

def	SetCurrentPage (document, page_index)
	用于通过索引设置当前页面的回调函数。更多...

def	SetCurrentPage (document, destination)
	用于根据目标设置当前页面的回调函数。更多...

def	SetDefaultPageTransitionMode (trans_type, trans_di)
	设置全屏模式下默认页面过渡模式的回调函数。更多...

def	SetDocChangeMark (document, change_mark)
	设置更改标记的回调函数，该标记指示文档内容是否已更改。更多...

def	SetFullScreen (is_full_screen)
	设置全屏模式的回调函数。更多...

def	SetIdentityProperties (identity_properties)
	设置当前用户身份属性的回调函数。更多...

def	SetLayoutMode (layout_mode, is_cover_mode)
	设置当前文档页面布局的回调函数。更多...

def	SetPageRotation (document, page_index, rotation)
	用于在PDF查看器中设置页面旋转值的回调函数。更多...

def	SetPageScale (zoom_mode, dest)
	设置当前页面缩放值的回调函数。更多...

def	ShowDialog (dlg_config)
	显示对话框的回调函数。更多...

def	SoapRequest (request_params)
	启动远程过程调用 (RPC) 或向 SOAP HTTP 端点发送 XML 消息。更多...

def	SubmitForm (document, form_data, length, url, file_format_type)
	向指定URL提交表单数据的回调函数。更多...

def	UpdateLogicalLabel ()
	更新逻辑标签的回调函数。更多...

def	VerifySignature (document, pdf_signature)
	验证指定签名的回调函数。更多...

详细描述

此类表示执行PDF动作的回调对象。此类中的所有纯虚函数都用作回调函数，应由用户实现，以执行PDF动作，如JavaScript动作。

成员函数说明

◆ AddMenuItem()

def fsdk.ActionCallback.AddMenuItem	(	menu_item_config,
		is_prepend
	)

向菜单添加菜单项的回调函数。

此回调函数将由JavaScript方法"app.addMenuItem"触发。

参数

[in]	menu_item_config	菜单项的配置。
[in]	is_prepend	确定新菜单项相对于由 MenuItemConfig::pos 或 MenuItemConfig::pos_str 指定位置的位置。默认值为 false。如果此参数为 true，插入规则如下：如果使用 MenuItemConfig::pos_str，新项目将放置在命名项目之前。如果使用 MenuItemConfig::pos，新项目将放置在编号项目之前。如果找不到命名项目或位置不在零和列表中项目数之间（包括零和项目数），新项目将作为菜单中的第一个项目插入（而不是在菜单末尾）。当命名项目是组中的第一个项目时，此参数非常有用。

返回: true 表示成功，false 表示失败。

◆ AddSearchIndex()

def fsdk.ActionCallback.AddSearchIndex	(	di_path,
		is_selected
	)

添加搜索索引的回调函数。

此回调函数将由JavaScript方法"search.addIndex"触发。此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in]	di_path	用户硬盘上索引文件的设备无关路径。
[in]	is_selected	指定是否应选择索引进行搜索。默认值：true。

返回: 一个 SearchIndexConfig 。

◆ AddSubMenu()

def fsdk.ActionCallback.AddSubMenu ( menu_item_config )

向应用程序添加带有子菜单的菜单项的回调函数。

此回调函数将由JavaScript方法"app.addSubMenu"触发。

参数

[in] menu_item_config 菜单项的配置。

返回: true 表示成功，false 表示失败。

◆ AddToolButton()

def fsdk.ActionCallback.AddToolButton ( button_item )

添加工具按钮的回调函数。

此回调函数将由JavaScript方法"app.addToolButton"触发。

参数

[in] button_item 工具按钮的 ButtonItem 对象。

返回: true 表示成功，false 表示失败。

◆ Alert()

def fsdk.ActionCallback.Alert	(	msg,
		title,
		type,
		icon
	)

弹出对话框显示警告或提示的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	msg	要在对话框中显示的消息字符串。
[in]	title	对话框的标题。
[in]	type	按钮组类型。它应该是以下值之一： 0: OK;（默认值。） 1: OK, Cancel; 2: Yes, NO; 3: Yes, NO, Cancel.
[in]	icon	图标类型。它应该是以下值之一： 0: Error;（默认值。） 1: Warning; 2: Question; 3: Status.

返回

返回值应该是以下值之一：

1: OK;
2: Cancel;
3: NO;
4: Yes;

◆ Beep()

def fsdk.ActionCallback.Beep ( type )

使系统播放声音的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]

type

声音类型。值应为以下值之一：

0: 错误
1: 警告
2: 问题
3: 状态
4: 默认（默认值）

返回: true 表示成功，false 表示失败。

◆ BrowseFile() [1/2]

def fsdk.ActionCallback.BrowseFile	(	a,
		interface
	)

显示文件选择对话框的回调函数，选择的文件路径应该被返回。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 文件路径。可以是空字符串。

◆ BrowseFile() [2/2]

def fsdk.ActionCallback.BrowseFile	(	is_open_dialog,
		file_format,
		file_filter
	)

显示文件选择对话框的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	is_open_dialog	布尔值，指定对话框是用于打开文件还是保存文件。 true 表示对话框应用于打开文件，false 表示对话框应用于保存文件。
[in]	file_format	文件格式字符串。
[in]	file_filter	文件过滤器字符串。

返回: 文件路径。可以是空字符串。

◆ CloseDoc()

def fsdk.ActionCallback.CloseDoc	(	document,
		is_prompt_to_save
	)

关闭文档的回调函数。

此回调函数将由JavaScript方法"Doc.closeDoc"触发。此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in]	document	PDF文档对象。它应该是有效的。
[in]	is_prompt_to_save	true 表示显示保存提示，false 表示不显示。

返回: 无。

◆ CreateBlankDoc()

def fsdk.ActionCallback.CreateBlankDoc ( )

创建空白PDF文档对象的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 新创建的空白PDF文档对象。

◆ EnablePageLoop()

def fsdk.ActionCallback.EnablePageLoop ( is_loop )

设置标志的回调函数，该标志指定在全屏模式下，文档是否会循环回到文档开头以响应页面前进（无论是由鼠标点击、键盘还是计时器生成）。

此回调函数将由JavaScript属性"app.fs.loop"触发。此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in] is_loop true 表示循环回到文档开头，false 表示不循环。

返回: 无。

◆ ExecuteNamedAction()

def fsdk.ActionCallback.ExecuteNamedAction	(	document,
		named_action
	)

执行命名操作的回调函数。

请参考<PDF Reference 1.7>第8.5.3节中"命名操作"的描述以获取更多详细信息。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	document	PDF文档对象。它应该是有效的。
[in]	named_action	指定命名操作的字符串。

返回: true 表示成功，false 表示失败。

◆ GetAppInfo()

def fsdk.ActionCallback.GetAppInfo ( type )

获取应用程序信息的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。
对于数字信息，如 fsdk.ActionCallbackE_AppInfoTypeViewerVersion 、fsdk.ActionCallbackE_AppInfoTypeAppVersion 和 fsdk.ActionCallbackE_AppInfoTypeFormsVersion ，请使用字符串来表示。

参数

[in] type 信息类型。请参考从 fsdk.ActionCallbackE_AppInfoTypeFormsVersion 开始的值，它应该是这些值中的一个。

返回: 应用程序信息。

◆ GetAttachmentsFilePath()

def fsdk.ActionCallback.GetAttachmentsFilePath	(	pdf_doc,
		name
	)

获取附件文件路径的回调函数。

此回调函数将由JavaScript方法"Doc.importDataObject"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	pdf_doc	PDF文档对象。它将嵌入一个数据对象。
[in]	name	与数据对象关联的名称。这是方法"Doc.importDataObject"的参数"cName"。

返回: 将作为数据对象嵌入的文件路径。

◆ GetCurrentDoc()

def fsdk.ActionCallback.GetCurrentDoc ( )

接收当前PDF文档对象的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 当前PDF文档对象。

◆ GetCurrentPage()

def fsdk.ActionCallback.GetCurrentPage ( document )

用于接收当前页面索引的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in] document PDF文档对象。它应该是有效的。

返回: 当前页面索引。该值应该从0开始，小于指定文档的页数。

◆ GetDocChangeMark()

def fsdk.ActionCallback.GetDocChangeMark ( document )

接收更改标记的回调函数，该标记指示文档内容是否已更改。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in] document PDF文档对象。它应该是有效的。

返回: true 表示PDF文档已更改，false 表示未更改。

◆ GetExtractedEmbeddedFilePath()

def fsdk.ActionCallback.GetExtractedEmbeddedFilePath	(	pdf_doc,
		name
	)

获取提取的嵌入文件路径的回调函数。

此回调函数将由JavaScript方法"Doc.exportDataObject"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	pdf_doc	PDF文档对象。它将作为数据对象嵌入到文件中。
[in]	name	要提取的数据对象的名称。这是方法"Doc.exportDataObject"的参数"cName"。

返回: 将嵌入数据对象的文件路径。

◆ GetFilePath()

def fsdk.ActionCallback.GetFilePath ( document )

获取当前PDF文档文件路径的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in] document PDF文档对象。它应该是有效的。

返回: 文件路径。

◆ GetFullScreen()

def fsdk.ActionCallback.GetFullScreen ( )

获取是否设置了全屏模式的回调函数。

此回调函数将由JavaScript属性"app.fullScreen"或"app.fs.isFullScreen"触发。

返回: true 表示设置了全屏模式，false 表示未设置。

◆ GetIdentityProperties()

def fsdk.ActionCallback.GetIdentityProperties ( )

获取当前用户身份属性的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 指定当前用户身份属性的身份属性对象。

◆ GetLanguage()

def fsdk.ActionCallback.GetLanguage ( )

获取正在运行的查看器应用程序语言的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 语言类型。请参考从 fsdk.ActionCallbackE_LanguageUnknown 开始的值，它应该是这些值中的一个。

◆ GetLayoutMode()

def fsdk.ActionCallback.GetLayoutMode ( )

获取当前文档页面布局的回调函数。

此回调函数将由JavaScript属性"Doc.layout"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 布局模式。请参考从 fsdk.ActionCallbackE_LayoutModeSinglePage 开始的值，它应该是这些值中的一个。

◆ GetMenuItemNameList()

def fsdk.ActionCallback.GetMenuItemNameList ( )

获取菜单项名称列表的回调函数。

此回调函数将由JavaScript方法"app.listMenuItems"触发。

返回: 菜单列表对象的数组。

◆ GetMousePosition()

def fsdk.ActionCallback.GetMousePosition ( )

获取当前鼠标位置的回调函数。

此回调函数将由JavaScript属性"doc.mouseX"或"doc.mouseY"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 设备坐标系统中的位置。

◆ GetOpenedDoc()

def fsdk.ActionCallback.GetOpenedDoc ( index )

通过索引接收已打开PDF文档对象的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in] index 已打开PDF文档的索引。有效范围：从0到 count-1。 count 由回调函数 fsdk.ActionCallback.GetOpenedDocCount 返回；

返回: 已打开的PDF文档对象。

◆ GetOpenedDocCount()

def fsdk.ActionCallback.GetOpenedDocCount ( )

接收已打开文档数量的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 已打开文档的数量。

◆ GetPageRotation()

def fsdk.ActionCallback.GetPageRotation	(	document,
		page_index
	)

用于接收PDF查看器中页面当前显示旋转值的回调函数。

此回调函数是可选的，可以实现为不执行任何操作，仅返回一个无用的值。

参数

[in]	document	PDF文档对象。该对象应当是有效的。
[in]	page_index	页面索引，用于指定要获取旋转值的页面。索引从0开始，应小于指定文档的页面总数。

返回: 指定页面的旋转值。请参考从 fsdk.E_Rotation0 开始的值，应当是这些值中的一个。

◆ GetPageScale()

def fsdk.ActionCallback.GetPageScale ( )

获取当前页面缩放值的回调函数。

此回调函数将由JavaScript属性"Doc.zoom"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 缩放值。例如，缩放值 1.0 表示 100。它应该是一个正数。

◆ GetPageWindowRect()

def fsdk.ActionCallback.GetPageWindowRect	(	pdf_doc,
		page_index
	)

获取页面视图窗口矩形的回调函数。页面视图窗口是内部文档窗口中显示PDF内容的区域。

参数

[in] page_index 页面索引。

此回调函数将由JavaScript属性"Doc.pageWindowRect"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 页面视图窗口的矩形。

◆ GetPageZoomMode()

def fsdk.ActionCallback.GetPageZoomMode ( )

获取当前页面缩放模式的回调函数。

此回调函数将由JavaScript属性"Doc.zoom"或"Doc.zoomType"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 缩放模式。请参考从 fsdk.DestinationE_ZoomXYZ 开始的值，它应该是这些值中的一个。

◆ GetPrinterNameList()

def fsdk.ActionCallback.GetPrinterNameList ( )

获取打印机名称列表的回调函数。

此回调函数将由JavaScript属性"app.printerNames"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 打印机名称数组。

◆ GetSignatureAPStyleNameList()

def fsdk.ActionCallback.GetSignatureAPStyleNameList ( )

获取签名外观样式名称列表的回调函数。

此回调函数将由JavaScript方法"SecurityHandler.appearances"触发。此回调函数是可选的，因此可以实现为不做任何事情。

返回: 签名外观样式名称的数组。

◆ GetTemporaryDirectory()

def fsdk.ActionCallback.GetTemporaryDirectory ( )

获取临时目录的回调函数。

此回调函数将由JavaScript方法"Doc.extractpages"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

◆ GetTemporaryFileName()

def fsdk.ActionCallback.GetTemporaryFileName	(	document,
		file_suffix_name
	)

获取临时文件路径的回调函数。临时文件名将文档名与文件后缀名组合。

此回调函数将由JavaScript方法"Doc.mailForm"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	document	PDF文档对象。它应该是有效的。
[in]	file_suffix_name	文件后缀名。

返回: 临时文件路径。

◆ GetUntitledBookmarkName()

def fsdk.ActionCallback.GetUntitledBookmarkName ( )

获取无标题书签新名称的回调函数。

当JavaScript方法"bookmark.createChild"的参数"cName"为空字符串时，将触发此回调函数。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 无标题书签的新名称。

◆ GetVisiblePage()

def fsdk.ActionCallback.GetVisiblePage	(	document,
		index
	)

获取可见页的回调。

此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in]	document	PDF文档对象，它应该有效。
[in]	index	可见页索引。有效范围: 从 0 到 (count-1)。 count 由接口返回。

返回: 可见页在PDF文档中的索引。

◆ GetVisiblePageCount()

def fsdk.ActionCallback.GetVisiblePageCount ( document )

获取可见页页数的回调。

此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in] document PDF文档对象，它应该有效。

返回: 可见页页数。

◆ InitModifyItem()

def fsdk.ActionCallback.InitModifyItem	(	document,
		item_type,
		page_index,
		dict_name
	)

初始化修改项的回调。

此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in]	document	PDF文档对象，它应该有效。
[in]	item_type	修改项类型。请参考值从，它的值应该是这些值中的一个。 page_index 被修改的页面索引。 dict_name 字典名称。无。

◆ InvalidateRect()

def fsdk.ActionCallback.InvalidateRect	(	document,
		page_index,
		pdf_rect
	)

使指定矩形内的客户区域无效的回调函数。

所有位置都以PDF"用户空间"测量。实现应调用函数 fsdk.Renderer.StartRender 来重绘指定的页面区域。

参数

[in]	document	PDF文档对象。它应该是有效的。
[in]	page_index	页面索引。它应该从0开始，小于指定文档的页数。
[in]	pdf_rect	指定中页面区域的矩形。如果这是一个空矩形，表示刷新整个页面。

返回: true 表示成功，false 表示失败。

◆ IsCurrentDocOpenedInBrowser()

def fsdk.ActionCallback.IsCurrentDocOpenedInBrowser ( )

获取标志的回调函数，该标志指定当前文档是否在浏览器中打开。

此回调函数将由JavaScript属性"doc.hostContainer"触发。此回调函数是可选的，因此可以实现为不做任何事情。

返回: true 表示当前文档在浏览器中打开，false 表示未在浏览器中打开。

◆ IsLocalFile()

def fsdk.ActionCallback.IsLocalFile ( document )

检查文件是否为本地文件的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in] document PDF文档对象。它应该是有效的。

返回: true 表示PDF文件是本地文件。

◆ IsPageLoop()

def fsdk.ActionCallback.IsPageLoop ( )

获取标志的回调函数，该标志指定文档是否会循环回到文档开头以响应页面前进。

此回调函数将由JavaScript属性"app.fs.loop"触发。此回调函数是可选的，因此可以实现为不做任何事情。

返回: true 表示循环回到文档开头，false 表示不循环。

◆ LaunchURL()

def fsdk.ActionCallback.LaunchURL ( url )

启动到指定URL的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in] url 一个URL。

返回: true 表示成功，false 表示失败。

◆ MailData()

def fsdk.ActionCallback.MailData	(	data,
		data_type,
		is_ui,
		to,
		subject,
		cc,
		bcc,
		message
	)

发送数据或消息的回调函数，可以带有或不带有用户交互。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	data	要发送的数据。数据的值和类型取决于参数 data_type：当参数 data_type 为 fsdk.ActionCallbackE_MailTypeMsg 时，应为 null。当参数 data_type 为 fsdk.ActionCallbackE_MailTypeForm 时，应表示一个 WString 对象。当参数 data_type 为 fsdk.ActionCallbackE_MailTypeDoc 时，应表示一个 fsdk.PDFDoc 对象。
[in]	data_type	邮件类型。请参考从 fsdk.ActionCallbackE_MailTypeDoc 开始的值，它应该是这些值中的一个。
[in]	is_ui	true 表示其余参数用于填充显示给用户的新消息编写窗口。 false 表示参数 to 是必需的，其他所有参数都是可选的。
[in]	to	指定消息收件人的分号分隔列表的字符串。
[in]	subject	指定消息主题的字符串。此字符串长度限制为 64 KB。
[in]	cc	指定消息抄送收件人的分号分隔列表的字符串。
[in]	bcc	指定消息密送收件人的分号分隔列表的字符串。
[in]	message	指定消息内容的字符串。此字符串长度限制为 64 KB。

返回: true 表示成功，false 表示失败。

◆ MailDoc()

def fsdk.ActionCallback.MailDoc	(	document,
		to_address,
		cc_address,
		bcc_address,
		subject,
		message,
		is_ui
	)

将文档作为附件发送邮件的回调函数。

此回调函数将由JavaScript方法"Doc.mailDoc"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	document	PDF文档对象。它应该是有效的。
[in]	to_address	收件人地址。
[in]	cc_address	抄送地址。
[in]	bcc_address	密送地址。
[in]	subject	邮件主题。
[in]	message	邮件消息。
[in]	is_ui	true 表示显示邮件对话框，false 表示不显示。

返回: 邮件结果。请参考从 fsdk.ActionCallbackE_JSMailResultFailed 开始的值，它应该是这些值中的一个。

◆ NotifyAfterDataChange()

def fsdk.ActionCallback.NotifyAfterDataChange	(	document,
		modify_item_info
	)

用于通知JS执行后内容已经被修改的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in]	document	PDF文档对象，它应该有效。
[in]	modify_item_info	JavascriptModifyItemInfo 对象，它包含修改细节。

返回: None.

◆ NotifyBeginDoJob()

def fsdk.ActionCallback.NotifyBeginDoJob	(	document,
		event_type
	)

用于通知JS开始执行的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in]	document	PDF文档对象，它应该有效。
[in]	event_type	JS事件类型。请参考值 fsdk.JavascriptModifyItemInfoE_JavascriptEventTypeUnknown ，它的值应该是这些值中的一个。

返回: None.

◆ NotifyEndDoJob()

def fsdk.ActionCallback.NotifyEndDoJob	(	document,
		event_type
	)

用于通知JS已经执行结束。

此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in]	document	PDF文档对象，它应该有效。
[in]	event_type	JS事件类型。请参考值 fsdk.JavascriptModifyItemInfoE_JavascriptEventTypeUnknown ，它的值应该是这些值中的一个。

返回: None.

◆ OnFieldValueChanged()

def fsdk.ActionCallback.OnFieldValueChanged	(	field_name,
		type,
		value_before_changed,
		value_after_changed
	)

通知字段值变化的回调函数。

当字段的值通过JavaScript更改时，将触发此回调函数。

参数

[in]	field_name	指定字段名称的字符串。
[in]	type	字段值变化类型。请参考从 fsdk.ActionCallbackE_JSFieldValueChangedByFormat 开始的值，它应该是这些值中的一个。
[in]	value_before_changed	指定字段变化前值的字符串数组。对于列表框，该参数表示同时被选择的字段的一个或多个项目。
[in]	value_after_changed	指定字段变化后值的字符串数组。对于列表框，该参数表示同时被选择的字段的一个或多个项目。

返回: 无。

◆ OpenDoc()

def fsdk.ActionCallback.OpenDoc	(	file_path,
		password
	)

打开PDF文件的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	file_path	现有PDF文件的完整路径。
[in]	password	输入PDF文件的密码。这可能是一个空字符串。

返回: 已打开的PDF文档对象。

◆ OpenMediaPlayer()

def fsdk.ActionCallback.OpenMediaPlayer ( player_args )

打开媒体播放器的回调函数。

此回调函数将由JavaScript方法"app.media.openPlayer"或"app.media.createPlayer"触发。

参数

[in] player_args PlayerArgs 对象。

返回: 一个 MediaPlayerCallback 对象。

◆ PostMessageToHtml()

def fsdk.ActionCallback.PostMessageToHtml ( message )

向PDF文档的宿主容器的消息处理程序异步发送消息的回调函数。

要传递此消息，宿主容器（例如，HTML页面中的<OBJECT>元素）必须通过设置其messageHandler属性来注册通知。
此回调函数将由JavaScript方法"doc.hostContainer.postMessage"触发。此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in] message 指定要发布的消息的字符串数组。

返回: 无。

◆ Print() [1/2]

def fsdk.ActionCallback.Print	(	document,
		is_ui,
		page_range,
		is_silent,
		is_shrunk_to_fit,
		is_printed_as_image,
		is_reversed,
		is_to_print_annots
	)

打印指定索引范围内页面的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	document	PDF文档对象。它应该是有效的。
[in]	is_ui	true 表示应向用户显示UI 以获取打印信息并确认操作。
[in]	page_range	指定打印页面范围的范围对象。此范围中表示的所有索引都从0开始，小于指定文档的页面数。
[in]	is_silent	true 表示在文档打印时应禁止显示取消对话框。
[in]	is_shrunk_to_fit	true 表示页面应缩小（如果需要）以适应打印页面的区域。
[in]	is_printed_as_image	true 表示页面应作为图像打印。
[in]	is_reversed	true 表示打印顺序应从参数 end 到参数 start。
[in]	is_to_print_annots	true 表示注释应与页面一起打印。

返回: true 表示成功，false 表示失败。

◆ Print() [2/2]

def fsdk.ActionCallback.Print	(	document,
		print_params
	)

使用打印参数打印文档的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	document	PDF文档对象。它应该是有效的。
[in]	print_params	一个 PrintParams 对象。

返回: true 表示成功，false 表示失败。

◆ Query()

def fsdk.ActionCallback.Query	(	keywords,
		search_scope,
		search_option,
		di_path
	)

查询文本关键字的回调函数。

此回调函数将由JavaScript方法"search.query"触发。此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in]	keywords	要搜索的文本内容。
[in]	search_scope	指定文本应在何处搜索。请参考从 fsdk.ActionCallbackE_SearchScopeActiveDoc 开始的值，它应该是这些值中的一个。
[in]	search_option	表示搜索选项的 SearchOption 对象。
[in]	di_path	用户计算机上文件夹或搜索索引的设备无关路径。此参数是可选的。当 search_scope 为 fsdk.ActionCallbackE_SearchScopeFolder 或 fsdk.ActionCallbackE_SearchScopeIndex 时，此参数是必需的。

返回: 无。

◆ Release()

def fsdk.ActionCallback.Release ( )

用于释放当前回调对象本身的回调函数。

返回: None.

◆ RemoveSearchIndex()

def fsdk.ActionCallback.RemoveSearchIndex ( search_index_config )

（保留，尚不支持）移除搜索索引的回调函数。

此回调函数将由JavaScript方法"search.removeIndex"触发。此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in] search_index_config 表示搜索索引配置的 SearchIndexConfig 。

返回: true 表示成功，false 表示失败。

◆ RemoveToolButtom()

def fsdk.ActionCallback.RemoveToolButtom ( button_name )

移除通过函数 fsdk.ActionCallback.AddToolButton 添加的工具按钮的回调函数。

此回调函数将由JavaScript方法"app.removeToolButton"触发。

参数

[in] button_name 工具按钮的名称。

返回: true 表示成功，false 表示失败。

◆ ResetModifyItem()

def fsdk.ActionCallback.ResetModifyItem ( document )

重置修改项的回调。

此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in] document PDF文档对象，它应该有效。

返回: 无。

◆ Response()

def fsdk.ActionCallback.Response	(	question,
		title,
		default_value,
		label,
		is_password
	)

显示包含问题和输入字段供用户回复问题的对话框的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	question	指定向用户提出的问题的字符串。
[in]	title	指定对话框标题的字符串。
[in]	default_value	指定作为问题答案的默认值的字符串。如果未指定答案，则不显示默认值。
[in]	label	指定在编辑文本字段前面显示的短字符串。
[in]	is_password	布尔值，指示用户的响应是否应被掩码显示： true 表示用户的响应应显示为星号 (*) 或项目符号 (?) 来掩码响应，这可能是敏感信息。

返回: 用户的响应。可以是空字符串。

◆ Scroll()

def fsdk.ActionCallback.Scroll ( point )

将当前页面上指定点滚动到当前视图中央的回调函数。

此回调函数将由JavaScript方法"Doc.scroll"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in] point 指定的点[PDF坐标系统]。

返回: 无。

◆ SelectPageNthWord()

def fsdk.ActionCallback.SelectPageNthWord	(	page_index,
		start_offset,
		end_offset,
		is_show_selection
	)

更改当前页码并选择页面上指定单词的回调函数。

此回调函数将由JavaScript方法"Doc.selectPageNthWord"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	page_index	页面索引。
[in]	start_offset	起始单词偏移量。
[in]	end_offset	结束单词偏移量。
[in]	is_show_selection	true 表示显示选择，false 表示不显示。

返回: 无。

◆ SetCurrentPage() [1/2]

def fsdk.ActionCallback.SetCurrentPage	(	document,
		page_index
	)

用于通过索引设置当前页面的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in]	document	PDF文档对象。它应该是有效的。
[in]	page_index	用于更改当前页面的页面索引。索引应该从0开始，小于指定文档的页数。

返回: None.

◆ SetCurrentPage() [2/2]

def fsdk.ActionCallback.SetCurrentPage	(	document,
		destination
	)

用于根据目标设置当前页面的回调函数。

此回调函数是可选的，可以实现为不执行任何操作。

参数

[in]	document	PDF文档对象。该对象应当是有效的。
[in]	destination

◆ SetDefaultPageTransitionMode()

def fsdk.ActionCallback.SetDefaultPageTransitionMode	(	trans_type,
		trans_di
	)

设置全屏模式下默认页面过渡模式的回调函数。

此回调函数将由JavaScript属性"app.fs.defaultTransition"触发。此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in]	trans_type	指定过渡效果类型的字符串。请参考以下值： "Split", "Box", "Fly", "Blinds", "Push", "Wipe", "Glitter", "Cover", "Uncover", "Dissolve", "Replace", "Fade"。
[in]	trans_di	指定过渡效果方向的字符串。对于 "Split"，此值可以是 "HorizontalInward", "HorizontalOutward", "VerticalInward" 或 "VerticalOutward"。对于 "Box"，此值可以是 "Outward" 或 "Inward"。对于 "Fly" 和 "Push"，此值可以是 "Left", "Right", "Up" 或 "Down"。对于 "Blinds"，此值可以是 "Horizontal" 或 "Vertical"。对于 "Wipe", "Glitter", "Uncover" 和 "Cover"，此值可以是 "Left","LeftUp", "LeftDown", "Right", "RightUp", "RightDown","Up" 或 "Down"。对于 "Dissolve", "Replace" 和 "Fade"，此值将为 NULL。

返回: 无。

◆ SetDocChangeMark()

def fsdk.ActionCallback.SetDocChangeMark	(	document,
		change_mark
	)

设置更改标记的回调函数，该标记指示文档内容是否已更改。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	document	PDF文档对象。它应该是有效的。
[in]	change_mark	指示文档内容是否已更改的布尔值。

返回: true 表示成功，false 表示失败。

◆ SetFullScreen()

def fsdk.ActionCallback.SetFullScreen ( is_full_screen )

设置全屏模式的回调函数。

当JavaScript属性"app.fullScreen"或"app.fs.isFullScreen"要被设置时，将触发此回调函数。

参数

[in] is_full_screen true 表示设置全屏模式，false 表示不设置。

返回: 无。

◆ SetIdentityProperties()

def fsdk.ActionCallback.SetIdentityProperties ( identity_properties )

设置当前用户身份属性的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in] identity_properties 要设置的身份属性对象。

返回: true 表示成功，false 表示失败。

◆ SetLayoutMode()

def fsdk.ActionCallback.SetLayoutMode	(	layout_mode,
		is_cover_mode
	)

设置当前文档页面布局的回调函数。

此回调函数将由JavaScript属性"Doc.layout"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	layout_mode	布局模式。请参考从 fsdk.ActionCallbackE_LayoutModeSinglePage 开始的值，它应该是这些值中的一个。
[in]	is_cover_mode	true 表示封面将始终单独显示，false 表示不单独显示。

返回: 无。

◆ SetPageRotation()

def fsdk.ActionCallback.SetPageRotation	(	document,
		page_index,
		rotation
	)

用于在PDF查看器中设置页面旋转值的回调函数。

此回调函数是可选的，可以实现为不执行任何操作。

参数

[in]	document	PDF文档对象。该对象应当是有效的。
[in]	page_index	页面索引，用于指定要更改旋转的页面。索引从0开始，应小于指定文档的页面总数。
[in]	rotation	新的旋转值。请参考从 fsdk.E_Rotation0 开始的值，应当是这些值中的一个，但不能是 fsdk.E_RotationUnknown 。

返回: true 表示成功，false 表示失败。

◆ SetPageScale()

def fsdk.ActionCallback.SetPageScale	(	zoom_mode,
		dest
	)

设置当前页面缩放值的回调函数。

此回调函数将由JavaScript属性"Doc.zoom"或"Doc.zoomType"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	zoom_mode	缩放模式。请参考从 fsdk.DestinationE_ZoomXYZ 开始的值，它应该是这些值中的一个。
[in]	dest	表示目标数据的 fsdk.Destination 对象。

返回: 无。

◆ ShowDialog()

def fsdk.ActionCallback.ShowDialog ( dlg_config )

显示对话框的回调函数。

此回调函数将由JavaScript方法"app.execDialog"触发。

参数

[in] dlg_config DialogDescriptionConfig 对象。

返回: true 表示成功，false 表示失败。

◆ SoapRequest()

def fsdk.ActionCallback.SoapRequest ( request_params )

启动远程过程调用 (RPC) 或向 SOAP HTTP 端点发送 XML 消息。

该方法要么等待端点回复（同步处理），要么调用通知对象上的方法（异步处理）。
此回调函数将由JavaScript方法"SOAP.request"触发。此回调函数是可选的，因此可以实现为不做任何事情。

参数

[in] request_params 包含 SOAP 请求属性参数的 SOAPRequestProperties 对象。

返回: 一个 SOAPResponseInfo 对象。

◆ SubmitForm()

def fsdk.ActionCallback.SubmitForm	(	document,
		form_data,
		length,
		url,
		file_format_type
	)

向指定URL提交表单数据的回调函数。

此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

参数

[in]	document	PDF文档对象。它应该是有效的。
[in]	form_data	要提交的表单数据缓冲区。
[in]	length	缓冲区参数 form_data 的大小（以字节为单位）。
[in]	url	表单数据将被提交到的URL。
[in]	file_format_type	提交表单的文件格式类型。请参考从 fsdk.E_FileFormatTypeFDF 开始的值，它应该是这些值中的一个。

返回: true 表示成功，false 表示失败。

◆ UpdateLogicalLabel()

def fsdk.ActionCallback.UpdateLogicalLabel ( )

更新逻辑标签的回调函数。

此回调函数将由JavaScript方法"Doc.setPageLabels"触发。此回调函数是可选的，因此可以实现为不做任何事情，只返回一个无用的值。

返回: 无。

◆ VerifySignature()

def fsdk.ActionCallback.VerifySignature	(	document,
		pdf_signature
	)

验证指定签名的回调函数。

当动作需要验证签名时，将触发此回调函数。如果用户不想验证签名，只需实现此函数不做任何事情，只返回 fsdk.SignatureE_StateUnknown 。建议用户使用类 fsdk.LTVVerifier 来验证已签名的签名是否有效。

参数

[in]	document	PDF文档对象。它应该是有效的。
[in]	pdf_signature	已签名的PDF签名。此签名属于输入参数 document。

返回: 签名验证状态。请参考从 fsdk.SignatureE_StateUnknown 开始的值，它应该是其中的一个或多个的组合。

Public 成员函数

详细描述

成员函数说明

◆ AddMenuItem()

◆ AddSearchIndex()

◆ AddSubMenu()

◆ AddToolButton()

◆ Alert()

◆ Beep()

◆ BrowseFile() [1/2]

◆ BrowseFile() [2/2]

◆ CloseDoc()

◆ CreateBlankDoc()

◆ EnablePageLoop()

◆ ExecuteNamedAction()

◆ GetAppInfo()

◆ GetAttachmentsFilePath()

◆ GetCurrentDoc()

◆ GetCurrentPage()

◆ GetDocChangeMark()

◆ GetExtractedEmbeddedFilePath()

◆ GetFilePath()

◆ GetFullScreen()

◆ GetIdentityProperties()

◆ GetLanguage()

◆ GetLayoutMode()

◆ GetMenuItemNameList()

◆ GetMousePosition()

◆ GetOpenedDoc()

◆ GetOpenedDocCount()

◆ GetPageRotation()

◆ GetPageScale()

◆ GetPageWindowRect()

◆ GetPageZoomMode()

◆ GetPrinterNameList()

◆ GetSignatureAPStyleNameList()

◆ GetTemporaryDirectory()

◆ GetTemporaryFileName()

◆ GetUntitledBookmarkName()

◆ GetVisiblePage()

◆ GetVisiblePageCount()

◆ InitModifyItem()

◆ InvalidateRect()

◆ IsCurrentDocOpenedInBrowser()

◆ IsLocalFile()

◆ IsPageLoop()

◆ LaunchURL()

◆ MailData()

◆ MailDoc()

◆ NotifyAfterDataChange()

◆ NotifyBeginDoJob()

◆ NotifyEndDoJob()

◆ OnFieldValueChanged()

◆ OpenDoc()

◆ OpenMediaPlayer()

◆ PostMessageToHtml()

◆ Print() [1/2]

◆ Print() [2/2]

◆ Query()

◆ Release()

◆ RemoveSearchIndex()

◆ RemoveToolButtom()

◆ ResetModifyItem()

◆ Response()

◆ Scroll()

◆ SelectPageNthWord()

◆ SetCurrentPage() [1/2]

◆ SetCurrentPage() [2/2]

◆ SetDefaultPageTransitionMode()

◆ SetDocChangeMark()

◆ SetFullScreen()

◆ SetIdentityProperties()

◆ SetLayoutMode()

◆ SetPageRotation()

◆ SetPageScale()

◆ ShowDialog()

◆ SoapRequest()

◆ SubmitForm()

◆ UpdateLogicalLabel()

◆ VerifySignature()