VintaSoft Twain .NET SDK v10.3
Vintasoft.Twain Namespace / WebTwainDeviceJS type / setImageLayout Method
Image layout rectangle.
Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
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.
In This Topic
    setImageLayout Method
    In This Topic
    Sends an asynchronous request to a server for setting the image layout rectangle of TWAIN device.
    Syntax
    var instance = new Vintasoft.Twain.WebTwainDeviceJS(deviceName,
                                                       productFamily,
                                                       manufacturer,
                                                       driverVersion,
                                                       twainVersion,
                                                       deviceManager);
    var value; // Type: any
    
    // Parameters
    var frame; // Type:  object
    var successFunc; // Type:  object
    var errorFunc; // Type:  object
    
    value = instance.setImageLayout(frame, successFunc, errorFunc);
    function setImageLayout( 
       frame : object,
       successFunc : object,
       errorFunc : object
    ) : any;

    Parameters

    frame
    Image layout rectangle.
    successFunc
    Function that will be executed if request is executed successfully.
    Here is function prototype "function __success(data)".
    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.
    Exceptions
    ExceptionDescription
    Thrown if argument has wrong type.
    Thrown if device is not opened.
    Browser Compatibility
    9
    5
    15
    5
    See Also