|
| e_Dynamic = _fsdk.XFADoc_e_Dynamic |
| XFA document type: Dynamic.
|
|
| e_EventTypePostPrint = _fsdk.XFADoc_e_EventTypePostPrint |
| This kind of event is triggered just after the rendered form has been sent to the printer, spooler, or output destination.
|
|
| e_EventTypePrePrint = _fsdk.XFADoc_e_EventTypePrePrint |
| This kind of event is triggered just before the rendering for printing begins.
|
|
| e_EventTypeUnknown = _fsdk.XFADoc_e_EventTypeUnknown |
| Event type: Unknown.
|
|
| e_ExportDataTypeStaticXDP = _fsdk.XFADoc_e_ExportDataTypeStaticXDP |
| Type of exported data: Static XDP.
|
|
| e_ExportDataTypeXDP = _fsdk.XFADoc_e_ExportDataTypeXDP |
| Type of exported data: XDP.
|
|
| e_ExportDataTypeXML = _fsdk.XFADoc_e_ExportDataTypeXML |
| Type of exported data: XML.
|
|
| e_Static = _fsdk.XFADoc_e_Static |
| XFA document type: Static.
|
|
| e_XDP = _fsdk.XFADoc_e_XDP |
| XFA document type: XDP, as Raw XML data.
|
|
Class XFADoc is constructed from a loaded PDF document object, in order to access XFA content more clearly. User must call FoxitPDFSDKPython2.Library.RegisterXFAAppProviderCallback before using XFA moudle. For a newly constructed XFA object, please remember to call function FoxitPDFSDKPython2.XFADoc.StartLoad before using other functions in class XFA.
To search among an XFA document, please construct a FoxitPDFSDKPython2.TextSearch object with XFADoc object.
- See also
- FoxitPDFSDKPython2.TextSearch
◆ XFADoc()
def FoxitPDFSDKPython2.XFADoc.XFADoc |
( |
|
document, |
|
|
|
xfa_doc_provider_handler |
|
) |
| |
Constructor.
Constructor, with another XFA document object.
- Parameters
-
[in] | document | A valid PDF document. It should has been loaded successfully. |
[in] | xfa_doc_provider_handler | An XFA document provider callback object which is implemented by user and based on callback class DocProviderCallback . It should not be null. User should ensure this callback object is kept valid until related PDF document is released. |
- Note
- If module "XFA" is not defined in the license information which is used in function FoxitPDFSDKPython2.Library.Initialize , that means user has no right in using XFA related functions and this constructor will throw exception FoxitPDFSDKPython2.e_ErrNoXFAModuleRight .
When constructing an XFADoc by this constructor successfully, user must set XFA document provider callback by function FoxitPDFSDKPython2.XFADoc.SetDocProviderCallback .
- Parameters
-
[in] | document | A valid PDF document. It should has been loaded successfully. |
- Note
- If module "XFA" is not defined in the license information which is used in function FoxitPDFSDKPython2.Library.Initialize , that means user has no right in using XFA related functions and this constructor will throw exception FoxitPDFSDKPython2.e_ErrNoXFAModuleRight .
- Parameters
-
[in] | other | Another XFA document object |
◆ ExportData()
def FoxitPDFSDKPython2.XFADoc.ExportData |
( |
|
output_file_path, |
|
|
|
export_type |
|
) |
| |
Export data to a file.
- Parameters
-
- Returns
- true means success, while false means failure.
◆ FlattenTo()
def FoxitPDFSDKPython2.XFADoc.FlattenTo |
( |
|
output_file_path | ) |
|
Flatten current XFA document to a file.
Flatten current XFA document to a file stream.
- Parameters
-
[in] | output_file_path | A file path, to which the flattening result will be saved. |
- Returns
- None.
- Parameters
-
- Returns
- None.
◆ GetPage()
def FoxitPDFSDKPython2.XFADoc.GetPage |
( |
|
page_index | ) |
|
Get XFA page by index.
- Parameters
-
- Returns
- The XFA page.
◆ GetPageCount()
def FoxitPDFSDKPython2.XFADoc.GetPageCount |
( |
| ) |
|
Get XFA page count.
- Returns
- Page count.
◆ GetType()
def FoxitPDFSDKPython2.XFADoc.GetType |
( |
| ) |
|
◆ GetWidgetByFullName()
def FoxitPDFSDKPython2.XFADoc.GetWidgetByFullName |
( |
|
full_name | ) |
|
Get the XFA widget which matches the specified full name.
Some XFA widgets may cover serveral XFA pages. In this case, this function can only be used to get the first matched XFA widget in XFA document. User can also use function FoxitPDFSDKPython2.XFAPage.GetWidgetByFullName to get the matched XFA widget in an XFA page.
- Parameters
-
- Returns
- An XFA Widget object.
◆ ImportData()
def FoxitPDFSDKPython2.XFADoc.ImportData |
( |
|
file_path | ) |
|
Import data from an XML or XDP file.
Import data from a FoxitPDFSDKPython2.FileReaderCallback object.
- Parameters
-
[in] | file_path | A path of a source file, whose data will be imported to current XFA document. It should be XML or XDP file and the file extension should be ".xml" or ".xdp". |
- Returns
- true means success, while false means failure.
- Parameters
-
- Returns
- true means success, while false means failure.
◆ IsEmpty()
def FoxitPDFSDKPython2.XFADoc.IsEmpty |
( |
| ) |
|
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.
◆ KillFocus()
def FoxitPDFSDKPython2.XFADoc.KillFocus |
( |
| ) |
|
Kill the focus of XFA widget.
- Returns
- None.
◆ ProcessEvent()
def FoxitPDFSDKPython2.XFADoc.ProcessEvent |
( |
|
event_type | ) |
|
Process a kind of event for all the XFA widgets in current XFA document.
- Parameters
-
- Returns
- None.
◆ ResetForm()
def FoxitPDFSDKPython2.XFADoc.ResetForm |
( |
| ) |
|
◆ SetDocProviderCallback()
def FoxitPDFSDKPython2.XFADoc.SetDocProviderCallback |
( |
|
doc_provider_callback | ) |
|
Set XFA document provider callback.
- Parameters
-
[in] | doc_provider_callback | An XFA document provider callback object which is implemented by user and based on callback class DocProviderCallback . It should not be null. User should ensure this callback object is kept valid until related PDF document is released. |
- Returns
- None.
◆ SetFocus()
def FoxitPDFSDKPython2.XFADoc.SetFocus |
( |
|
xfa_widget | ) |
|
Set the focus of XFA widget.
- Parameters
-
[in] | xfa_widget | An XFA widget which would be focused. |
- Returns
- None.
◆ SetPDFPath()
def FoxitPDFSDKPython2.XFADoc.SetPDFPath |
( |
|
pdf_file_path | ) |
|
Set the path of related PDF document.
The PDF path will be used in function FoxitPDFSDKPython2.XFADoc.ExportData , to be a part of exported data.
- Parameters
-
[in] | pdf_file_path | The file path of related PDF document. It can be either an absolute path or a relative path. It should not be an empty string. |
- Returns
- None.
◆ StartLoad()
def FoxitPDFSDKPython2.XFADoc.StartLoad |
( |
|
pause | ) |
|
Start to load content for current XFA document.
It may take a long time to loading XFA content, so this function uses a progressive process to do this.
The related PDF document object has been loaded, but only PDF related contents have been loaded. So, in order to access XFA content, this function should be called to load XFA content.
- Parameters
-
[in] | pause | Pause object which decides if the importing process needs to be paused. This can be null which means not to pause during the parsing process. If this is not null, it should be a valid pause object implemented by user. |
- Returns
- A progressive object. Please check the rate of current progress by function FoxitPDFSDKPython2.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function FoxitPDFSDKPython2.Progressive.Continue to continue the progress until the progress is finished.