Foxit PDF SDK
FoxitPDFSDKPython3.XFADoc Class Reference
Inheritance diagram for FoxitPDFSDKPython3.XFADoc:
FoxitPDFSDKPython3.Base

Public Member Functions

def XFADoc (document, xfa_doc_provider_handler)
 Constructor. More...
 
def ExportData (output_file_path, export_type)
 Export data to a file. More...
 
def FlattenTo (output_file_path)
 Flatten current XFA document to a file. More...
 
def GetPage (page_index)
 Get XFA page by index. More...
 
def GetPageCount ()
 Get XFA page count. More...
 
def GetType ()
 Get the XFA document type. More...
 
def GetWidgetByFullName (full_name)
 Get the XFA widget which matches the specified full name. More...
 
def ImportData (file_path)
 Import data from an XML or XDP file. More...
 
def IsEmpty ()
 Check whether current object is empty or not. More...
 
def KillFocus ()
 Kill the focus of XFA widget. More...
 
def ProcessEvent (event_type)
 Process a kind of event for all the XFA widgets in current XFA document. More...
 
def ResetForm ()
 Reset form. More...
 
def SetDocProviderCallback (doc_provider_callback)
 Set XFA document provider callback. More...
 
def SetFocus (xfa_widget)
 Set the focus of XFA widget. More...
 
def SetPDFPath (pdf_file_path)
 Set the path of related PDF document. More...
 
def StartLoad (pause)
 Start to load content for current XFA document. More...
 

Static Public Attributes

 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.
 

Detailed Description

Class XFADoc is constructed from a loaded PDF document object, in order to access XFA content more clearly. User must call FoxitPDFSDKPython3.Library.RegisterXFAAppProviderCallback before using XFA moudle. For a newly constructed XFA object, please remember to call function FoxitPDFSDKPython3.XFADoc.StartLoad before using other functions in class XFA.
To search among an XFA document, please construct a FoxitPDFSDKPython3.TextSearch object with XFADoc object.

See also
FoxitPDFSDKPython3.TextSearch

Constructor & Destructor Documentation

◆ XFADoc()

def FoxitPDFSDKPython3.XFADoc.XFADoc (   document,
  xfa_doc_provider_handler 
)

Constructor.

Constructor, with another XFA document object.

Parameters
[in]documentA valid PDF document. It should has been loaded successfully.
[in]xfa_doc_provider_handlerAn 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 FoxitPDFSDKPython3.Library.Initialize , that means user has no right in using XFA related functions and this constructor will throw exception FoxitPDFSDKPython3.e_ErrNoXFAModuleRight .

When constructing an XFADoc by this constructor successfully, user must set XFA document provider callback by function FoxitPDFSDKPython3.XFADoc.SetDocProviderCallback .

Parameters
[in]documentA 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 FoxitPDFSDKPython3.Library.Initialize , that means user has no right in using XFA related functions and this constructor will throw exception FoxitPDFSDKPython3.e_ErrNoXFAModuleRight .
Parameters
[in]otherAnother XFA document object

Member Function Documentation

◆ ExportData()

def FoxitPDFSDKPython3.XFADoc.ExportData (   output_file_path,
  export_type 
)

Export data to a file.

Parameters
[in]output_file_pathA file path, to which data will be exported to.
[in]export_typeExport type. Please refer to values starting from FoxitPDFSDKPython3.XFADoc.e_ExportDataTypeXML and this should be one of these values.
Returns
true means success, while false means failure.

◆ FlattenTo()

def FoxitPDFSDKPython3.XFADoc.FlattenTo (   output_file_path)

Flatten current XFA document to a file.

Flatten current XFA document to a file stream.

Parameters
[in]output_file_pathA file path, to which the flattening result will be saved.
Returns
None.
Parameters
[in]streamA FoxitPDFSDKPython3.StreamCallback object which is implemented by user to save the flattened result.
Returns
None.

◆ GetPage()

def FoxitPDFSDKPython3.XFADoc.GetPage (   page_index)

Get XFA page by index.

Parameters
[in]page_indexThe page index. Valid range: from 0 to (count-1). count is returned by function FoxitPDFSDKPython3.XFADoc.GetPageCount .
Returns
The XFA page.

◆ GetPageCount()

def FoxitPDFSDKPython3.XFADoc.GetPageCount ( )

Get XFA page count.

Returns
Page count.

◆ GetType()

def FoxitPDFSDKPython3.XFADoc.GetType ( )

Get the XFA document type.

Returns
The type of XFA document. Please refer to values starting from FoxitPDFSDKPython3.XFADoc.e_Dynamic and this would be one of these values.

◆ GetWidgetByFullName()

def FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.XFAPage.GetWidgetByFullName to get the matched XFA widget in an XFA page.

Parameters
[in]full_nameAn XFA widget's full name. It should not be an empty string. XFA widget's full name can be retrieved by function FoxitPDFSDKPython3.XFAWidget.GetName with type FoxitPDFSDKPython3.XFAWidget.e_WidgetNameTypeFullName in previous process.
Returns
An XFA Widget object.

◆ ImportData()

def FoxitPDFSDKPython3.XFADoc.ImportData (   file_path)

Import data from an XML or XDP file.

Import data from a FoxitPDFSDKPython3.FileReaderCallback object.

Parameters
[in]file_pathA 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
[in]file_readerA FoxitPDFSDKPython3.FileReaderCallback object, whose data will be imported to current XFA document. It should be XML or XDP file.
Returns
true means success, while false means failure.

◆ IsEmpty()

def FoxitPDFSDKPython3.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 FoxitPDFSDKPython3.XFADoc.KillFocus ( )

Kill the focus of XFA widget.

Returns
None.

◆ ProcessEvent()

def FoxitPDFSDKPython3.XFADoc.ProcessEvent (   event_type)

Process a kind of event for all the XFA widgets in current XFA document.

Parameters
[in]event_typeAn event type. Please refer to values starting from FoxitPDFSDKPython3.XFADoc.e_EventTypePostPrint and this should be one of these values except FoxitPDFSDKPython3.XFADoc.e_EventTypeUnknown .
Returns
None.

◆ ResetForm()

def FoxitPDFSDKPython3.XFADoc.ResetForm ( )

Reset form.

Returns
None.

◆ SetDocProviderCallback()

def FoxitPDFSDKPython3.XFADoc.SetDocProviderCallback (   doc_provider_callback)

Set XFA document provider callback.

Parameters
[in]doc_provider_callbackAn 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 FoxitPDFSDKPython3.XFADoc.SetFocus (   xfa_widget)

Set the focus of XFA widget.

Parameters
[in]xfa_widgetAn XFA widget which would be focused.
Returns
None.

◆ SetPDFPath()

def FoxitPDFSDKPython3.XFADoc.SetPDFPath (   pdf_file_path)

Set the path of related PDF document.

The PDF path will be used in function FoxitPDFSDKPython3.XFADoc.ExportData , to be a part of exported data.

Parameters
[in]pdf_file_pathThe 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 FoxitPDFSDKPython3.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]pausePause 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 FoxitPDFSDKPython3.Progressive.GetRateOfProgress . If the rate is not 100 yet, call function FoxitPDFSDKPython3.Progressive.Continue to continue the progress until the progress is finished.