[Overview][Types][Classes][Procedures and functions][Index] Reference for unit 'IniPropStorage' (#lcl)

TCustomIniPropStorage

[Properties (by Name)] [Methods (by Name)] [Events (by Name)]

Implements the base class for storage of form session properties in an INI file.

Declaration

Source position: inipropstorage.pas line 28

type TCustomIniPropStorage = class(TFormPropertyStorage)

protected

  function IniFileClass; virtual;

  

Returns the TIniFile class type.

  function GetIniFileName; virtual;

  

Gets the value for the IniFileName property.

  function RootSection; override;

  

Returns the name of the INI section where values are stored.

  property IniFile: TCustomIniFile; [r]

  

Provides access to the TCustomIniFile instance for the class.

public

  procedure StorageNeeded(); override;

  

Creates or recreates the underlying INI file storage for the class instance.

  procedure FreeStorage; override;

  

Frees the underlying INI file storage object for the class instance.

  function DoReadString(); override;

  

Performs actions needed to reading the specified value from the INI storage as a string type.

  procedure DoWriteString(); override;

  

Performs actions needed to write the specified value to the INI storage using a string type.

  procedure DoEraseSections(); override;

  

Performs actions needed to remove the section section and its subsections from the underlying INI storage.

  property IniFileName: string; [rw]

  

Name of the INI file where the session properties are saved in INI format.

  property IniSection: string; [rw]

  

Name of the section in the INI file where values for session properties are stored.

end;

Inheritance

TCustomIniPropStorage

  

Implements the base class for storage of form session properties in an INI file.

|

TFormPropertyStorage

  

TFormPropertyStorage - class for storage of a Form's properties.

|

TControlPropertyStorage

  

Implements the abstract ancestor class used to get the property list for a control.

|

TCustomPropertyStorage

  

Defines a container used to Save and Restore property values.

|

TComponent,IUnknown,IInterfaceComponentReference

|

TPersistent,IFPObserved

|

TObject

Description

TCustomIniPropStorage is a TFormPropertyStorage descendant which defines a class used to store form session properties to a file using the INI format. It introduces properties and methods needed to access the INI file used as the storage mechanism for the class.

Use the SessionPropperties property in the TForm or a TFrame instance which owns the class to define the components and property names stored using the storage mechanism.

Use IniFileName to specify the path and file name where session properties are stored in IniFile.

Use IniSection to specify the name for a section where session properties are stored. When omitted, session properties stored at the root level in IniFile.

Use Active to enable or disable read/write access to the INI file storage for the class instance.

Use the event handlers in the class to perform actions needed before or during save and restore operations using the session properties.

See also

TIniPropStorage

  

Implements a class used to store session properties in an INI file.

TForm.SessionProperties

  

Implements a form used in an LCL application.

TFormPropertyStorage

  

TFormPropertyStorage - class for storage of a Form's properties.

TJSONPropStorage

  

Implements the final class for the JSON Form Session Properties storage.

TXMLPropStorage

  

Implements a class for XML storage of Form Session properties.


Version 3.2 Generated 2024-02-25 Home