Foxit PDF SDK
 All Classes Namespaces Functions Enumerations Enumerator Properties Pages
foxit.pdf.interform.Filler Class Reference
Inheritance diagram for foxit.pdf.interform.Filler:
foxit.common.Base

Public Types

enum  EventFlags {
  EventFlags.e_EventFlagShiftKey = 0x0001, EventFlags.e_EventFlagControlKey = 0x0002, EventFlags.e_EventFlagAltKey = 0x0004, EventFlags.e_EventFlagMetaKey = 0x0008,
  EventFlags.e_EventFlagKeyPad = 0x0010, EventFlags.e_EventFlagAutoRepeat = 0x0020, EventFlags.e_EventFlagLeftButtonDown = 0x0040, EventFlags.e_EventFlagMiddleButtonDown = 0x0080,
  EventFlags.e_EventFlagRightButtonDown = 0x0100, EventFlags.e_EventFlagCommand = 0x0200
}
 Enumeration for key event flags. More...
 
enum  VirtualKeyCode {
  VirtualKeyCode.e_VkeyUnknown = 0x00, VirtualKeyCode.e_VkeyBack = 0x08, VirtualKeyCode.e_VkeyTab = 0x09, VirtualKeyCode.e_VkeyReturn = 0x0D,
  VirtualKeyCode.e_VkeyShift = 0x10, VirtualKeyCode.e_VkeyControl = 0x11, VirtualKeyCode.e_VkeyMenu = 0x12, VirtualKeyCode.e_VkeyPause = 0x13,
  VirtualKeyCode.e_VkeyEscape = 0x1B, VirtualKeyCode.e_VkeySpace = 0x20, VirtualKeyCode.e_VkeyPrior = 0x21, VirtualKeyCode.e_VkeyNext = 0x22,
  VirtualKeyCode.e_VkeyEnd = 0x23, VirtualKeyCode.e_VkeyHome = 0x24, VirtualKeyCode.e_VkeyLeft = 0x25, VirtualKeyCode.e_VkeyUp = 0x26,
  VirtualKeyCode.e_VkeyRight = 0x27, VirtualKeyCode.e_VkeyDown = 0x28, VirtualKeyCode.e_VkeyPrint = 0x2A, VirtualKeyCode.e_VkeySnapshot = 0x2C,
  VirtualKeyCode.e_VkeyInsert = 0x2D, VirtualKeyCode.e_VkeyDelete = 0x2E, VirtualKeyCode.e_VkeyHelp = 0x2F, VirtualKeyCode.e_Vkey0 = 0x30,
  VirtualKeyCode.e_Vkey1 = 0x31, VirtualKeyCode.e_Vkey2 = 0x32, VirtualKeyCode.e_Vkey3 = 0x33, VirtualKeyCode.e_Vkey4 = 0x34,
  VirtualKeyCode.e_Vkey5 = 0x35, VirtualKeyCode.e_Vkey6 = 0x36, VirtualKeyCode.e_Vkey7 = 0x37, VirtualKeyCode.e_Vkey8 = 0x38,
  VirtualKeyCode.e_Vkey9 = 0x39, VirtualKeyCode.e_VkeyA = 0x41, VirtualKeyCode.e_VkeyB = 0x42, VirtualKeyCode.e_VkeyC = 0x43,
  VirtualKeyCode.e_VkeyD = 0x44, VirtualKeyCode.e_VkeyE = 0x45, VirtualKeyCode.e_VkeyF = 0x46, VirtualKeyCode.e_VkeyG = 0x47,
  VirtualKeyCode.e_VkeyH = 0x48, VirtualKeyCode.e_VkeyI = 0x49, VirtualKeyCode.e_VkeyJ = 0x4A, VirtualKeyCode.e_VkeyK = 0x4B,
  VirtualKeyCode.e_VkeyL = 0x4C, VirtualKeyCode.e_VkeyM = 0x4D, VirtualKeyCode.e_VkeyN = 0x4E, VirtualKeyCode.e_VkeyO = 0x4F,
  VirtualKeyCode.e_VkeyP = 0x50, VirtualKeyCode.e_VkeyQ = 0x51, VirtualKeyCode.e_VkeyR = 0x52, VirtualKeyCode.e_VkeyS = 0x53,
  VirtualKeyCode.e_VkeyT = 0x54, VirtualKeyCode.e_VkeyU = 0x55, VirtualKeyCode.e_VkeyV = 0x56, VirtualKeyCode.e_VkeyW = 0x57,
  VirtualKeyCode.e_VkeyX = 0x58, VirtualKeyCode.e_VkeyY = 0x59, VirtualKeyCode.e_VkeyZ = 0x5A, VirtualKeyCode.e_VkeyNumpad0 = 0x60,
  VirtualKeyCode.e_VkeyNumpad1 = 0x61, VirtualKeyCode.e_VkeyNumpad2 = 0x62, VirtualKeyCode.e_VkeyNumpad3 = 0x63, VirtualKeyCode.e_VkeyNumpad4 = 0x64,
  VirtualKeyCode.e_VkeyNumpad5 = 0x65, VirtualKeyCode.e_VkeyNumpad6 = 0x66, VirtualKeyCode.e_VkeyNumpad7 = 0x67, VirtualKeyCode.e_VkeyNumpad8 = 0x68,
  VirtualKeyCode.e_VkeyNumpad9 = 0x69, VirtualKeyCode.e_VkeyMultiply = 0x6A, VirtualKeyCode.e_VkeyAdd = 0x6B, VirtualKeyCode.e_VkeySeparator = 0x6C,
  VirtualKeyCode.e_VkeySubtract = 0x6D, VirtualKeyCode.e_VkeyDecimal = 0x6E, VirtualKeyCode.e_VkeyDivide = 0x6F, VirtualKeyCode.e_VkeyF1 = 0x70,
  VirtualKeyCode.e_VkeyF2 = 0x71, VirtualKeyCode.e_VkeyF3 = 0x72, VirtualKeyCode.e_VkeyF4 = 0x73, VirtualKeyCode.e_VkeyF5 = 0x74,
  VirtualKeyCode.e_VkeyF6 = 0x75, VirtualKeyCode.e_VkeyF7 = 0x76, VirtualKeyCode.e_VkeyF8 = 0x77, VirtualKeyCode.e_VkeyF9 = 0x78,
  VirtualKeyCode.e_VkeyF10 = 0x79, VirtualKeyCode.e_VkeyF11 = 0x7A, VirtualKeyCode.e_VkeyF12 = 0x7B
}
 Enumeration for virtual key code. More...
 

