Foxit PDF SDK
|
Instance Methods | |
(BOOL) | - exportData:export_type: |
Export data to a file. More... | |
(void) | - flattenTo: |
Flatten current XFA document to a file. More... | |
(void) | - flattenToWithStreamCallback: |
Flatten current XFA document to a file stream. More... | |
(FSXFAPage *) | - getPage: |
Get XFA page by index. More... | |
(int) | - getPageCount |
Get XFA page count. More... | |
(FSXFADocType) | - getType |
Get the XFA document type. More... | |
(FSXFAWidget *) | - getWidgetByFullName: |
Get the XFA widget which matches the specified full name. More... | |
(BOOL) | - importData: |
Import data from an XML or XDP file. More... | |
(BOOL) | - importDataWithReaderCallback: |
Import data from a FSFileReaderCallback object. More... | |
(id) | - initWithDocument: |
Constructor. More... | |
(id) | - initWithDocument:xfa_doc_provider_handler: |
Constructor. More... | |
(id) | - initWithOther: |
Constructor, with another XFA document object. More... | |
(BOOL) | - isEmpty |
Check whether current object is empty or not. More... | |
(void) | - killFocus |
Kill the focus of XFA widget. More... | |
(void) | - processEvent: |
Process a kind of event for all the XFA widgets in current XFA document. More... | |
(void) | - resetForm |
Reset form. More... | |
(void) | - setDocProviderCallback: |
Set XFA document provider callback. More... | |
(void) | - setFocus: |
Set the focus of XFA widget. More... | |
(void) | - setPDFPath: |
Set the path of related PDF document. More... | |
(FSProgressive *) | - startLoad: |
Start to load content for current XFA document. More... | |
Class FSXFADoc is constructed from a loaded PDF document object, in order to access XFA content more clearly. User must call FSLibrary::registerXFAAppProviderCallback: before using XFA moudle. For a newly constructed XFA object, please remember to call function FSXFADoc::startLoad: before using other functions in class XFA.
To search among an XFA document, please construct a FSTextSearch object with FSXFADoc object.
- (bool) exportData: | (NSString *) | output_file_path | |
export_type: | (FSXFADocExportDataType) | export_type | |
Export data to a file.
[in] | output_file_path | A file path, to which data will be exported to. |
[in] | export_type | Export type. Please refer to values starting from FSXFADocExportDataTypeXML and this should be one of these values. |
- (void) flattenTo: | (NSString *) | output_file_path |
Flatten current XFA document to a file.
[in] | output_file_path | A file path, to which the flattening result will be saved. |
- (void) flattenToWithStreamCallback: | (id<FSFileStreamCallback>) | stream |
Flatten current XFA document to a file stream.
[in] | stream | A FSFileStreamCallback object which is implemented by user to save the flattened result. |
- (FSXFAPage *) getPage: | (int) | page_index |
Get XFA page by index.
[in] | page_index | The page index. Valid range: from 0 to (count-1). count is returned by function FSXFADoc::getPageCount. |
- (int) getPageCount |
Get XFA page count.
- (FSXFADocType) getType |
Get the XFA document type.
- (FSXFAWidget *) getWidgetByFullName: | (NSString *) | 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 FSXFAPage::getWidgetByFullName: to get the matched XFA widget in an XFA page.
[in] | full_name | An XFA widget's full name. It should not be an empty string. XFA widget's full name can be retrieved by function FSXFAWidget::getName: with type FSXFAWidgetWidgetNameTypeFullName in previous process. |
- (BOOL) importData: | (NSString *) | file_path |
Import data from an XML or XDP file.
[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". |
- (BOOL) importDataWithReaderCallback: | (id<FSFileReaderCallback>) | file_reader |
Import data from a FSFileReaderCallback object.
[in] | file_reader | A FSFileReaderCallback object, whose data will be imported to current XFA document. It should be XML or XDP file. |
- (id) initWithDocument: | (FSPDFDoc*) | document |
Constructor.
When constructing an XFADoc by this constructor successfully, user must set XFA document provider callback by function FSXFADoc::setDocProviderCallback:.
[in] | document | A valid PDF document. It should has been loaded successfully. |
- (id) initWithDocument: | (FSPDFDoc*) | document | |
xfa_doc_provider_handler: | (id<FSDocProviderCallback>) | xfa_doc_provider_handler | |
Constructor.
[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 . It should not be nil. User should ensure this callback object is kept valid until related PDF document is released. |
- (id) initWithOther: | (FSXFADoc*) | other |
Constructor, with another XFA document object.
[in] | other | Another XFA document object |
- (BOOL) isEmpty |
Check whether current object is empty or not.
When the current object is empty, that means current object is useless.
- (void) killFocus |
Kill the focus of XFA widget.
- (void) processEvent: | (FSXFADocEventType) | event_type |
Process a kind of event for all the XFA widgets in current XFA document.
[in] | event_type | An event type. Please refer to values starting from FSXFADocEventTypePostPrint and this should be one of these values except FSXFADocEventTypeUnknown. |
- (void) resetForm |
Reset form.
- (void) setDocProviderCallback: | (id<FSDocProviderCallback>) | doc_provider_callback |
Set XFA document provider callback.
[in] | doc_provider_callback | An XFA document provider callback object which is implemented by user and based on callback class . It should not be nil. User should ensure this callback object is kept valid until related PDF document is released. |
- (void) setFocus: | (FSXFAWidget*) | xfa_widget |
Set the focus of XFA widget.
[in] | xfa_widget | An XFA widget which would be focused. |
- (void) setPDFPath: | (NSString *) | pdf_file_path |
Set the path of related PDF document.
The PDF path will be used in function FSXFADoc::exportData:export_type:, to be a part of exported data.
[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. |
- (FSProgressive *) startLoad: | (id<FSPauseCallback>) | 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.
[in] | pause | Pause object which decides if the importing process needs to be paused. This can be nil which means not to pause during the parsing process. If this is not nil, it should be a valid pause object implemented by user. |