TCustomPropertyStorage.RootSection function

Declaration

function RootSection: string; virtual

Function result

The Name or ClassName prefix for the Owner component, or an empty string when Root is not assigned.

Description

RootSection is a String function which builds the path in the storage container where the property values are located.

RootSection uses the value in the Root property to determine the return value for the method. When Root is assigned and derived from TComponent, its Name or ClassName property is prepended to the return value. Preference is given to the value in its Name property.

Preceding Owner components are also examined and prepended to the return value. The value is complete when an Owner does not exist, or is not derived from TComponent.

The return value represents the component hierarchy used to access the property values in the storage container. The value is used in the SaveProperties and RestoreProperties methods to load property values from the underlying storage mechanism.