Public Member Functions

 Filler (Form form, FillerAssistCallback assist)
 Constructor. More...
 
 Filler (Filler other)
 Constructor, with another filler object. More...
 
void HighlightFormFields (bool is_highlight)
 Decide whether to highlight form fields (including signature fields) or not. More...
 
void HighlightFormFields (bool is_highlight, bool is_sign_highlight)
 Decide whether to highlight signature fields and other form fields or not. More...
 
bool IsEmpty ()
 Check whether current object is empty or not. More...
 
bool KillFocus ()
 Kill focus from form. More...
 
bool OnChar (int char_code, int flags)
 Call this function when a character code is about to be inputted to a form field. More...
 
bool OnCopy ()
 Call this function when the popup menu item "Copy" is down. More...
 
bool OnCut ()
 Call this function when the popup menu item "Cut" is down. More...
 
bool OnDelete ()
 Call this function when the popup menu item "Delete" is down. More...
 
bool OnKeyDown (int key_code, int flags)
 Call this function when key on the keyboard is down. More...
 
bool OnKeyUp (int key_code, int flags)
 Call this function when key on the keyboard is up. More...
 
bool OnLButtonDoubleClick (PDFPage page, PointF point, int flags)
 Call this function when left mouse button is double clicked. More...
 
bool OnLButtonDown (PDFPage page, PointF point, int flags)
 Call this function when left mouse button is down. More...
 
bool OnLButtonUp (PDFPage page, PointF point, int flags)
 Call this function when left mouse button is up. More...
 
bool OnMouseEnter (PDFPage page, PointF point, int flags)
 (Reserved, unsupported yet) Call this function when mouse enters somewhere. More...
 
