VintaSoft Imaging .NET SDK 15.1: Documentation for Web developer
Vintasoft.Imaging.ImageProcessing.DocCleanup Namespace / WebOcrPreprocessingCommandJS type / execute Methods / execute(Vintasoft.Shared.WebImageJS,function,function,Vintasoft.Shared.WebServiceJS) Property
Syntax Exceptions BrowserCompatibility SeeAlso
In This Topic
execute(Vintasoft.Shared.WebImageJS,function,function,Vintasoft.Shared.WebServiceJS) Method
In This Topic
Executes the image processing command.
Syntax
var instance = new Vintasoft.Imaging.ImageProcessing.DocCleanup.WebOcrPreprocessingCommandJS();

var value; // Type: boolean

// Parameters
var image; // Type: WebImageJS
var successFunc; // Type: function
var errorFunc; // Type: function
var service; // Type: WebServiceJS

value = instance.execute(image, successFunc, errorFunc, service);

Parameters

image
Image that should be processed.
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:
  • imageInfo (object): Information about image (image ID and page index).
  • sourceImage (object): WebImageJS object, which represents source image.
errorFunc
Function that will be executed if request is failed.
Here is function prototype "function __error(data)".
The data parameter can be:
  1. An object with following properties:
    • errorMessage (string): Error message.
    • blocked (boolean): Indicates that the requested action is blocked by another request.
    if exception is catched inside web service.
  2. Otherwise, jqXHR object.
service
WebServiceJS that shoud process the image.

Return Value

true if image is processed; false if processing is canceled or not necessary.
Exceptions
ExceptionDescription
Thrown if arguments have wrong types.
Thrown if image has an unsupported pixel format.
Browser Compatibility
56+
45+
11
See Also