|
Foxit PDF SDK
|
Public Member Functions | |
| def | GetBitmap () |
| Get the bitmap of current XFA widget. More... | |
| def | GetDefaultValue () |
| Get the default value string. More... | |
| def | GetHAlign () |
| Get text horizontal alignment. More... | |
| def | GetIndex () |
| Get the index of XFA Widget in related XFA page. More... | |
| def | GetJavaScript () |
| Get the JavaScript of validation for current XFA widget. More... | |
| def | GetName (type) |
| Get Widget name. More... | |
| def | GetOptions () |
| Get options of a choice list or an Exclusion Group (for radio button only). More... | |
| def | GetPresence () |
| Get the presence property of the XFA widget. More... | |
| def | GetRect () |
| Get rectangle of XFA widget. More... | |
| def | GetSignature () |
| Get the signature object from current XFA widget. More... | |
| def | GetToolTip () |
| Get tooltip string. More... | |
| def | GetType () |
| Get type of XFA widget. More... | |
| def | GetVAlign () |
| Get text vertical alignment. More... | |
| def | GetValue () |
| Get the value string. More... | |
| def | GetXFAPage () |
| Get the related XFA page, to which current XFA widget belongs. More... | |
| def | GetXMLContent () |
| Get the xml content of current XFA widget. More... | |
| def | HasEdge (edge_pos) |
| Check if the edge for specified position exists. More... | |
| def | IsAllowRichText () |
| Check whether the widget allows rich text formatting. More... | |
| def | IsChecked () |
| Check if current XFA widget is checked. More... | |
| def | IsEmpty () |
| Check whether current object is empty or not. More... | |
| def | IsListBox () |
| Check whether the widget is listbox or not. More... | |
| def | IsReadOnly () |
| Check whether the widget is read only. More... | |
| def | IsRequired () |
| Check whether the widget requires a value at the time it is exported by a submit-form action. More... | |
| def | IsSupportMultiline () |
| Check whether the widget supports multiple lines. More... | |
| def | IsSupportMultiSelect () |
| Check whether the widget supports multiple selections. More... | |
| def | OnChar (input_char, flags) |
| Call this function when a character code is being input. More... | |
| def | OnHitTest (point) |
| Call this function to do hit test for a specified point. More... | |
| def | OnKeyDown (key_code, flags) |
| Call this function when key on the keyboard is down. More... | |
| def | OnKeyUp (key_code, flags) |
| Call this function when key on the keyboard is up. More... | |
| def | OnLButtonDoubleClick (point, flags) |
| Call this function when left mouse button is double-clicked . More... | |
| def | OnLButtonDown (point, flags) |
| Call this function when left mouse button is down. More... | |
| def | OnLButtonUp (point, flags) |
| Call this function when left mouse button is up. More... | |
| def | OnMouseEnter () |
| Call this function when mouse enters current XFA widget. More... | |
| def | OnMouseExit () |
| Call this function when mouse exits. More... | |
| def | OnMouseMove (point, flags) |
| Call this function when mouse moves. More... | |
| def | OnRButtonDown (point, flags) |
| Call this function when right mouse is down. More... | |
| def | OnRButtonUp (point, flags) |
| Call this function when right button is up. More... | |
| def | ResetData () |
| Reset XFA Widget Data. More... | |
| def | SetCheckState (is_checked) |
| Set the checked state of the current XFA widget. More... | |
| def | SetDefaultValue (value) |
| Set the default value string. More... | |
| def | SetImage (image) |
| Set the image for current XFA widget. More... | |
| def | SetOptions (option_array) |
| Set options of a choice list or an Exclusion Group (for radio button only). More... | |
| def | SetValue (value) |
| Set the value string. More... | |
Class XFAWidget represents the XFA widget which is retrieved from XFA page object.
To access the menu of XFA widget, please construct a fsdk.WidgetMenu object with XFAWidget object.
| def fsdk.XFAWidget.GetBitmap | ( | ) |
Get the bitmap of current XFA widget.
Applicable only when the type of current XFA widget is fsdk.XFAWidgetE_WidgetTypeImageEdit or fsdk.XFAWidgetE_WidgetTypeImage . For types that are not applicable, this function will throw exception fsdk.E_ErrUnsupported .
| def fsdk.XFAWidget.GetDefaultValue | ( | ) |
Get the default value string.
| def fsdk.XFAWidget.GetHAlign | ( | ) |
Get text horizontal alignment.
| def fsdk.XFAWidget.GetIndex | ( | ) |
Get the index of XFA Widget in related XFA page.
| def fsdk.XFAWidget.GetJavaScript | ( | ) |
Get the JavaScript of validation for current XFA widget.
| def fsdk.XFAWidget.GetName | ( | type | ) |
Get Widget name.
| [in] | type | Name type. Please refer to values starting from fsdk.XFAWidgetE_WidgetNameTypeField and this should be one of these values. |
| def fsdk.XFAWidget.GetOptions | ( | ) |
Get options of a choice list or an Exclusion Group (for radio button only).
Applicable for choice list and Exclusion Group (for radio button only). For types that are not applicable, this function will return an empty array.
| def fsdk.XFAWidget.GetPresence | ( | ) |
Get the presence property of the XFA widget.
The presence property controls the participation of the associated object in different phases of processing.
| def fsdk.XFAWidget.GetRect | ( | ) |
Get rectangle of XFA widget.
Widget rectangle is defined in XFA coordinate. XFA coordinate is defined as original point in left top, x-axis pointing to right and y-axis pointing down.
| def fsdk.XFAWidget.GetSignature | ( | ) |
Get the signature object from current XFA widget.
Applicable only when current XFA widget represents a signature. For types that are not applicable, this function will throw exception fsdk.E_ErrUnsupported .
| def fsdk.XFAWidget.GetToolTip | ( | ) |
Get tooltip string.
| def fsdk.XFAWidget.GetType | ( | ) |
Get type of XFA widget.
| def fsdk.XFAWidget.GetVAlign | ( | ) |
Get text vertical alignment.
| def fsdk.XFAWidget.GetValue | ( | ) |
Get the value string.
| def fsdk.XFAWidget.GetXFAPage | ( | ) |
Get the related XFA page, to which current XFA widget belongs.
| def fsdk.XFAWidget.GetXMLContent | ( | ) |
Get the xml content of current XFA widget.
| def fsdk.XFAWidget.HasEdge | ( | edge_pos | ) |
Check if the edge for specified position exists.
| [in] | edge_pos | Edge position to specify which edge will be checked. Please refer to values starting from fsdk.XFAWidgetE_WidgetEdgePositionTop and this should be one of these values. |
| def fsdk.XFAWidget.IsAllowRichText | ( | ) |
Check whether the widget allows rich text formatting.
Only text edit widget which type is fsdk.XFAWidgetE_WidgetTypeTextEdit supports rich text.
| def fsdk.XFAWidget.IsChecked | ( | ) |
Check if current XFA widget is checked.
Applicable for check box or radio button as related XFA widget. For types that are not applicable, this function will return false.
| def fsdk.XFAWidget.IsEmpty | ( | ) |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
| def fsdk.XFAWidget.IsListBox | ( | ) |
Check whether the widget is listbox or not.
| def fsdk.XFAWidget.IsReadOnly | ( | ) |
Check whether the widget is read only.
| def fsdk.XFAWidget.IsRequired | ( | ) |
Check whether the widget requires a value at the time it is exported by a submit-form action.
| def fsdk.XFAWidget.IsSupportMultiline | ( | ) |
Check whether the widget supports multiple lines.
Only text edit widget which type is fsdk.XFAWidgetE_WidgetTypeTextEdit supports multiple lines.
| def fsdk.XFAWidget.IsSupportMultiSelect | ( | ) |
Check whether the widget supports multiple selections.
Only the list box widget supports multiline selections, whose type is fsdk.XFAWidgetE_WidgetTypeChoiceList and the return value of function fsdk.XFAWidget.IsListBox is true.
| def fsdk.XFAWidget.OnChar | ( | input_char, | |
| flags | |||
| ) |
Call this function when a character code is being input.
| [in] | input_char | A character code, in UTF16-LE encoding. |
| [in] | flags | Event flags. Please refer to values starting from fsdk.FillerE_EventFlagShiftKey and this should be one or a combination of these values. |
| def fsdk.XFAWidget.OnHitTest | ( | point | ) |
Call this function to do hit test for a specified point.
| [in] | point | A point to be tested. |
| def fsdk.XFAWidget.OnKeyDown | ( | key_code, | |
| flags | |||
| ) |
Call this function when key on the keyboard is down.
| [in] | key_code | The key code. Please refer to values starting from fsdk.FillerE_VkeyUnknown and this should be one of these values. |
| [in] | flags | Event flags. Please refer to values starting from fsdk.FillerE_EventFlagShiftKey and this should be one or a combination of these values. |
| def fsdk.XFAWidget.OnKeyUp | ( | key_code, | |
| flags | |||
| ) |
Call this function when key on the keyboard is up.
| [in] | key_code | The key code. Please refer to values starting from fsdk.FillerE_VkeyUnknown and this should be one of these values. |
| [in] | flags | Event flags. Please refer to values starting from fsdk.FillerE_EventFlagShiftKey and this should be one or a combination of these values. |
| def fsdk.XFAWidget.OnLButtonDoubleClick | ( | point, | |
| flags | |||
| ) |
Call this function when left mouse button is double-clicked .
| [in] | point | A point where left mouse button is double-clicked in XFA page, in PDF coordinate system. |
| [in] | flags | Event flags. Please refer to values starting from fsdk.FillerE_EventFlagShiftKey and this should be one or a combination of these values. |
| def fsdk.XFAWidget.OnLButtonDown | ( | point, | |
| flags | |||
| ) |
Call this function when left mouse button is down.
| [in] | point | A point where left mouse button is down in XFA page, in PDF coordinate system. |
| [in] | flags | Event flags. Please refer to values starting from fsdk.FillerE_EventFlagShiftKey and this should be one or a combination of these values. |
| def fsdk.XFAWidget.OnLButtonUp | ( | point, | |
| flags | |||
| ) |
Call this function when left mouse button is up.
| [in] | point | A point where left mouse button is up in XFA page, in PDF coordinate system. |
| [in] | flags | Event flags. Please refer to values starting from fsdk.FillerE_EventFlagShiftKey and this should be one or a combination of these values. |
| def fsdk.XFAWidget.OnMouseEnter | ( | ) |
Call this function when mouse enters current XFA widget.
| def fsdk.XFAWidget.OnMouseExit | ( | ) |
Call this function when mouse exits.
| def fsdk.XFAWidget.OnMouseMove | ( | point, | |
| flags | |||
| ) |
Call this function when mouse moves.
| [in] | point | A point where left mouse button moves in XFA page, in PDF coordinate system. |
| [in] | flags | Event flags. Please refer to values starting from fsdk.FillerE_EventFlagShiftKey and this should be one or a combination of these values. |
| def fsdk.XFAWidget.OnRButtonDown | ( | point, | |
| flags | |||
| ) |
Call this function when right mouse is down.
| [in] | point | A point where right mouse button is down in XFA page, in PDF coordinate system. |
| [in] | flags | Event flags. Please refer to values starting from fsdk.FillerE_EventFlagShiftKey and this should be one or a combination of these values. |
| def fsdk.XFAWidget.OnRButtonUp | ( | point, | |
| flags | |||
| ) |
Call this function when right button is up.
| [in] | point | A point where right mouse button is up in XFA page, in PDF coordinate system. |
| [in] | flags | Event flags. Please refer to values starting from fsdk.FillerE_EventFlagShiftKey and this should be one or a combination of these values. |
| def fsdk.XFAWidget.ResetData | ( | ) |
Reset XFA Widget Data.
| def fsdk.XFAWidget.SetCheckState | ( | is_checked | ) |
Set the checked state of the current XFA widget.
Applicable for check box or radio button as related XFA widget. For types that are not applicable, this function will throw exception fsdk.E_ErrUnsupported .
| [in] | is_checked | true means the current XFA widget will be checked, while false means it will not be checked. |
| def fsdk.XFAWidget.SetDefaultValue | ( | value | ) |
Set the default value string.
It is only useful for the XFA widget which type is fsdk.XFAWidgetE_WidgetTypeTextEdit , fsdk.XFAWidgetE_WidgetTypeNumericEdit , fsdk.XFAWidgetE_WidgetTypePasswordEdit or fsdk.XFAWidgetE_WidgetTypeDateTimeEdit .
| [in] | value | A string as default value to be set. It can be an empty string. |
| def fsdk.XFAWidget.SetImage | ( | image | ) |
Set the image for current XFA widget.
Applicable only when the type of current XFA widget is fsdk.XFAWidgetE_WidgetTypeImageEdit . For types that are not applicable, this function will throw exception fsdk.E_ErrUnsupported .
| [in] | image | An image will be set to current XFA widget. Currently, this function only supports the following image types:
If try to set rest unsupported image types, exception fsdk.E_ErrUnsupported will be thrown. |
| def fsdk.XFAWidget.SetOptions | ( | option_array | ) |
Set options of a choice list or an Exclusion Group (for radio button only).
Applicable for choice list and Exclusion Group (for radio button only). For types that are not applicable, this function will return false.
| [in] | option_array | An array of choice options to be set. |
| def fsdk.XFAWidget.SetValue | ( | value | ) |
Set the value string.
It is only useful for the XFA widget which type is fsdk.XFAWidgetE_WidgetTypeTextEdit , fsdk.XFAWidgetE_WidgetTypeNumericEdit , fsdk.XFAWidgetE_WidgetTypePasswordEdit or fsdk.XFAWidgetE_WidgetTypeDateTimeEdit .
| [in] | value | A string as value to be set. It can be an empty string. |