bool OnMouseHover (PDFPage page, PointF point, int flags)
 (Reserved, unsupported yet) Call this function when mouse hovers somewhere. More...
 
bool OnMouseLeave (PDFPage page, PointF point, int flags)
 (Reserved, unsupported yet) Call this function when mouse leaves somewhere. More...
 
bool OnMouseMove (PDFPage page, PointF point, int flags)
 Call this function when mouse moves. More...
 
bool OnMouseWheel (PDFPage page, PointF point, int delta, int flags)
 (Reserved, unsupported yet) Call this function when mouse wheel moves. More...
 
bool OnPaste ()
 Call this function when the popup menu item "Paste" is down. More...
 
bool OnRButtonDoubleClick (PDFPage page, PointF point, int flags)
 (Reserved, unsupported yet) Call this function when right mouse button is double clicked. More...
 
bool OnRButtonDown (PDFPage page, PointF point, int flags)
 Call this function when right mouse button is down. More...
 
bool OnRButtonUp (PDFPage page, PointF point, int flags)
 Call this function when right mouse button is up. More...
 
bool OnSelectAll ()
 Call this function when the popup menu item "Select All" is down. More...
 
bool OnWheelButtonDoubleClick (PDFPage page, PointF point, int flags)
 (Reserved, unsupported yet) Call this function when mouse wheel button is double clicked. More...
 
bool OnWheelButtonDown (PDFPage page, PointF point, int flags)
 (Reserved, unsupported yet) Call this function when mouse wheel button is down. More...
 
bool OnWheelButtonUp (PDFPage page, PointF point, int flags)
 (Reserved, unsupported yet) Call this function when mouse wheel button is up. More...
 
void Render (PDFPage page, Matrix2D matrix, Renderer renderer)
 Draw the currently focused form control on the page. More...
 
bool SetFocus (Control control)
 Set focus on a form control. More...
 
void SetHighlightColor (uint color)
 Set the highlight color used for highlighting form fields. More...
 
void ShowOverflowIndicator (bool is_show_overflow_indicator)
 Decide whether to show the overflow indicator when the text in text field overflow. More...
 

Detailed Description

This class represents a form filler used for filling PDF form. There should be only one form filler object for an interactive form, so do not construct form filler for one Form object more than one time. User is recommended to implement an foxit.pdf.actions.ActionCallback and set it to Foxit PDF SDK by function common.Library.SetActionCallback , in order to implement more features of form filler.

See Also
foxit.common.Library

Member Enumeration Documentation

Enumeration for key event flags.

Values of this enumeration can be used alone or in combination.

Enumerator
e_EventFlagShiftKey 

Event flag: "Shift" key.

e_EventFlagControlKey 

Event flag: "Ctrl" key.

e_EventFlagAltKey 

Event flag: "Alt" key.

e_EventFlagMetaKey 

Event flag: meta key.

e_EventFlagKeyPad 

Event flag: key pad.

e_EventFlagAutoRepeat 

Event flag: auto repeat.

e_EventFlagLeftButtonDown 

Event flag: the left button of the mouse is down.

e_EventFlagMiddleButtonDown 

Event flag: the middle button of the mouse is down.

e_EventFlagRightButtonDown 

Event flag: the right button of the mouse is down.

e_EventFlagCommand 

Event flag: the command key.

Enumeration for virtual key code.

Values of this enumeration should be used alone.

Enumerator
e_VkeyUnknown 

An unknown key.

e_VkeyBack 

Backspace key.

e_VkeyTab 

Tab key.

e_VkeyReturn 

Enter key.

e_VkeyShift 

Shift key.

e_VkeyControl 

Ctrl key.

e_VkeyMenu 

Menu key.

e_VkeyPause 

Pause Break key.

e_VkeyEscape 

ESC key.

e_VkeySpace 

Space key.

e_VkeyPrior 

Page Up key.

e_VkeyNext 

Page Down key.

e_VkeyEnd 

End key.

e_VkeyHome 

Home key.

e_VkeyLeft 

Left arrow key.

e_VkeyUp 

Up arrow key.

e_VkeyRight 

Right arrow key.

e_VkeyDown 

Down arrow key.

e_VkeyPrint 

