PTDataExtractionModule

@interface PTDataExtractionModule : NSObject

The class DataExtractionModule. static interface to Apryse SDKs data extraction functionality

  • Find out whether the specified data extraction module is available (and licensed).

    Declaration

    Objective-C

    + (BOOL)IsModuleAvailable:(PTDataExtractionEngine)engine;

    Swift

    class func isModuleAvailable(_ engine: PTDataExtractionEngine) -> Bool

    Parameters

    engine

    – The extraction engine.

    Return Value

    returns true if data extraction operations can be performed.

  • Perform data extraction on a PDF file using the specified engine and return the resulting JSON string. Note: The FormKeyValue engine is experimental and subject to change.

    Declaration

    Objective-C

    + (NSString *)ExtractDataAsString:(NSString *)input_pdf_file
                           engine:(PTDataExtractionEngine)engine
                          options:(PTDataExtractionOptions *)options;

    Swift

    class func extractData(as input_pdf_file: String!, engine: PTDataExtractionEngine, options: PTDataExtractionOptions!) -> String!

    Parameters

    input_pdf_file

    – The source document filename.
    engine

    – The extraction engine.
    options

    – Data extraction options (optional).

    Return Value

    JSON string representing the extracted results.

  • Perform data extraction on a PDF file using the specified engine. Note: The FormKeyValue engine is experimental and subject to change.

    Declaration

    Objective-C

    + (NSString *)ExtractData:(NSString *)input_pdf_file
                   engine:(PTDataExtractionEngine)engine;

    Swift

    class func extractData(_ input_pdf_file: String!, engine: PTDataExtractionEngine) -> String!

    Parameters

    input_pdf_file

    – The source document filename.
    output_json_file

    – The resulting JSON filename.
    engine

    – The extraction engine.
    options

    – Data extraction options (optional).

  • Perform automatic form field detection, then insert the fields into the PDF. Note: The FormKeyValue engine is experimental and subject to change.

    Declaration

    Objective-C

    + (void)DetectAndAddFormFieldsToPDF:(PTPDFDoc *)doc
                            options:(PTDataExtractionOptions *)options;

    Swift

    class func detectAndAddFormFields(toPDF doc: PTPDFDoc!, options: PTDataExtractionOptions!)

    Parameters

    doc

    – The PDF document where fields are detected from and inserted into.
    options

    – Data extraction options (optional).

  • Perform data extraction on a PDF in XLSX output format.

    Declaration

    Objective-C

    + (void)ExtractToXLSX:(NSString *)input_pdf_file
     output_xlsx_file:(NSString *)output_xlsx_file
              options:(PTDataExtractionOptions *)options;

    Swift

    class func extract(toXLSX input_pdf_file: String!, output_xlsx_file: String!, options: PTDataExtractionOptions!)

    Parameters

    input_pdf_file

    – The source document filename.
    output_xlsx_file

    – The resulting XLSX filename.
    options

    – Data extraction options (optional).

  • Perform data extraction on a PDF in XLSX output format.

    Declaration

    Objective-C

    + (void)ExtractToXLSXWithFilter:(NSString *)input_pdf_file
             output_xlsx_stream:(PTFilter *)output_xlsx_stream
                        options:(PTDataExtractionOptions *)options;

    Swift

    class func extractToXLSX(withFilter input_pdf_file: String!, output_xlsx_stream: PTFilter!, options: PTDataExtractionOptions!)

    Parameters

    input_pdf_file

    – The source document filename.
    output_xlsx_stream

    – The resulting XLSX filter.
    options

    – Data extraction options (optional).

  • Undocumented

    Declaration

    Objective-C

    - (instancetype)init;

    Swift

    init!()