TcxLockedStateImageOptions Class
The base class for all classes that implement appearance settings for a “Locked View” image.
Declaration
TcxLockedStateImageOptions = class(
TPersistent
)Remarks
You can display a “Locked View” image instead of a control’s actual content during time-consuming operations that block the control’s UI interactions, such as saving or loading large amounts of data in the main application thread. The “Locked View” is an image that shows the control’s state at the moment when the time-consuming operation is initiated. Optionally, you can apply a darkening or lightening effect to the image and show a message within a centered box on top of the image:
The TcxLockedStateImageOptions class provides the following members that allow you to:
Disable or enable the “Locked View” image (Enabled);
Apply an available visual effect to the “Locked View” image (Effect);
Specify which message box appearance settings override the corresponding control‘s settings (AssignedValues);
Show or hide the centered message box on top of the “Locked View” image (ShowText);
Apply a custom color to the message box’s background (Color);
Customize the message box text and its font settings (Text and Font);
Copy compatible settings between different “Locked View” image option sets (Assign).
TcxLockedStateImageOptions is the base class for all classes that store “Locked View” image settings that the following DevExpress controls use:
The TcxGrid control whose LockedStateImageOptions property references a TcxGridLockedStateImageOptions object;
The TcxPivotGrid and TcxDBPivotGrid controls whose OptionsLockedStateImage property references a TcxPivotGridOptionsLockedStateImage object;
The TdxPDFViewer control whose OptionsLockedStateImage property references a TdxPDFViewerLockedStateImageOptions object;
The TdxSpreadSheet and TdxSpreadSheetReportDesigner controls whose OptionsLockedStateImage property references a TdxSpreadSheetLockedStateImageOptions object.