Public 成员函数
	constructor (form, assist)
	构造函数。更多...

	GetEditingTextCaretPosition (matrix)
	当文本字段或组合框处于编辑状态时获取文本插入符位置。更多...

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

	HighlightFormFields (is_highlight, is_sign_highlight)
	决定是否突出显示签名字段和其他表单字段。更多...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Public 属性
	e_VkeyNumpad0
	数字键盘中的0键。

静态 Public 属性
static	e_EventFlagAltKey
	事件标志："Alt"键。

static	e_EventFlagAutoRepeat
	事件标志：自动重复。

static	e_EventFlagCommand
	事件标志：命令键。

static	e_EventFlagControlKey
	事件标志："Ctrl"键。

static	e_EventFlagKeyPad
	事件标志：键盘。

static	e_EventFlagLeftButtonDown
	事件标志：鼠标左键按下。

static	e_EventFlagMetaKey
	事件标志：meta键。

static	e_EventFlagMiddleButtonDown
	事件标志：鼠标中键按下。

static	e_EventFlagRightButtonDown
	事件标志：鼠标右键按下。

static	e_EventFlagShiftKey
	键盘事件标志的枚举。更多...

static	e_Vkey0
	0键。

static	e_Vkey1
	1键。

static	e_Vkey2
	2键。

static	e_Vkey3
	3键。

static	e_Vkey4
	4键。

static	e_Vkey5
	5键。

static	e_Vkey6
	6键。

static	e_Vkey7
	7键。

static	e_Vkey8
	8键。

static	e_Vkey9
	9键。

static	e_VkeyA
	A键。

static	e_VkeyAdd
	数字键盘中的加号键。

static	e_VkeyB
	B键。

static	e_VkeyBack
	退格键。

static	e_VkeyC
	C键。

static	e_VkeyControl
	Ctrl键。

static	e_VkeyD
	D键。

static	e_VkeyDecimal
	数字键盘中的点键。

static	e_VkeyDelete
	Delete键。

static	e_VkeyDivide
	数字键盘中的斜杠键。

static	e_VkeyDown
	下箭头键。

static	e_VkeyE
	E键。

static	e_VkeyEnd
	End键。

static	e_VkeyEscape
	ESC键。

static	e_VkeyF
	F键。

static	e_VkeyF1
	F1键。

static	e_VkeyF10
	F10键。

static	e_VkeyF11
	F11键。

static	e_VkeyF12
	F12键。

static	e_VkeyF2
	F2键。

static	e_VkeyF3
	F3键。

static	e_VkeyF4
	F4键。

static	e_VkeyF5
	F5键。

static	e_VkeyF6
	F6键。

static	e_VkeyF7
	F7键。

static	e_VkeyF8
	F8键。

static	e_VkeyF9
	F9键。

static	e_VkeyG
	G键。

static	e_VkeyH
	H键。

static	e_VkeyHelp
	Help键。

static	e_VkeyHome
	Home键。

static	e_VkeyI
	I键。

static	e_VkeyInsert
	Insert键。

static	e_VkeyJ
	J键。

static	e_VkeyK
	K键。

static	e_VkeyL
	L键。

static	e_VkeyLeft
	左箭头键。

static	e_VkeyM
	M键。

static	e_VkeyMenu
	菜单键。

static	e_VkeyMultiply
	数字键盘中的乘法键。

static	e_VkeyN
	N键。

static	e_VkeyNext
	Page Down键。

static	e_VkeyNumpad1
	数字键盘中的1键。

static	e_VkeyNumpad2
	数字键盘中的2键。

static	e_VkeyNumpad3
	数字键盘中的3键。

static	e_VkeyNumpad4
	数字键盘中的4键。

static	e_VkeyNumpad5
	数字键盘中的5键。

static	e_VkeyNumpad6
	数字键盘中的6键。

static	e_VkeyNumpad7
	数字键盘中的7键。

static	e_VkeyNumpad8
	数字键盘中的8键。

static	e_VkeyNumpad9
	数字键盘中的9键。

