VintaSoft Imaging .NET SDK 14.0: Documentation for Web developer
Vintasoft.Imaging.ImageProcessing Namespace / WebImageProcessingCommandBaseJS type / execute Methods / execute(Vintasoft.Shared.WebImageJS,function,function) Property
Syntax Exceptions BrowserCompatibility SeeAlso
In This Topic
    execute(Vintasoft.Shared.WebImageJS,function,function) Method
    In This Topic
    Executes the image processing command.
    Syntax
    var instance = new Vintasoft.Imaging.ImageProcessing.WebImageProcessingCommandBaseJS();
    
    var value; // Type: boolean
    
    // Parameters
    var image; // Type: WebImageJS
    var successFunc; // Type: function
    var errorFunc; // Type: function
    
    value = instance.execute(image, successFunc, errorFunc);
    
    
    function execute(
    image
    Image that should be processed.
    : WebImageJS,
    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.
    : Function,
    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.
    : Function
    ) : boolean;

    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.

    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