Class TPropSaveMain

Unit

Declaration

type TPropSaveMain = class(TComponent)

Description

Main component which provides hook functions and re/stores standard components. It also finds all TCustomPropSave descendants on the form linked to PropSaveMain and call TCustomPropSave.ReadSaveProps procedure to re/store properties of other controls

Hierarchy

  • TComponent
  • TPropSaveMain

Overview

Fields

Public IsMaximized: boolean;

Methods

Public procedure SetParent(AParent: TComponent; UseFormEvent: boolean = false);
Public function GetFormKey: string;
Public procedure SaveProperties;
Public procedure ReadProperties;
Public procedure DeleteProperties;
Public function FormIsSaved: boolean;

Properties

Published property FormKey: string read FFormKey write FFormKey;
Published property PropSaveFile: TPropSaveFile read FPropSaveFile write SetPropSaveFile;
Published property FormSavePos: boolean read FFormSavePos write FFormSavePos default true;
Published property FormLimitToScreen: boolean read FFormLimitToScreen write FFormLimitToScreen default true;
Published property CtrlPosition: TPositionPropSave read FCtrlPosition;
Published property StdCtrl: TStdCtrlPropSave read FStdCtrl;
Published property PropSaveEvents: TPropSaveEvents read FPropSaveEvents write FPropSaveEvents default pseFormCreateDestroy;
Published property OnSaveProperties: TOnReadSaveProp read FOnSaveProperties write FOnSaveProperties;
Published property OnReadProperties: TOnReadSaveProp read FOnReadProperties write FOnReadProperties;

Description

Fields

Public IsMaximized: boolean;

indicates whether form was stored in maximized state

Methods

Public procedure SetParent(AParent: TComponent; UseFormEvent: boolean = false);

define parent component (Form or Frame), needed only in special cases

Public function GetFormKey: string;

returns key string for active form

Public procedure SaveProperties;

saves all properties on app request

Public procedure ReadProperties;

reads all properties on app request

Public procedure DeleteProperties;

delete all properties on app request

Public function FormIsSaved: boolean;

indicates whether form was already stored

Properties

Published property FormKey: string read FFormKey write FFormKey;

key string for the form, if empty Owner form name is used

Published property PropSaveFile: TPropSaveFile read FPropSaveFile write SetPropSaveFile;

link to TPropSaveFile, usually app use only one PropSaveFile for all forms

Published property FormSavePos: boolean read FFormSavePos write FFormSavePos default true;

defines whether form position is re/stored

Published property FormLimitToScreen: boolean read FFormLimitToScreen write FFormLimitToScreen default true;

defines whether form position is limited to screen after restoring, ie. when screen resolution was changed

Published property CtrlPosition: TPositionPropSave read FCtrlPosition;

PositionPropSave subcomponent, see detail for TPositionPropSave

Published property StdCtrl: TStdCtrlPropSave read FStdCtrl;

StdCtrlPropSave subcomponent, see detail for TStdCtrlPropSave

Published property PropSaveEvents: TPropSaveEvents read FPropSaveEvents write FPropSaveEvents default pseFormCreateDestroy;

defines form events, when re/storing of properties is done, if pseNone is set then procedure SaveProperties and ReadProperties has to be called by code

Published property OnSaveProperties: TOnReadSaveProp read FOnSaveProperties write FOnSaveProperties;

called after standard storing and could be used for storing of user defined properties

Published property OnReadProperties: TOnReadSaveProp read FOnReadProperties write FOnReadProperties;

called after standard restoring and could be used for restoring of user defined properties


Generated by PasDoc 0.15.0.