PtrDevice:QuitPreview() Method

<< Click to Display Table of Contents >>

Navigation:  RpPrinter & PtrDevice Class Overview > PtrDevice Class >

PtrDevice:QuitPreview() Method

Previous pageReturn to chapter overviewNext page

Purpose

To instruct the PtrDevice to terminate the preview operation.

Syntax

<oPtrDevice>:QuitPreview([lPrint]) lSuccess                (LOGIC)

Arguments

lPrint

 Optional parameter which if TRUE instructs the PtrDevice to start the printing process after the preview is terminated.

Description

This method is used primarily when the preview window is displayed modeless and you wish to terminate the preview process under program control.  If the PtrDevice can terminate the preview process it returns TRUE, otherwise, it returns FALSE.  The PtrDevice may not be able to terminate the preview process if it is executing a callback method.  In this case, it will set oPtrDevice:Quit to TRUE instructing the callback function to immediately return.

Example

// terminate the print preview process

oPtrDevice:QuitPreview()