textSearchProgress Event (WebTextSelectionToolJS)

In This Topic

Occurs when the text search process is in progress.

Syntax

Javascript (Usage)
Javascript (Specification)

var instance; // Type: WebTextSelectionToolJS
instance.textSearchProgress = function(event) { }

textSearchProgress = function (
   eventObject that contains information about event. Object has the following properties:
  target (object): An object that raised the event.
 type (string): Event name.
 data (object): An object that contains data, which were specified when subscribing to the event.
 originalEvent (object): Original event if event was received from DOM-element.
 
 : object
   eventsArgsObject that contains event arguments. Object has the following properties:
  result (object): Result of search (WebTextRegionJS object). Can be null if nothing is found or an error occurred.
 image (object): The WebImageJS object, from image viewer collection.
 error (string): Error message. Not empty if an error occurred.
 progress (number): The number of images, where the text search has already been performed.
 total (number): The total count of images, where text is searched.
 
 : object
) { };

Parameters

event

Object that contains information about event. Object has the following properties:

target (object): An object that raised the event.
type (string): Event name.
data (object): An object that contains data, which were specified when subscribing to the event.
originalEvent (object): Original event if event was received from DOM-element.

eventArgs

Object that contains event arguments. Object has the following properties:

result (object): Result of search (WebTextRegionJS object). Can be null if nothing is found or an error occurred.
image (object): The WebImageJS object, from image viewer collection.
error (string): Error message. Not empty if an error occurred.
progress (number): The number of images, where the text search has already been performed.
total (number): The total count of images, where text is searched.

Browser Compatibility

56+

45+

Reference

WebTextSelectionToolJS Class
WebTextSelectionToolJS Members

Send Feedback