static	e_VkeyO
	O键。

static	e_VkeyP
	P键。

static	e_VkeyPause
	暂停中断键。

static	e_VkeyPrint
	打印键。

static	e_VkeyPrior
	Page Up键。

static	e_VkeyQ
	Q键。

static	e_VkeyR
	R键。

static	e_VkeyReturn
	Enter键。

static	e_VkeyRight
	右箭头键。

static	e_VkeyS
	S键。

static	e_VkeySeparator
	数字键盘中的Enter键。

static	e_VkeyShift
	Shift键。

static	e_VkeySnapshot
	Print Screen键。

static	e_VkeySpace
	空格键。

static	e_VkeySubtractv
	数字键盘中的减号键。

static	e_VkeyT
	T键。

static	e_VkeyTab
	Tab键。

static	e_VkeyU
	U键。

static	e_VkeyUnknown
	虚拟键码的枚举。更多...

static	e_VkeyUp
	上箭头键。

static	e_VkeyV
	V键。

static	e_VkeyW
	W键。

static	e_VkeyX
	X键。

static	e_VkeyY
	Y键。

static	e_VkeyZ
	Z键。

详细描述

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

参见: FSDK.Library

成员函数说明

◆ constructor()

FSDK::Filler::constructor	(	form	,
		assist
	)

构造函数。

一个表单只能有一个表单填充器。

参数

[in]	form	有效的PDF表单。
[in]	assist	用于表单填充器的辅助回调类。这应该由用户实现并且不应为 null。

◆ GetEditingTextCaretPosition()

FSDK::Filler::GetEditingTextCaretPosition ( matrix )

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

参数

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

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

◆ HighlightFormFields() [1/2]

FSDK::Filler::HighlightFormFields ( is_highlight )

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

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

参数

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

返回: 无。

◆ HighlightFormFields() [2/2]

FSDK::Filler::HighlightFormFields	(	is_highlight	,
		is_sign_highlight
	)

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

除按钮字段外，所有类型的表单字段都可以突出显示。如果未调用此函数，Foxit PDF SDK默认情况下会突出显示所有表单字段，但默认情况下不突出显示签名字段。

参数

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

返回: 无。

◆ IsEmpty()

FSDK::Filler::IsEmpty ( )

检查当前对象是否为空。

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

返回: true means current object is empty, while false means not.

◆ KillFocus()

FSDK::Filler::KillFocus ( )

从表单中移除焦点。

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

◆ OnChar()

FSDK::Filler::OnChar	(	key_code	,
		flags
	)

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

参数

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

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

◆ OnCopy()

FSDK::Filler::OnCopy ( )

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

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

◆ OnCut()

FSDK::Filler::OnCut ( )

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

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

◆ OnDelete()

FSDK::Filler::OnDelete ( )

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

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

◆ OnKeyDown()

FSDK::Filler::OnKeyDown	(	key_code	,
		flags
	)

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

参数

[in]	key_code	键码。请参阅从 FSDK.Filler.e_VkeyUnknown 开始的值，并且这应该是这些值中的一个。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnKeyUp()

FSDK::Filler::OnKeyUp	(	key_code	,
		flags
	)

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

参数

[in]	key_code	键码。请参阅从 FSDK.Filler.e_VkeyUnknown 开始的值，并且这应该是这些值中的一个。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnLButtonDoubleClick()

FSDK::Filler::OnLButtonDoubleClick	(	page	,
		point	,
		flags
	)

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

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的位置，在 PDF坐标系中。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnLButtonDown()

FSDK::Filler::OnLButtonDown	(	page	,
		point	,
		flags
	)

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

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键按下的位置，在 PDF坐标系中。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnLButtonUp()

FSDK::Filler::OnLButtonUp	(	page	,
		point	,
		flags
	)

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

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的位置，在 PDF坐标系中。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnMouseEnter()

FSDK::Filler::OnMouseEnter	(	page	,
		point	,
		flags
	)

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

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的位置，在 PDF坐标系中。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnMouseHover()