Print key.

e_VkeySnapshot 

Print Screen key.

e_VkeyInsert 

Insert key.

e_VkeyDelete 

Delete key.

e_VkeyHelp 

Help key.

e_Vkey0 

0 key.

e_Vkey1 

1 key.

e_Vkey2 

2 key.

e_Vkey3 

3 key.

e_Vkey4 

4 key.

e_Vkey5 

5 key.

e_Vkey6 

6 key.

e_Vkey7 

7 key.

e_Vkey8 

8 key.

e_Vkey9 

9 key.

e_VkeyA 

A key.

e_VkeyB 

B key.

e_VkeyC 

C key.

e_VkeyD 

D key.

e_VkeyE 

E key.

e_VkeyF 

F key.

e_VkeyG 

G key.

e_VkeyH 

H key.

e_VkeyI 

I key.

e_VkeyJ 

J key.

e_VkeyK 

K key.

e_VkeyL 

L key.

e_VkeyM 

M key.

e_VkeyN 

N key.

e_VkeyO 

O key.

e_VkeyP 

P key.

e_VkeyQ 

Q key.

e_VkeyR 

R key.

e_VkeyS 

S key.

e_VkeyT 

T key.

e_VkeyU 

U key.

e_VkeyV 

V key.

e_VkeyW 

W key.

e_VkeyX 

X key.

e_VkeyY 

Y key.

e_VkeyZ 

Z key.

e_VkeyNumpad0 

0 key in the numeric keypad.

e_VkeyNumpad1 

1 key in the numeric keypad.

e_VkeyNumpad2 

2 key in the numeric keypad.

e_VkeyNumpad3 

3 key in the numeric keypad.

e_VkeyNumpad4 

4 key in the numeric keypad.

e_VkeyNumpad5 

5 key in the numeric keypad.

e_VkeyNumpad6 

6 key in the numeric keypad.

e_VkeyNumpad7 

7 key in the numeric keypad.

e_VkeyNumpad8 

8 key in the numeric keypad.

e_VkeyNumpad9 

9 key in the numeric keypad.

e_VkeyMultiply 

Multiply key in the numeric keypad.

e_VkeyAdd 

Plus key in the numeric keypad.

e_VkeySeparator 

Enter key in the numeric keypad.

e_VkeySubtract 

Minus key in the numeric keypad.

e_VkeyDecimal 

Dot key in the numeric keypad.

e_VkeyDivide 

Slash key in the numeric keypad.

e_VkeyF1 

F1 key.

e_VkeyF2 

F2 key.

e_VkeyF3 

F3 key.

e_VkeyF4 

F4 key.

e_VkeyF5 

F5 key.

e_VkeyF6 

F6 key.

e_VkeyF7 

F7 key.

e_VkeyF8 

F8 key.

e_VkeyF9 

F9 key.

e_VkeyF10 

F10 key.

e_VkeyF11 

F11 key.

e_VkeyF12 

F12 key.

Constructor & Destructor Documentation

foxit.pdf.interform.Filler.Filler ( Form  form,
FillerAssistCallback  assist 
)
inline

Constructor.

There can be only one form filler for a form.

Parameters
[in]formA valid PDF form.
[in]assistAn assistant callback class for form filler. This should be implemented by user and should not be null.
foxit.pdf.interform.Filler.Filler ( Filler  other)
inline

Constructor, with another filler object.

Parameters
[in]otherAnother filler object.

Member Function Documentation

void foxit.pdf.interform.Filler.HighlightFormFields ( bool  is_highlight)
inline

Decide whether to highlight form fields (including signature fields) or not.

All types of form fields can be highlighted except push button fields. If this function is not called, Foxit PDF SDK will highlight all form fields (including signature fields) by default.

Parameters
[in]is_highlighttrue means to highlight form fields (including signature fields), and false means not to highlight form fields (including signature fields).
Returns
None.
void foxit.pdf.interform.Filler.HighlightFormFields ( bool  is_highlight,
bool  is_sign_highlight 
)
inline

Decide whether to highlight signature fields and other form fields or not.

All types of form fields can be highlighted except push button fields. If this function is not called, Foxit PDF SDK will highlight all form fields by default apart from signature fields which are not highlighted by default.

