Table of Contents

TTMSFNCCustomComponent Class

Invisible non-visual component base class with persistence, style adaptation, and DPI-scaling support.

API unit family: TMSFNCCustomComponent Inherits from: TCustomControl Implements: ITMSFNCProductInfo, ITMSFNCPersistence

Syntax

TTMSFNCCustomComponent = class(TCustomControl, ITMSFNCProductInfo, ITMSFNCPersistence)

Properties

Name Description
BlockPersistenceInterface When True, the persistence interface is globally disabled and no properties are saved or loaded.
DesigntimeFormPixelsPerInch The pixels-per-inch value of the form in the IDE at design time, used to correctly scale DFM coordinates at runtime.
Stored When True, the component participates in persistence operations; when False, it is skipped.

Methods

Name Description
BeginUpdate Suspends update processing for the FMX compatibility implementation until EndUpdate is called.
EndUpdate Resumes update processing for the FMX compatibility implementation after a matching BeginUpdate call.
IsDesignTime Returns True when the component is running at design time in the IDE form designer.
IsDesigning Returns True when the component's csDesigning flag is set.
IsDestroying Returns True when the component is being destroyed (csDestroying flag).
IsLoading Returns True while the component's streaming state is csLoading, i.e. during DFM loading.
IsReading Returns True while the component is in the csReading streaming state.
LoadSettingsFromFile Restores the component's published settings from a previously saved file.
LoadSettingsFromStream Restores the component's published settings from a stream.
SaveSettingsToFile Saves the component's published settings to a file.
SaveSettingsToStream Saves the component's published settings to a stream.

Events

Name Description
OnCanLoadProperty Fired before a property is loaded to check whether it should be applied. Set ACanLoad to False to skip the property.
OnCanSaveProperty Fired before a property is saved to check whether it should be included. Set ACanSave to False to skip the property.