FSDK::Filler::OnMouseHover	(	page	,
		point	,
		flags
	)

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

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的位置，在 PDF坐标系中。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnMouseLeave()

FSDK::Filler::OnMouseLeave	(	page	,
		point	,
		flags
	)

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

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的位置，在 PDF坐标系中。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnMouseMove()

FSDK::Filler::OnMouseMove	(	page	,
		point	,
		flags
	)

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

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的位置，在 PDF坐标系中。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnMouseWheel()

FSDK::Filler::OnMouseWheel	(	page	,
		point	,
		delta	,
		flags
	)

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

参数

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

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

◆ OnPaste()

FSDK::Filler::OnPaste ( )

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

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

◆ OnRButtonDoubleClick()

FSDK::Filler::OnRButtonDoubleClick	(	page	,
		point	,
		flags
	)

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

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的位置，在 PDF坐标系中。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnRButtonDown()

FSDK::Filler::OnRButtonDown	(	page	,
		point	,
		flags
	)

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

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的位置，在 PDF坐标系中。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnRButtonUp()

FSDK::Filler::OnRButtonUp	(	page	,
		point	,
		flags
	)

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

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的位置，在 PDF坐标系中。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnSelectAll()

FSDK::Filler::OnSelectAll ( )

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

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

◆ OnWheelButtonDoubleClick()

FSDK::Filler::OnWheelButtonDoubleClick	(	page	,
		point	,
		flags
	)

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

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的位置，在 PDF坐标系中。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnWheelButtonDown()

FSDK::Filler::OnWheelButtonDown	(	page	,
		point	,
		flags
	)

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

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的位置，在 PDF坐标系中。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ OnWheelButtonUp()

FSDK::Filler::OnWheelButtonUp	(	page	,
		point	,
		flags
	)

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

参数

[in]	page	有效的PDF页面对象。
[in]	point	页面中鼠标左键抬起的位置，在 PDF坐标系中。
[in]	flags	事件标志。请参阅从 FSDK.Filler.e_EventFlagShiftKey 开始的值，并且这应该是这些值中的一个或组合。

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

◆ Render()

FSDK::Filler::Render	(	page	,
		matrix	,
		renderer
	)

绘制页面上当前聚焦的表单控件。

如果页面上没有聚焦的表单控件，此函数将不会绘制任何内容。聚焦的表单控件必须是最顶层的可见元素，因此它应该总是在页面内容和所有其他注释已经渲染之后再进行渲染。
有关如何渲染表单控件（与小部件注释相关联）的信息，请参阅 Renderer 类注释中提到的推荐流程。

参数

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

返回: 无。

◆ SetFocus()

FSDK::Filler::SetFocus ( control )

在表单控件上设置焦点。

参数

[in] control 表单控件对象。如果这是由默认构造函数构造的并且没有设置任何值，那意味着没有焦点控件。

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

◆ SetHighlightColor()

FSDK::Filler::SetHighlightColor ( color )

设置用于突出显示表单字段的突出显示颜色。

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

参数

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

返回: 无。

◆ ShowOverflowIndicator()

FSDK::Filler::ShowOverflowIndicator ( is_show_overflow_indicator )

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

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

参数

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

返回: 无。

类成员变量说明

◆ e_EventFlagShiftKey

FSDK::Filler::e_EventFlagShiftKey

static

键盘事件标志的枚举。

此枚举的值可以单独使用或组合使用。

事件标志："Shift"键。

◆ e_VkeyUnknown

FSDK::Filler::e_VkeyUnknown

static

虚拟键码的枚举。

此枚举的值应单独使用。

未知键。

Public 成员函数

Public 属性

静态 Public 属性

详细描述

成员函数说明

◆ constructor()

◆ GetEditingTextCaretPosition()

◆ HighlightFormFields() [1/2]

◆ HighlightFormFields() [2/2]

◆ 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()

类成员变量说明

◆ e_EventFlagShiftKey

◆ e_VkeyUnknown