requestTextBlocks Method

In This Topic

Sends an asynchronous request for getting all text blocks, which are located on PDF page.

Syntax

var instance = new Vintasoft.Imaging.Pdf.WebPdfPageJS(pdfDocument, pageIndex);

var value; // Type: any

// Parameters
var successFunc; // Type: function
var errorFunc; // Type: function

value = instance.requestTextBlocks(successFunc, errorFunc);

function requestTextBlocks(
   successFuncFunction that will be executed if request is executed successfully. Here is function prototype "function __success(data)".
 The data parameter has the following properties:
  textBlocks (object): Array of WebPdfTextBlockJS objects that defines all text blocks, which are located on PDF page.
 
 : Function, 
   errorFuncFunction that will be executed if request is failed. Here is function prototype "function __error(data)".
 The data parameter can be:
  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. 
 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:

textBlocks (object): Array of WebPdfTextBlockJS objects that defines all text blocks, which are located on PDF page.

errorFunc

Function that will be executed if request is failed. Here is function prototype "function __error(data)".
The data parameter can be:

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.
Otherwise, jqXHR object.

Exceptions

Exception	Description
	Thrown if arguments have wrong types.

Browser Compatibility

56+

45+

Reference

WebPdfPageJS Class
WebPdfPageJS Members

Send Feedback