All Classes Namespaces Functions Enumerations Enumerator Pages
foxit.addon.xfa.XFADoc Class Reference
Inheritance diagram for foxit.addon.xfa.XFADoc:
foxit.common.Base

Public Types

enum  EventType { EventType.e_EventTypeUnknown = 0, EventType.e_EventTypePostPrint = 1, EventType.e_EventTypePrePrint = 2 }
 Enumeration for XFA event type. More...
 
enum  ExportDataType { ExportDataType.e_ExportDataTypeXML = 0, ExportDataType.e_ExportDataTypeStaticXDP = 1, ExportDataType.e_ExportDataTypeXDP = 2 }
 Enumeration for the type of exported data. More...
 
enum  Type { Type.e_Dynamic = 0, Type.e_Static = 1, Type.e_XDP = 2 }
 Enumeration for XFA document type. More...
 

Public Member Functions

 XFADoc (PDFDoc document, DocProviderCallback xfa_doc_provider_handler)
 Constructor. More...
 
 XFADoc (XFADoc other)
 Constructor, with another XFA document object.
 
void ExportData (string output_file_path, XFADoc.ExportDataType export_type)
 Export data to a file. More...
 
void FlattenTo (string output_file_path)
 Flatten current XFA document to a file. More...
 
XFAPage GetPage (int page_index)
 Get XFA page by index. More...
 
int GetPageCount ()
 Get XFA page count. More...
 
XFADoc.Type GetType ()
 Get the XFA document type. More...
 
bool ImportData (string file_path)
 Import data from an XML or XDP file. More...
 
bool IsEmpty ()
 Check whether current object is empty or not. More...
 
void KillFocus ()
 Kill the focus of XFA widget. More...
 
void ProcessEvent (XFADoc.EventType event_type)
 Process a kind of event for all the XFA widgets in current XFA document. More...
 
void ResetForm ()
 Reset form. More...
 
void SetPDFPath (string pdf_file_path)
 Set the path of related PDF document. More...
 
Progressive StartLoad (PauseCallback pause)
 Start to load content for current XFA document. More...
 

Detailed Description

Class addon::xfa::XFADoc is constructed from a loaded PDF document object, in order to access XFA content more clearly. For a newly constructed XFA object, please remember to call function addon::xfa::XFADoc::StartLoad before using other functions in class XFA. To search among a XFA document, please construct a pdf::TextSearch object with addon::xfa::XFADoc object.

See Also
pdf::TextSearch

Member Enumeration Documentation

Enumeration for XFA event type.

Values of this enumeration should be used alone.

Enumerator
e_EventTypeUnknown 

Event type: Unknown.

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 

This kind of event is triggered just before the rendering for printing begins.

Enumeration for the type of exported data.

Values of this enumeration should be used alone.

Enumerator
e_ExportDataTypeXML 

Type of exported data: XML.

e_ExportDataTypeStaticXDP 

Type of exported data: Static XDP.

e_ExportDataTypeXDP 

Type of exported data: XDP.

Enumeration for XFA document type.

Values of this enumeration should be used alone.

Enumerator
e_Dynamic 

XFA document type: Dynamic.

e_Static 

XFA document type: Static.

e_XDP 

XFA document type: XDP, as Raw XML data.

Constructor & Destructor Documentation

foxit.addon.xfa.XFADoc.XFADoc ( PDFDoc  document,
DocProviderCallback  xfa_doc_provider_handler 
)
inline

Constructor.

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

Member Function Documentation

void foxit.addon.xfa.XFADoc.ExportData ( string  output_file_path,
XFADoc.ExportDataType  export_type 
)
inline

Export data to a file.

Parameters
output_file_pathA file path, to which data will be exported to.
export_typeExport type. Please refer to e_ExportDataTypeXXX values and it should be one of these values.
Returns
None.
void foxit.addon.xfa.XFADoc.FlattenTo ( string  output_file_path)
inline

Flatten current XFA document to a file.

Parameters
output_file_pathA file path, to which the flattening result will be saved.
Returns
None.
XFAPage foxit.addon.xfa.XFADoc.GetPage ( int  page_index)
inline

Get XFA page by index.

Parameters
page_indexThe page index. Valid range: from 0 to (count-1). count is returned by function addon::xfa::XFADoc::GetPageCount.
Returns
The XFA page.
int foxit.addon.xfa.XFADoc.GetPageCount ( )
inline

Get XFA page count.

Returns
Page count.
XFADoc.Type foxit.addon.xfa.XFADoc.GetType ( )
inline

Get the XFA document type.

Returns
The type of XFA document. Please refer to e_XXX values and it would be one of these values.
bool foxit.addon.xfa.XFADoc.ImportData ( string  file_path)
inline

Import data from an XML or XDP file.

Parameters
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.
bool foxit.addon.xfa.XFADoc.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.
void foxit.addon.xfa.XFADoc.KillFocus ( )
inline

Kill the focus of XFA widget.

Returns
None.
void foxit.addon.xfa.XFADoc.ProcessEvent ( XFADoc.EventType  event_type)
inline

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

Parameters
event_typeAn event type. Please refer to e_EventTypeXXX values and it should be one of these values except e_EventTypeUnknown.
Returns
true means success, while false means failure.
void foxit.addon.xfa.XFADoc.ResetForm ( )
inline

Reset form.

Returns
None.
void foxit.addon.xfa.XFADoc.SetPDFPath ( string  pdf_file_path)
inline

Set the path of related PDF document.

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

Parameters
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.
Progressive foxit.addon.xfa.XFADoc.StartLoad ( PauseCallback  pause)
inline

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
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 common::Progressive::GetRateOfProgress. If the rate is not 100 yet, call function common::Progressive::Continue to coninue the progress until the progress is finished.

Foxit Software Corporation Logo
@2018 Foxit Software Incorporated. All rights reserved.