isUsingPDFRendering Property


Indicate that Client-side PDF rendering is being used by this document viewer instance.


JavaScript Syntax
Object.defineProperty(DocumentViewer.prototype, 'isUsingPDFRendering', 
	get: function() 
TypeScript Syntax
isUsingPDFRendering: boolean; // read-only 

Property Value

true if Client-side PDF rendering is being used by this document viewer instance; otherwise, false.


IsUsingPDFRendering will be true when all of the following conditions are met:

  • IsPDFRenderingSupported is true indicating that the support javascript and resource files are setup correctly

  • The value of UsePDFRendering is true (the default value) indicating that Client-side PDF rendering is to be used when applicable

  • The Document object being viewed is PDF or contains any child documents that are PDF (the value of Document.MimeType is application/pdf).

When all the conditions are met, the document viewer will create an instance of the internal PDF client-side renderer for each PDF document and use them to render the pages of PDF documents on the surface of the view and thumbnail parts on demand and as needed.

Note that when document or child documents are removed, the document viewer will delete the internal PDF client-side renderer to save system resources and try to re-create it (if applicable) the next time a document is set or child documents are added.

The internal PDF client-side renderer object instance for a document can be obtained through the GetPDFRenderingObject property.

Additionally, if IsUsingPDFRendering is true, UsePDFText can be set to true to retrieve text data directly from the rendered PDF instead of requesting the data from a service.


Target Platforms

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

Leadtools.Documents.UI Assembly