Public 成员函数
def	GetEditingTextCaretPosition (matrix)
	当文本字段或组合框处于编辑状态时获取文本光标位置。更多...

def	HighlightFormFields (is_highlight)
	决定是否高亮显示表单字段（包括签名字段）。更多...

def	IsEmpty ()
	检查当前对象是否为空。更多...

def	KillFocus ()
	从表单中移除焦点。更多...

def	OnChar (char_code, flags)
	当字符代码即将输入到表单字段时调用此函数。更多...

def	OnCopy ()
	当弹出菜单项"复制"按下时调用此函数。更多...

def	OnCut ()
	当弹出菜单项"剪切"按下时调用此函数。更多...

def	OnDelete ()
	当弹出菜单项"删除"按下时调用此函数。更多...

def	OnKeyDown (key_code, flags)
	当键盘上的键按下时调用此函数。更多...

def	OnKeyUp (key_code, flags)
	当键盘上的键抬起时调用此函数。更多...

def	OnLButtonDoubleClick (page, point, flags)
	当鼠标左键双击时调用此函数。更多...

def	OnLButtonDown (page, point, flags)
	当鼠标左键按下时调用此函数。更多...

def	OnLButtonUp (page, point, flags)
	当鼠标左键抬起时调用此函数。更多...

def	OnMouseEnter (page, point, flags)
	（保留，尚未支持）当鼠标进入某处时调用此函数。更多...

def	OnMouseHover (page, point, flags)
	（保留，尚未支持）当鼠标悬停在某处时调用此函数。更多...

def	OnMouseLeave (page, point, flags)
	（保留，尚未支持）当鼠标离开某处时调用此函数。更多...

def	OnMouseMove (page, point, flags)
	当鼠标移动时调用此函数。更多...

def	OnMouseWheel (page, point, delta, flags)
	（保留，尚未支持）当鼠标滚轮移动时调用此函数。更多...

def	OnPaste ()
	当弹出菜单项"粘贴"按下时调用此函数。更多...

def	OnRButtonDoubleClick (page, point, flags)
	（保留，尚未支持）当鼠标右键双击时调用此函数。更多...

def	OnRButtonDown (page, point, flags)
	当鼠标右键按下时调用此函数。更多...

def	OnRButtonUp (page, point, flags)
	当鼠标右键抬起时调用此函数。更多...

def	OnSelectAll ()
	当弹出菜单项"全选"按下时调用此函数。更多...

def	OnWheelButtonDoubleClick (page, point, flags)
	（保留，尚未支持）当鼠标滚轮按钮双击时调用此函数。更多...

def	OnWheelButtonDown (page, point, flags)
	（保留，尚未支持）当鼠标滚轮按钮按下时调用此函数。更多...

def	OnWheelButtonUp (page, point, flags)
	（保留，尚未支持）当鼠标滚轮按钮抬起时调用此函数。更多...

def	Render (page, matrix, renderer)
	在页面上绘制当前获得焦点的表单控件。更多...

def	SetFocus (control)
	将焦点设置到表单控件上。更多...

def	SetHighlightColor (color)
	设置用于高亮显示表单字段的高亮颜色。更多...

def	ShowOverflowIndicator (is_show_overflow_indicator)
	决定当文本字段中的文本溢出时是否显示溢出指示器。更多...

详细描述

此类表示用于填充PDF表单的表单填充器。对于一个交互式表单应该只有一个表单填充器对象，因此不要为一个Form 对象构造超过一个表单填充器。建议用户实现fsdk.ActionCallback 并通过fsdk.LibrarySetActionCallback 函数将其设置到Foxit PDF SDK，以便实现表单填充器的更多功能。

参见: fsdk.Library

成员函数说明

◆ GetEditingTextCaretPosition()

def fsdk.Filler.GetEditingTextCaretPosition ( matrix )

当文本字段或组合框处于编辑状态时获取文本光标位置。

参数

[in] matrix 用于将返回位置转换到设备坐标系统的矩阵。

返回: 设备坐标系统中文本光标顶部的位置。
(-1,-1) 表示没有文本字段或组合框处于编辑状态。

◆ HighlightFormFields()

def fsdk.Filler.HighlightFormFields ( is_highlight )

决定是否高亮显示表单字段（包括签名字段）。

决定是否高亮显示签名字段和其他表单字段。

除按钮字段外，所有类型的表单字段都可以高亮显示。如果不调用此函数，Foxit PDF SDK默认会高亮显示所有表单字段（包括签名字段）。

参数

