Sign in Join
FPDoc Onlineexperiment

TIniPropStorage class

In unit IniPropStorage

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

Declaration

pascal
TIniPropStorage = class(TCustomIniPropStorage)

Inheritance

  1. TIniPropStorage
  2. TCustomIniPropStorage
  3. TFormPropertyStorage
  4. TControlPropertyStorage
  5. TCustomPropertyStorage
  6. TComponent
  7. TPersistent
  8. 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

Properties

StoredValuespublishedCollection with the names and values for properties handled for the container.
IniFileNamepublishedName of the INI file where the session properties are saved in INI format.
IniSectionpublishedName of the section in the INI file where values for session properties are stored.
ActivepublishedIndicates whether the container is Active and allows access to its storage.

Events

OnSavingPropertiespublishedEvent handler signalled when the Save method is started.
OnSavePropertiespublishedEvent handler signalled when the Save method is completed.
OnRestoringPropertiespublishedEvent handler signalled when the Restore method is started.
OnRestorePropertiespublishedEvent handler signalled when the Restore method is completed.

Inherited

From TCustomIniPropStorage (9)

DoEraseSections DoReadString DoWriteString FreeStorage GetIniFileName IniFile IniFileClass RootSection StorageNeeded

From TFormPropertyStorage (2)

Create Destroy

From TControlPropertyStorage (1)

GetPropertyList

From TCustomPropertyStorage (22)

DoReadInteger DoWriteInteger EraseSections FinishPropertyList GetRoot OnSaveException ReadBoolean ReadInteger ReadRect ReadString ReadStrings Restore RestoreProperties Root Save SaveProperties StoredValue WriteBoolean WriteInteger WriteRect WriteString WriteStrings

From TComponent (74)

_AddRef _Release BeforeDestruction CanObserve ChangeName ComObject ComponentCount ComponentIndex Components ComponentState ComponentStyle DefineProperties DesignInfo DestroyComponents Destroying ExecuteAction FindComponent FreeNotification FreeOnRelease GetChildOwner GetChildParent GetChildren GetDeltaStreams GetEnumerator GetIDsOfNames GetNamePath GetObservers GetOwner GetParentComponent GetTypeInfo GetTypeInfoCount HasParent iicrGetComponent InsertComponent Invoke IsImplementorOf Loaded Loading Name Notification ObserverAdded Observers OnGetDeltaStreams Owner PaletteCreated QueryInterface ReadDeltaState ReadDeltaStream ReadState ReferenceInterface RemoveComponent RemoveFreeNotification RemoveFreeNotifications SafeCallException SetAncestor SetChildOrder SetDesigning SetDesignInstance SetInline SetName SetParentComponent SetSubComponent Tag ToString TToStringNameMode UpdateAction Updated UpdateRegistry Updating ValidateContainer ValidateInsert ValidateRename VCLComObject WriteState

From TPersistent (5)

Assign AssignTo FPOAttachObserver FPODetachObserver FPONotifyObservers

From TObject (37)

AfterConstruction CheckDisposed ClassInfo ClassName ClassNameIs ClassParent ClassType CleanupInstance DefaultHandler DefaultHandlerStr Dispatch DispatchStr Disposed DisposeOf Equals FieldAddress Free FreeInstance GetDisposed GetHashCode GetInterface GetInterfaceByStr GetInterfaceEntry GetInterfaceEntryByStr GetInterfaceTable GetInterfaceWeak GetLastCastErrorInfo InheritsFrom InitInstance InstanceSize MethodAddress MethodName newinstance QualifiedClassName StringMessageTable SystemHasExtendedRTTI UnitName

An experiment, built from development snapshots. Not the official Free Pascal or Lazarus documentation.