VintaSoft Twain .NET SDK v10.2
Vintasoft.Shared Namespace / WebImageCollectionJS type / loadState Method
Function that will be executed if request is executed successfully.
Here is function prototype "function __success(data)".
The data parameter has the following properties:
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.
Instance of Shared.WebServiceJS class, which allows to manage an image collection.
This parameter is optional.
Web service specified by the Shared.WebServiceJS.defaultImageCollectionService property will be used if this parameter is not specified.
In This Topic
    loadState Method
    In This Topic
    Function that sends an asynchronous request to a server for restoring state of image collection from server.
    Syntax
    var instance = new Vintasoft.Shared.WebImageCollectionJS();
    var value; // Type: any
    
    // Parameters
    var successFunc; // Type:  object
    var errorFunc; // Type:  object
    var service; // Type:  object
    
    value = instance.loadState(successFunc, errorFunc, service);
    function loadState( 
       successFunc : object,
       errorFunc : object,
       service : object
    ) : any;

    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:
    • imageInfos (object): Information about cached image collection.
    • images (object): An array of Shared.WebImageJS created using imageInfos property.
    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
    Instance of Shared.WebServiceJS class, which allows to manage an image collection.
    This parameter is optional.
    Web service specified by the Shared.WebServiceJS.defaultImageCollectionService property will be used if this parameter is not specified.
    Browser Compatibility
    9
    5
    11
    5
    See Also