Sign in Join
FPDoc Onlineexperiment

TCustomIniPropStorage class

In unit IniPropStorage

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

Declaration

pascal
TCustomIniPropStorage = class(TFormPropertyStorage)

Inheritance

  1. TCustomIniPropStorage
  2. TFormPropertyStorage
  3. TControlPropertyStorage
  4. TCustomPropertyStorage
  5. TComponent
  6. TPersistent
  7. TObject

Descends from it: TIniPropStorage

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

Properties

IniFileprotectedProvides access to the TCustomIniFile instance for the class.
IniFileNamepublicName of the INI file where the session properties are saved in INI format.
IniSectionpublicName of the section in the INI file where values for session properties are stored.

Methods

IniFileClassprotectedReturns the TIniFile class type.
GetIniFileNameprotectedGets the value for the IniFileName property.
RootSectionprotectedReturns the name of the INI section where values are stored.
StorageNeededpublicCreates or recreates the underlying INI file storage for the class instance.
FreeStoragepublicFrees the underlying INI file storage object for the class instance.
DoReadStringpublicPerforms actions needed to reading the specified value from the INI storage as a string type.
DoWriteStringpublicPerforms actions needed to write the specified value to the INI storage using a string type.
DoEraseSectionspublicPerforms actions needed to remove the section section and its subsections from the underlying INI storage.

Inherited

From TFormPropertyStorage (2)

Create Destroy

From TControlPropertyStorage (1)

GetPropertyList

From TCustomPropertyStorage (28)

Active DoReadInteger DoWriteInteger EraseSections FinishPropertyList GetRoot OnRestoreProperties OnRestoringProperties OnSaveException OnSaveProperties OnSavingProperties ReadBoolean ReadInteger ReadRect ReadString ReadStrings Restore RestoreProperties Root Save SaveProperties StoredValue StoredValues 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.