|
RegistrySettingsBase(String, String, Boolean, Boolean, Boolean) Constructor
|
Creates a new instance of the
RegistrySettingsBase class for the application's registry based settings.
Namespace: GSF.ConfigurationAssembly: GSF.Core (in GSF.Core.dll) Version: 2.4.207-beta+1781b796b2aa7a54013a031eb432fe4ccee31867
Syntax protected RegistrySettingsBase(
string rootPath,
string keyName,
bool useCategoryAttributes,
bool requireSerializeSettingAttribute,
bool initialize
)
protected:
RegistrySettingsBase(
String^ rootPath,
String^ keyName,
bool useCategoryAttributes,
bool requireSerializeSettingAttribute,
bool initialize
)
new :
rootPath : string *
keyName : string *
useCategoryAttributes : bool *
requireSerializeSettingAttribute : bool *
initialize : bool -> RegistrySettingsBase
GSF.Configuration.RegistrySettingsBase = function(rootPath, keyName, useCategoryAttributes, requireSerializeSettingAttribute, initialize);
View SourceParameters
- rootPath String
- Defines the root registry path used to access settings in the registry (e.g., "HKEY_CURRENT_USER\\Software\\My Company\\My Product\\").
- keyName String
- Defines the name of default key used to access settings in the registry (e.g., "General Settings").
- useCategoryAttributes Boolean
- Determines if category attributes will be used for the registry key names.
- requireSerializeSettingAttribute Boolean
-
Assigns flag that determines if SerializeSettingAttribute is required
to exist before a field or property is serialized to the registry.
- initialize Boolean
- Determines if Initialize method should be called from constructor.
Remarks
If useCategoryAttributes is false, all settings will be placed in section labeled by the
keyName value; otherwise, if a CategoryAttribute exists on a field or
property then the member value will serialized into the registry in a section labeled the same
as the Category value and if the attribute doesn't exist the member value
will serialized into the section labeled by the keyName value.
Note that some .NET languages (e.g., Visual Basic) will not initialize member elements before call to constuctor,
in this case initialize should be set to false, then the Initialize
method should be called manually after all properties have been initialized. Alternately, consider using the
DefaultValueAttribute on the fields or properties and this will be used to initialize the values.
See Also