requestDocumentInfo Method

In This Topic

Sends an asynchronous request for getting information about this PDF document.

Syntax

var instance = new Vintasoft.Imaging.Pdf.WebPdfDocumentJS(id, service, pdfDocumentEditorControl);

var value; // Type: any

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

value = instance.requestDocumentInfo(successFunc, errorFunc);

function requestDocumentInfo(
   successFuncFunction that will be executed if request is executed successfully. Here is function prototype "function __success(data)".
 The data parameter has the following properties:
  id (string): an identifier of PDF document.
 documentInfo (object): information about PDF document. Document information object has the following properties:
  author (string): the name of the person who created the document.
 creationDate (string): the date and time the document was created.
 creator (string): the document creator.
 keywords (string): keywords associated with the document.
 modifyDate (string): the date and time the document was most recently modified.
 producer (string): the document producer.
 subject (string): the subject of the document.
 title (string): the title of the document.
 encryptionSystem (string): an information about encryption system.
 pageCount (number): the number of pages contained in the document.
 
 
 
 : 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:

id (string): an identifier of PDF document.
documentInfo (object): information about PDF document. Document information object has the following properties:
- author (string): the name of the person who created the document.
- creationDate (string): the date and time the document was created.
- creator (string): the document creator.
- keywords (string): keywords associated with the document.
- modifyDate (string): the date and time the document was most recently modified.
- producer (string): the document producer.
- subject (string): the subject of the document.
- title (string): the title of the document.
- encryptionSystem (string): an information about encryption system.
- pageCount (number): the number of pages contained in the document.

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

WebPdfDocumentJS Class
WebPdfDocumentJS Members

Send Feedback