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

# TIniPropStorage

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

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

## Declaration

Source position: inipropstorage.pas line 53

`type TIniPropStorage = class(TCustomIniPropStorage)`
`published`
`property StoredValues: TStoredValues;` |  | Collection with the names and values for properties handled for the container.
`property IniFileName: string;` |  | Name of the INI file where the session properties are saved in INI format.
`property IniSection: string;` |  | Name of the section in the INI file where values for session properties are stored.
`property Active: Boolean;` |  | Indicates whether the container is Active and allows access to its storage.
`property OnSavingProperties: TNotifyEvent;` |  | Event handler signalled when the Save method is started.
`property OnSaveProperties: TNotifyEvent;` |  | Event handler signalled when the Save method is completed.
`property OnRestoringProperties: TNotifyEvent;` |  | Event handler signalled when the Restore method is started.
`property OnRestoreProperties: TNotifyEvent;` |  | Event handler signalled when the Restore method is completed.
`end;`

## Inheritance

`TIniPropStorage` |  | Implements a class used to store session properties in an INI file.
`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`
?
`TObject`

## Description

TIniPropStorage is a TCustomIniPropStorage descendant which implements the class used to store form session properties to a file using the INI format. It sets the visibility for properties and methods introduced in ancestor classes.

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 are stored at the root section 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

TForm.SessionProperties |  | Implements a form used in an LCL application.
TJSONPropStorage |  | Implements the final class for the JSON Form Session Properties storage.
TXMLPropStorage |  | Implements a class for XML storage of Form Session properties.