Parameters
[in]is_highlightThis boolean value is used for non-signature fields: true means to highlight form fields, and false means not to highlight form fields.
[in]is_sign_highlightThis boolean value is used only for siganture fields: true means to highlight signature fields, and false means not to highlight signature fields.
Returns
None.
bool foxit.pdf.interform.Filler.IsEmpty ( )
inline

Check whether current object is empty or not.

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

Returns
true means current object is empty, while false means not.
bool foxit.pdf.interform.Filler.KillFocus ( )
inline

Kill focus from form.

Returns
true means success, while false means failure.
bool foxit.pdf.interform.Filler.OnChar ( int  char_code,
int  flags 
)
inline

Call this function when a character code is about to be inputted to a form field.

Parameters
[in]char_codeA character code, in UTF16-LE encoding.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure.
bool foxit.pdf.interform.Filler.OnCopy ( )
inline

Call this function when the popup menu item "Copy" is down.

Returns
true means success, while false means failure.
bool foxit.pdf.interform.Filler.OnCut ( )
inline

Call this function when the popup menu item "Cut" is down.

Returns
true means success, while false means failure.
bool foxit.pdf.interform.Filler.OnDelete ( )
inline

Call this function when the popup menu item "Delete" is down.

Returns
true means success, while false means failure.
bool foxit.pdf.interform.Filler.OnKeyDown ( int  key_code,
int  flags 
)
inline

Call this function when key on the keyboard is down.

Parameters
[in]key_codeThe key code. Please refer to values starting from foxit.pdf.interform.Filler.VirtualKeyCode.e_VkeyUnknown and this should be one of these values.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure. Currently this function does not support to be used yet, so this function will always return true.
bool foxit.pdf.interform.Filler.OnKeyUp ( int  key_code,
int  flags 
)
inline

Call this function when key on the keyboard is up.

Parameters
[in]key_codeThe key code. Please refer to values starting from foxit.pdf.interform.Filler.VirtualKeyCode.e_VkeyUnknown and this should be one of these values.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure. Currently this function does not support to be used yet, so this function will always return true.
bool foxit.pdf.interform.Filler.OnLButtonDoubleClick ( PDFPage  page,
PointF  point,
int  flags 
)
inline

Call this function when left mouse button is double clicked.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is up in the page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure.
bool foxit.pdf.interform.Filler.OnLButtonDown ( PDFPage  page,
PointF  point,
int  flags 
)
inline

Call this function when left mouse button is down.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is down in the page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure.
bool foxit.pdf.interform.Filler.OnLButtonUp ( PDFPage  page,
PointF  point,
int  flags 
)
inline

Call this function when left mouse button is up.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is up in the page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure.
bool foxit.pdf.interform.Filler.OnMouseEnter ( PDFPage  page,
PointF  point,
int  flags 
)
inline

(Reserved, unsupported yet) Call this function when mouse enters somewhere.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is up in the page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure. Currently this function does not support to be used yet, so this function will always return false.
bool foxit.pdf.interform.Filler.OnMouseHover ( PDFPage  page,
PointF  point,
int  flags 
)
inline

(Reserved, unsupported yet) Call this function when mouse hovers somewhere.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is up in the page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure. Currently this function does not support to be used yet, so this function will always return false.
bool foxit.pdf.interform.Filler.OnMouseLeave ( PDFPage  page,
PointF  point,
int  flags 
)
inline

(Reserved, unsupported yet) Call this function when mouse leaves somewhere.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is up in the page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure. Currently this function does not support to be used yet, so this function will always return false.
bool foxit.pdf.interform.Filler.OnMouseMove ( PDFPage  page,
PointF  point,
int  flags 
)
inline

Call this function when mouse moves.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is up in the page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure.
bool foxit.pdf.interform.Filler.OnMouseWheel ( PDFPage  page,
PointF  point,
int  delta,
int  flags 
)
inline

(Reserved, unsupported yet) Call this function when mouse wheel moves.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is up in the page, in PDF coordinate system.
[in]deltaIndicates the amount the mouse wheel has been moved. A positive value means to be moved forward, and a negative value means to be moved backward.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure. Currently this function does not support to be used yet, so this function will always return false.
bool foxit.pdf.interform.Filler.OnPaste ( )
inline

