prepareAjax Event


Event that occurs before any AJAX request is made to the server to allow the user to examine or modify the parameters passed.


JavaScript Syntax
Object.defineProperty(DocumentFactory, 'prepareAjax', 
   get: function() 

TypeScript Syntax
static readonly prepareAjax: PrepareAjaxEventType; 


A user can add a handler to this event, which will fire before every AJAX request the Document library makes. An application can trigger this event programmatically with cancelFromPrepareAjax.

In the case of methods that retrieve elements, such as GetImageElement, this event will fire when an AJAX loading method is used. If an ImageLoader is provided as a parameter, AJAX settings will be retrieved from UrlMode and AjaxOptions. Otherwise, the default options from ElementAjaxMethod and ElementUrlMode are used. See Documents-ImageLoading for more information.

The event data is of type PrepareAjaxEventArgs and will contain the following:

Member Value
The event source parameter

The object making the request. For instance, this will be DocumentFactory for DocumentFactory.loadFromUri since the method is "static" and the LEADDocument or DocumentPage object for LEADDocument.Convert and DocumentPage.getText, respectively.


Name of the class making the request. For instance, this will be "DocumentFactory" for DocumentFactory.loadFromUri, "Document" for LEADDocument.Convert and "DocumentPage" for DocumentPage.getText.


Name of the method making the request. For instance, this will be "loadFromUri" for DocumentFactory.loadFromUri, "convert" for LEADDocument.Convert and "getText" for DocumentPage.getText.

Cancel Can be set to true by the event handler to cause the request to fail immediately.

An object of type JQueryAjaxSettings Object, which in turn holds the headers, method, url, and other request properties. The data property of JQueryAjaxSettings will be a JSON-stringified object (a string) for POST requests, and an object for GET requests.

Any changes made to that object will be used in the request. This will allow a user to modify the headers of any request to set authorization headers as they wish for instance.

The following shows how to use PrepareAjax to intercept calls to LoadFromUri and adding custom authentication headers that will be parsed by the server.

Client side JavaScript code:

// Our interceptor function 
var myPrepareAjaxHandler = function (sender, args) { 
// Check if this is the method we are interested in 
if (args.sourceClass != "DocumentFactory" || args.sourceMethod != "loadFromUri") { 
// No 
// Yes, add to the headers. If headers do not exist, initialize first 
if (!args.settings.headers) { 
args.settings.headers = {}; 
args.settings.headers["my_custom_auth_header_key"] = "my_custom_auth_header_val"; 
// Add our handler to the static PrepareAjax event 
// Now call loadFromUri and we should be able to intercept and add our custom headers 
lt.DocumentFactory.loadFromUri(uri, options); 

Server side .NET code:

// An Example Of Getting Headers, this could be in FactoryController.cs 
public LoadFromUriResponse LoadFromUri(LoadFromUriRequest request) 
var headers = Request.Headers; 
if (headers.Contains("my_custom_auth_header_key")) 
var values = headers.GetValues("my_custom_auth_header_key"); 
if (values.Contains("my_custom_auth_header_val")) 
// Success, do something ... 
// rest of code 

If the handler aborts the request by setting the value of Cancel to true, then the request will fail immediately and the method will invoke the fail promise. ParseError can be used to obtain extra information on the error and in this situation, the value of IsCancelError will be true.

Event Data
sendervarThe source of the event.
e PrepareAjaxEventArgsThe event data.

Refer to Promises in the Documents Service Library and Documents Application for more information.


Target Platforms

Help Version 20.0.2018.8.29
Products | Support | Contact Us | Copyright Notices
© 1991-2018 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Document Assembly