DocumentPrintPageAction Enumeration

Summary

An enumeration to determine the preparation actions to take when printing.

Syntax

JavaScript Syntax

lt.Documents.UI.DocumentPrintPageAction = { 
	Auto: 0, 
	Remove: 1, 
	Manual: 2 
}

TypeScript Syntax

lt.Documents.UI.DocumentPrintPageAction = { 
	Auto: 0, 
	Remove: 1, 
	Manual: 2 
}

Members

0	Auto	Default. Indicates that DocumentViewer.Print should load the page for printing through the service or through PDF Client Rendering (see PrintDocumentOptions.UsePDFClientRendering).
1	Remove	Indicates that DocumentViewer.Print should not load the page and should ignore it when printing. When assembling the printing structure in DocumentPrintData.BuildPrintRoot, the page will be ignored and not added to the HTML structure.
2	Manual	Indicates that the user will be responsible for providing the content of the page for printing. DocumentViewer.Print does not attempt to load the page data like in `Auto`. This page data will still be assembled into the DocumentPrintData.Root when DocumentPrintData.BuildPrintRoot is called, though if the DocumentPrintPageData.PageElement is null, it acts like `Remove`.

Remarks

When printing, updates are sent on the progress of DocumentViewer.Print through DocumentViewer.Operation with DocumentViewerOperation.PrintPages. When DocumentViewerOperationEventArgs.IsPostOperation is false (indicating the page is about to be prepared), DocumentPrintPageData.Action is used to determine what DocumentViewer.Print should do to prepare the page.

For more information, see DocumentViewer.Print.

History

Requirements

Help Version 19.0.2017.10.27