SftDirectory.RegistryLocation Property
Defines the Registry location used to load and save layout information.
Syntax
Get
| VB.NET | RegistryPath = object.RegistryLocation As String |
| VB | RegistryPath = object.RegistryLocation As String |
| C#.NET | string RegistryPath = object.RegistryLocation; |
| VC++ | _bstr_t RegistryPath = object->RegistryLocation;
_bstr_t RegistryPath = object->GetRegistryLocation(); |
| C | HRESULT object->get_RegistryLocation(BSTR* RegistryPath); |
Put
| VB.NET | object.RegistryLocation = RegistryPath As String |
| VB | object.RegistryLocation = RegistryPath As String |
| C#.NET | string object.RegistryLocation = RegistryPath; |
| VC++ | _bstr_t object->RegistryLocation = RegistryPath;
void object->PutRegistryLocation(_bstr_t RegistryPath); |
| C | HRESULT object->put_RegistryLocation(BSTR RegistryPath); |
object
A SftDirectory object.
RegistryPath
Defines the Registry path where the column layout and control information is located (see below).
Comments
The RegistryLocation property defines the Registry location used to load and save layout information.
The RegistryLocation property must be set at design-time to take effect.
If the RegistryLocation property and optionally the RegistryEntry property define a valid Registry entry, all relevant run-time, user-accessible customizations, such as column widths and sort order, are automatically preserved by the control. The LoadLayout and SaveLayout methods can be used to preserve this information under application control instead.
RegistryPath must start with the prefix "USR:" or "MACH:", followed by the remainder of the Registry key. USR: is equivalent to current user settings (HKEY_CURRENT_USER), MACH: is used for system settings (HKEY_LOCAL_MACHINE). No other prefix is allowed.
For example, a RegistryLocation of "USR:Software\Softelvdm\Samples\Test" and RegistryEntry "Layout" would store all control customizations in the Registry entry HKEY_CURRENT_USER\Softelvdm\Samples\Test\Layout.
The column widths, dropdown width and height for combo box style controls, sort column and sort direction are loaded. The AutoSizeColumns property may prevent the loaded column widths from taking effect.
See Also SftDirectory Object | Object Hierarchy
On
Off