Class TCustomPropSave

Unit

Declaration

type TCustomPropSave = class(TComponent)

Description

Basic component which provides all functions for re/storing of properties; all PropSave components must be inherited from TCustomPropSave

Hierarchy

  • TComponent
  • TCustomPropSave

Overview

Methods

Public function GetKey(Comp: TComponent): string;
Public function CanSave(Comp: TComponent): boolean; virtual; abstract;
Public procedure ProcComps(psAction: TPropSaveAction);
Public procedure ProcComp(psAction: TPropSaveAction; Comp: TComponent; ProcChild: boolean);
Public function PropsIsStored(Comp: TComponent): boolean;

Properties

Public property DisableComponents: TList read FDisableComponents;
Published property PropSaveMain: TPropSaveMain read FPropSaveMain write FPropSaveMain;
Published property Disable: boolean read FDisable write FDisable default false;
Published property Components: TStrings read FComponents write SetComponents;
Published property OnGetKeyString: TOnGetKeyString read FOnGetKeyString write FOnGetKeyString;
Published property OnProcComponents: TOnProcComponents read FOnProcComponents write FOnProcComponents;

Description

Methods

Public function GetKey(Comp: TComponent): string;

returns key string for component

Public function CanSave(Comp: TComponent): boolean; virtual; abstract;

indicates whether re/storing of Components from parameter is supported by descendant of TCustomPropSave, must be overridden for all descendand

Public procedure ProcComps(psAction: TPropSaveAction);

called by MainPropSave in order to proceed re/storing properties of all components in "Componets" property

Public procedure ProcComp(psAction: TPropSaveAction; Comp: TComponent; ProcChild: boolean);

called by ProcComps in order to proceed re/storing properties of one particular component

Public function PropsIsStored(Comp: TComponent): boolean;

indicates whether some data exists for component in ini file

Properties

Public property DisableComponents: TList read FDisableComponents;

list of component names which is excluded from re/storing and stored values is deleted

Published property PropSaveMain: TPropSaveMain read FPropSaveMain write FPropSaveMain;

link to TPropSaveMain which maintain re/storing on form level

Published property Disable: boolean read FDisable write FDisable default false;

defines whether re/storing function of this CustomPropSave is disabled

Published property Components: TStrings read FComponents write SetComponents;

defines names of components which is re/stored, for re/storing of all children components use asterisk convention, ie. "Form1.*" means that all components on form "Form1" is re/stored; can be easily set by design time dialog (see RosiDBDesignEditors package)

Published property OnGetKeyString: TOnGetKeyString read FOnGetKeyString write FOnGetKeyString;

event called for each component, can be used to redefine KeyString by user

Published property OnProcComponents: TOnProcComponents read FOnProcComponents write FOnProcComponents;

event called by ProcComps to allow storing of any custom defined component


Generated by PasDoc 0.15.0.