relativeClip Property

Summary

The portion of the printed page image data that will be rendered when PrintDocumentOptions.ViewportClip is not LeadRectD.Empty.

Syntax

JavaScript Syntax

Object.defineProperty(DocumentPrintPageData.prototype, 'relativeClip', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

relativeClip: LeadRectD;

A LeadRectD representing the percentage of the ImageViewerItem's bounds that will be rendered for printing, or LeadRectD.Empty if PrintDocumentOptions.ViewportClip is LeadRectD.Empty.

Remarks

RelativeClip is computed at the beginning of DocumentViewer.Print based on the ImageViewerItem for each DocumentPage and the PrintDocumentOptions.ViewportClip value. Each property value is a number between 0 and 1, indicating a percentage.

The RelativeClip is applied after each page's image data is rendered (either by retrieving the image from a service or using PrintDocumentOptions.usePDFClientRendering) to clip out the appropriate areas. This achieves the overall "screenshot" effect from PrintDocumentOptions.ViewportClip and PrintDocumentOptions.UseViewportLayout.

For more information, refer to DocumentViewer.Print.

History

Requirements

Help Version 19.0.2017.10.27