VintaSoft Twain .NET SDK 15.0: Documentation for Web developer
Vintasoft.Shared Namespace / WebImageJS type / getImageAsBase64String Property
Syntax Exceptions BrowserCompatibility SeeAlso
In This Topic
    getImageAsBase64String Method
    In This Topic
    Sends an asynchronous request for getting of image.
    Syntax
    var instance = new Vintasoft.Shared.WebImageJS(imageSource, pageIndex);
    
    var value; // Type: object
    
    // Parameters
    var successFunc; // Type: function
    var errorFunc; // Type: function
    
    value = instance.getImageAsBase64String(successFunc, errorFunc);
    
    
    function getImageAsBase64String(
    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:
    • fileId (string): A Base64 presentation of image.
    • image (object): An instance of WebImageJS class that represents the 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
    ) : object;

    Parameters

    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:
    • fileId (string): A Base64 presentation of image.
    • image (object): An instance of WebImageJS class that represents the 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

    Request object.
    Exceptions
    ExceptionDescription
    Thrown if arguments have wrong types.
    Browser Compatibility
    9
    See Also