VintaSoft Imaging .NET SDK 14.0: Documentation for Web developer
Vintasoft.Imaging Namespace / WebImageMetadataJS type / requestTextRegion Property
Syntax Exceptions Remarks BrowserCompatibility SeeAlso
In This Topic
    requestTextRegion Method
    In This Topic
    Sends an asynchronous request for getting information about text region of this image.
    Syntax
    var instance = new Vintasoft.Imaging.WebImageMetadataJS(image);
    
    var value; // Type: any
    
    // Parameters
    var successFunc; // Type: function
    var errorFunc; // Type: function
    
    value = instance.requestTextRegion(successFunc, errorFunc);
    
    
    function requestTextRegion(
    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:
    • textRegion (object): WebTextRegionJS object that defines text region of this image OR null if this image does not have text region.
    : 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
    ) : 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:
    • textRegion (object): WebTextRegionJS object that defines text region of this image OR null if this image does not have text region.
    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 arguments have wrong types.
    Remarks

    The data.textRegion property will be set to an empty text region if request was failed and the source document was not blocked. Call this method again if request was failed and the source document was not blocked.

    Browser Compatibility
    56+
    45+
    11
    See Also