[in] is_highlight true 表示高亮显示表单字段（包括签名字段）， false 表示不高亮显示表单字段（包括签名字段）。

返回: 无。

除按钮字段外，所有类型的表单字段都可以高亮显示。如果不调用此函数，Foxit PDF SDK默认会高亮显示除签名字段外的所有表单字段（签名字段默认不高亮显示）。

参数

[in]	is_highlight	此布尔值用于非签名字段： true 表示高亮显示表单字段，false 表示不高亮显示表单字段。
[in]	is_sign_highlight	此布尔值仅用于签名字段： true 表示高亮显示签名字段，false 表示不高亮显示签名字段。

返回: 无。

◆ IsEmpty()

def fsdk.Filler.IsEmpty ( )

检查当前对象是否为空。

当当前对象为空时，表示当前对象无用。

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

◆ KillFocus()

def fsdk.Filler.KillFocus ( )

从表单中移除焦点。

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

◆ OnChar()

def fsdk.Filler.OnChar	(	char_code,
		flags
	)

当字符代码即将输入到表单字段时调用此函数。

参数

[in]	char_code	字符代码，采用UTF16-LE编码。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

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

◆ OnCopy()

def fsdk.Filler.OnCopy ( )

当弹出菜单项"复制"按下时调用此函数。

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

◆ OnCut()

def fsdk.Filler.OnCut ( )

当弹出菜单项"剪切"按下时调用此函数。

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

◆ OnDelete()

def fsdk.Filler.OnDelete ( )

当弹出菜单项"删除"按下时调用此函数。

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

◆ OnKeyDown()

def fsdk.Filler.OnKeyDown	(	key_code,
		flags
	)

当键盘上的键按下时调用此函数。

参数

[in]	key_code	键码。请参考从fsdk.FillerE_VkeyUnknown 开始的值，这应该是这些值中的一个。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。目前此函数尚不支持使用，因此此函数将始终返回true。

◆ OnKeyUp()

def fsdk.Filler.OnKeyUp	(	key_code,
		flags
	)

当键盘上的键抬起时调用此函数。

参数

[in]	key_code	键码。请参考从fsdk.FillerE_VkeyUnknown 开始的值，这应该是这些值中的一个。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。目前此函数尚不支持使用，因此此函数将始终返回true。

◆ OnLButtonDoubleClick()

def fsdk.Filler.OnLButtonDoubleClick	(	page,
		point,
		flags
	)

当鼠标左键双击时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的点，在中。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

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

◆ OnLButtonDown()

def fsdk.Filler.OnLButtonDown	(	page,
		point,
		flags
	)

当鼠标左键按下时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键按下的点，在中。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

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

◆ OnLButtonUp()

def fsdk.Filler.OnLButtonUp	(	page,
		point,
		flags
	)

当鼠标左键抬起时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的点，在中。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

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

◆ OnMouseEnter()

def fsdk.Filler.OnMouseEnter	(	page,
		point,
		flags
	)

（保留，尚未支持）当鼠标进入某处时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的点，在中。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。目前此函数尚不支持使用，因此此函数将始终返回false。

◆ OnMouseHover()

def fsdk.Filler.OnMouseHover	(	page,
		point,
		flags
	)

（保留，尚未支持）当鼠标悬停在某处时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的点，在中。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。目前此函数尚不支持使用，因此此函数将始终返回false。

◆ OnMouseLeave()

def fsdk.Filler.OnMouseLeave	(	page,
		point,
		flags
	)

（保留，尚未支持）当鼠标离开某处时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的点，在中。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。目前此函数尚不支持使用，因此此函数将始终返回false。

◆ OnMouseMove()

def fsdk.Filler.OnMouseMove	(	page,
		point,
		flags
	)

当鼠标移动时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的点，在中。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

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

◆ OnMouseWheel()

def fsdk.Filler.OnMouseWheel	(	page,
		point,
		delta,
		flags
	)

（保留，尚未支持）当鼠标滚轮移动时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的点，在中。
[in]	delta	指示鼠标滚轮移动的量。正值表示向前移动，负值表示向后移动。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。目前此函数尚不支持使用，因此此函数将始终返回false。

◆ OnPaste()

def fsdk.Filler.OnPaste ( )

当弹出菜单项"粘贴"按下时调用此函数。

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

◆ OnRButtonDoubleClick()

def fsdk.Filler.OnRButtonDoubleClick	(	page,
		point,
		flags
	)

（保留，尚未支持）当鼠标右键双击时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的点，在中。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。目前此函数尚不支持使用，因此此函数将始终返回false。

