viewportImage Property


The total composite image data to print when PrintDocumentOptions.UseViewportLayout is true.


JavaScript Syntax
Object.defineProperty(DocumentPrintData.prototype, 'viewportImage', 
	get: function(), 
	set: function(value) 
TypeScript Syntax
viewportImage: HTMLImageElement; 

Property Value

An HTMLImageElement containing all the image data for the printed pages from the viewport.


ViewportImage is set automatically when DocumentViewer.Print completes and BuildPrintRoot is called. BuildPrintRoot calls BuildViewportImage if PrintDocumentOptions.UseViewportLayout is true, creating a single HTMLImageElement composed from the image data of each page's image data.

If PrintDocumentOptions.ViewportClip is used, ViewportImage will contain a "screenshot" of the viewport with the outside image data from each page clipped out appropriately.

ViewportSize will be set to the ImageViewer.ControlSize to indicate the viewport being used.

For more information, refer to DocumentViewer.Print.


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