Call this function when the popup menu item "Paste" is down.

Returns
true means success, while false means failure.
bool foxit.pdf.interform.Filler.OnRButtonDoubleClick ( PDFPage  page,
PointF  point,
int  flags 
)
inline

(Reserved, unsupported yet) Call this function when right mouse button is double clicked.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is up in the page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure. Currently this function does not support to be used yet, so this function will always return false.
bool foxit.pdf.interform.Filler.OnRButtonDown ( PDFPage  page,
PointF  point,
int  flags 
)
inline

Call this function when right mouse button is down.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is up in the page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure. Currently this function does not support to be used yet, so this function will always return false.
bool foxit.pdf.interform.Filler.OnRButtonUp ( PDFPage  page,
PointF  point,
int  flags 
)
inline

Call this function when right mouse button is up.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is up in the page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure. Currently this function does not support to be used yet, so this function will always return false.
bool foxit.pdf.interform.Filler.OnSelectAll ( )
inline

Call this function when the popup menu item "Select All" is down.

Returns
true means success, while false means failure.
bool foxit.pdf.interform.Filler.OnWheelButtonDoubleClick ( PDFPage  page,
PointF  point,
int  flags 
)
inline

(Reserved, unsupported yet) Call this function when mouse wheel button is double clicked.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is up in the page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure. Currently this function does not support to be used yet, so this function will always return false.
bool foxit.pdf.interform.Filler.OnWheelButtonDown ( PDFPage  page,
PointF  point,
int  flags 
)
inline

(Reserved, unsupported yet) Call this function when mouse wheel button is down.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is up in the page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure. Currently this function does not support to be used yet, so this function will always return false.
bool foxit.pdf.interform.Filler.OnWheelButtonUp ( PDFPage  page,
PointF  point,
int  flags 
)
inline

(Reserved, unsupported yet) Call this function when mouse wheel button is up.

Parameters
[in]pageA valid PDF page object.
[in]pointA point where left mouse button is up in the page, in PDF coordinate system.
[in]flagsEvent flags. Please refer to values starting from foxit.pdf.interform.Filler.EventFlags.e_EventFlagShiftKey and this should be one or a combination of these values.
Returns
true means success, while false means failure. Currently this function does not support to be used yet, so this function will always return false.
void foxit.pdf.interform.Filler.Render ( PDFPage  page,
Matrix2D  matrix,
Renderer  renderer 
)
inline

Draw the currently focused form control on the page.

If there is no focused form control on the page, nothing will be drawn by this function. The focused form control has to be the topmost visible element, so that it should be always rendered after page content and all the other annotations have been rendered.
For how to render form control (which is associated with widget annotations), please refer to the recommended flow mentioned in comment of class Renderer.

Parameters
[in]pageA valid PDF page object.
[in]matrixThe transformation matrix used for rendering, which is usually returned by function PDFPage.GetDisplayMatrix .
[in]rendererA valid renderer object for rendering.
Returns
None.
bool foxit.pdf.interform.Filler.SetFocus ( Control  control)
inline

Set focus on a form control.

Parameters
[in]controlA form control object. If this is constructed by default constructor and not set any value, that means no focus control.
Returns
true means success, while false means failure.
void foxit.pdf.interform.Filler.SetHighlightColor ( uint  color)
inline

Set the highlight color used for highlighting form fields.

If this function is not called, Foxit PDF SDK will use a kind of light blue grey color (value 0x80C8D2FF) by default.

Parameters
[in]colorThe highlight color to be set for highlighting form fields.
Returns
None.
void foxit.pdf.interform.Filler.ShowOverflowIndicator ( bool  is_show_overflow_indicator)
inline

Decide whether to show the overflow indicator when the text in text field overflow.

If this function is not called, Foxit PDF SDK will not show form field overflow indicator by default.

Parameters
[in]is_show_overflow_indicatortrue means to show overflow indicator when the text in text field overflow, and false means not to show overflow indicator in this case.
Returns
None.