◆ OnRButtonDown()

def fsdk.Filler.OnRButtonDown	(	page,
		point,
		flags
	)

当鼠标右键按下时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的点，在中。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。目前此函数尚不支持使用，因此此函数将始终返回false。

◆ OnRButtonUp()

def fsdk.Filler.OnRButtonUp	(	page,
		point,
		flags
	)

当鼠标右键抬起时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的点，在中。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。目前此函数尚不支持使用，因此此函数将始终返回false。

◆ OnSelectAll()

def fsdk.Filler.OnSelectAll ( )

当弹出菜单项"全选"按下时调用此函数。

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

◆ OnWheelButtonDoubleClick()

def fsdk.Filler.OnWheelButtonDoubleClick	(	page,
		point,
		flags
	)

（保留，尚未支持）当鼠标滚轮按钮双击时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的点，在中。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。目前此函数尚不支持使用，因此此函数将始终返回false。

◆ OnWheelButtonDown()

def fsdk.Filler.OnWheelButtonDown	(	page,
		point,
		flags
	)

（保留，尚未支持）当鼠标滚轮按钮按下时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的点，在中。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。目前此函数尚不支持使用，因此此函数将始终返回false。

◆ OnWheelButtonUp()

def fsdk.Filler.OnWheelButtonUp	(	page,
		point,
		flags
	)

（保留，尚未支持）当鼠标滚轮按钮抬起时调用此函数。

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的点，在中。
[in]	flags	事件标志。请参考从fsdk.FillerE_EventFlagShiftKey 开始的值，这应该是这些值中的一个或组合。

返回: true 表示成功，false 表示失败。目前此函数尚不支持使用，因此此函数将始终返回false。

◆ Render()

def fsdk.Filler.Render	(	page,
		matrix,
		renderer
	)

在页面上绘制当前获得焦点的表单控件。

如果页面上没有获得焦点的表单控件，此函数将不绘制任何内容。获得焦点的表单控件必须是最顶层的可见元素，因此它应该始终在页面内容和所有其他注释都已渲染后再渲染。
关于如何渲染表单控件（与控件注释关联），请参考 Renderer类注释中提到的推荐流程。

参数

[in]	page	有效的PDF页面对象。
[in]	matrix	用于渲染的变换矩阵，通常由fsdk.PDFPage.GetDisplayMatrix 函数返回。
[in]	renderer	用于渲染的有效渲染器对象。

返回: 无。

◆ SetFocus()

def fsdk.Filler.SetFocus ( control )

将焦点设置到表单控件上。

参数

[in] control 表单控件对象。如果这是由默认构造函数构造且未设置任何值，表示无焦点控件。

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

◆ SetHighlightColor()

def fsdk.Filler.SetHighlightColor ( color )

设置用于高亮显示表单字段的高亮颜色。

如果不调用此函数，Foxit PDF SDK默认会使用一种浅蓝灰色（值0x80C8D2FF）。

参数

[in] color 要为高亮显示表单字段设置的高亮颜色。

返回: 无。

◆ ShowOverflowIndicator()

def fsdk.Filler.ShowOverflowIndicator ( is_show_overflow_indicator )

决定当文本字段中的文本溢出时是否显示溢出指示器。

如果不调用此函数，Foxit PDF SDK默认不会显示表单字段溢出指示器。

参数

[in] is_show_overflow_indicator true 表示当文本字段中的文本溢出时显示溢出指示器， false 表示在这种情况下不显示溢出指示器。

返回: 无。

Public 成员函数

详细描述

成员函数说明

◆ GetEditingTextCaretPosition()

◆ HighlightFormFields()

◆ IsEmpty()

◆ KillFocus()

◆ OnChar()

◆ OnCopy()

◆ OnCut()

◆ OnDelete()

◆ OnKeyDown()

◆ OnKeyUp()

◆ OnLButtonDoubleClick()

◆ OnLButtonDown()

◆ OnLButtonUp()

◆ OnMouseEnter()

◆ OnMouseHover()

◆ OnMouseLeave()

◆ OnMouseMove()

◆ OnMouseWheel()

◆ OnPaste()

◆ OnRButtonDoubleClick()

◆ OnRButtonDown()

◆ OnRButtonUp()

◆ OnSelectAll()

◆ OnWheelButtonDoubleClick()

◆ OnWheelButtonDown()

◆ OnWheelButtonUp()

◆ Render()

◆ SetFocus()

◆ SetHighlightColor()

◆ ShowOverflowIndicator()