viewportImage Property

Summary

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

Syntax

JavaScript Syntax

Object.defineProperty(DocumentPrintData.prototype, 'viewportImage', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

viewportImage: HTMLImageElement;

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

Remarks

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.

History

Requirements

Help Version 19.0.2017.10.27