In This Topic ▼

buildViewportImage Method

Summary

Creates a new HTMLElement as the Root and appends the Pages data.

Syntax

TypeScript

JavaScript

DocumentPrintData.prototype.buildViewportImage = function()

buildViewportImage(): void;

Remarks

BuildViewportImage is only called when PrintDocumentOptions.UseViewportLayout is true. In this case, a single HTMLImageElment needs to be created that is a composition of all the printing image data with rotations and relative positioning via [BoundsInViewport]. If PrintDocumentOptions.ViewportClip is also used, the result ViewportImage will have the appropriate image data clipped out using [RelativeClip]. BuildViewportImage is called from BuildPrintRoot.

If the DocumentPrintPageData.Action for a page specifies DocumentPrintPageAction.Remove, then the page is ignored and not drawn into the ViewportImage. The page image data will also not be added if the DocumentPrintPageData.PageElement is null.

If the user sets PrintDocumentOptions.AutoOpenBrowserPrint to false in order to change the pages data, the user will need to call BuildPrintRoot themselves to create the Root and ViewportImage to be printed.

For more information, refer to DocumentViewer.Print.

History

Requirements

Help Version 20.0.2020.4.3