TdxPDFViewerPrepareLockedStateImageEvent Type

The PDF Viewer control’s “Locked View” draw event type.

Declaration

delphi

TdxPDFViewerPrepareLockedStateImageEvent = procedure(Sender: TdxPDFCustomViewer; AImage: TcxBitmap32; var ADone: Boolean) of object;

Parameters

Name	Type
Sender	TdxPDFCustomViewer
AImage	TcxBitmap32
ADone	Boolean

Remarks

Use the Sender parameter to refer to the PDF Viewer control that raised the OnPrepareLockedStateImage event. To access the control’s type-specific properties, cast the parameter to the TdxPDFViewer class.

The AImage parameter provides access to the bitmap image displayed on top of the control while a document is being loaded. By default, this image depicts an empty PDF Viewer control.

To disable the default “Locked View” draw routines, set the ADone parameter to True within your event handler.

The PDF Viewer control’s OnPrepareLockedStateImage event references the TdxPDFViewerPrepareLockedStateImageEvent type.