Skip to main content

DevExpress v24.2 Update — Your Feedback Matters

Our What's New in v24.2 webpage includes product-specific surveys. Your response to our survey questions will help us measure product satisfaction for features released in this major update and help us refine our plans for our next major release.

Take the survey Not interested

TdxSpreadSheetPrepareLockedStateImageEvent Type

The “Locked View” image draw event type used by the Spreadsheet and Report Designer controls.

#Declaration

Delphi
TdxSpreadSheetPrepareLockedStateImageEvent = procedure(Sender: TdxCustomSpreadSheet; AImage: TcxBitmap32; var ADone: Boolean) of object;

#Parameters

Name Type
Sender TdxCustomSpreadSheet
AImage TcxBitmap32
ADone Boolean

#Remarks

Use the Sender parameter to refer to the control that raised the OnPrepareLockedStateImage event. To access the control’s type-specific properties, cast the parameter to the TdxSpreadSheet or TdxSpreadSheetReportDesigner class.

The AImage parameter provides access to the bitmap image displayed on top of the worksheet in the locked state. By default, this image depicts the currently active worksheet at the moment of locking.

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

The Spreadsheet/Report Designer control’s OnPrepareLockedStateImage event references the TdxSpreadSheetPrepareLockedStateImageEvent type.

See Also