convertToPdfA Method

In This Topic

Sends an asynchronous request to convert this PDF document to PDF/A format.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance = new Vintasoft.Imaging.Pdf.WebPdfDocumentJS(id, service, pdfDocumentEditorControl);

var value; // Type: any

// Parameters
var pdfAFormat; // Type: string
var successFunc; // Type: function
var errorFunc; // Type: function

value = instance.convertToPdfA(pdfAFormat, successFunc, errorFunc);

function convertToPdfA(
   pdfAFormatPDF/A conversion format.
 Supported formats:
  "1a"
 "1b"
 "2a"
 "2b"
 "2u".
 "3a"
 "3b"
 "3u"
 "4"
 "4f"
 "4e"
 
 : string, 
   successFuncFunction that will be executed if request is executed successfully. Here is function prototype "function __success(data)".
 The data parameter has the following properties:
  id (string): An identifier of converted PDF document.
 result (string): Information about PDF/A conversion result. 
 
 : Function, 
   errorFuncFunction that will be executed if request is failed. Here is function prototype "function __error(data)".
 The data parameter can be:
  An object with following properties:
  result (string): Information about PDF/A conversion result. 
errorMessage (string): Error message.
 blocked (boolean): Indicates that the requested action is blocked by another request.
 
 if exception is catched inside web service. 
 Otherwise, jqXHR object.
 
 : Function
) : any;

Parameters

pdfAFormat

PDF/A conversion format.
Supported formats:

"1a"
"1b"
"2a"
"2b"
"2u".
"3a"
"3b"
"3u"
"4"
"4f"
"4e"

successFunc

Function that will be executed if request is executed successfully. Here is function prototype "function __success(data)".
The data parameter has the following properties:

id (string): An identifier of converted PDF document.
result (string): Information about PDF/A conversion result.

errorFunc

Function that will be executed if request is failed. Here is function prototype "function __error(data)".
The data parameter can be:

An object with following properties:
- result (string): Information about PDF/A conversion result.
- errorMessage (string): Error message.
- blocked (boolean): Indicates that the requested action is blocked by another request.
if exception is catched inside web service.
Otherwise, jqXHR object.

Exceptions

Exception	Description
	Thrown if arguments have wrong types.

Browser Compatibility

56+

45+

Reference

WebPdfDocumentJS Class
WebPdfDocumentJS Members

Send Feedback