CategorizedSettingsBaseTCategorizedSettings Class

Represents the base class for application settings that are synchronized with a categorized section in a configuration file and will perform bi-directional synchronization of elements marked with TypeConvertedValueExpressionAttribute to an external source, e.g., user interface elements.

Inheritance Hierarchy

SystemObject
  GSF.ConfigurationSettingsBase
    GSF.ConfigurationCategorizedSettingsBase
      GSF.ConfigurationCategorizedSettingsBaseTypeConvertedValueExpressionAttribute, TCategorizedSettings
        GSF.ConfigurationCategorizedSettingsBaseTCategorizedSettings

Namespace: GSF.Configuration
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.257-beta+00aa2366fbb9ec75f636ebc7cfa610e3826a727c

Syntax

C++

JavaScript

Copy

public abstract class CategorizedSettingsBase<TCategorizedSettings> : CategorizedSettingsBase<TypeConvertedValueExpressionAttribute, TCategorizedSettings>
where TCategorizedSettings : CategorizedSettingsBase

Public MustInherit Class CategorizedSettingsBase(Of TCategorizedSettings As CategorizedSettingsBase)
	Inherits CategorizedSettingsBase(Of TypeConvertedValueExpressionAttribute, TCategorizedSettings)

generic<typename TCategorizedSettings>
where TCategorizedSettings : CategorizedSettingsBase
public ref class CategorizedSettingsBase abstract : public CategorizedSettingsBase<TypeConvertedValueExpressionAttribute^, TCategorizedSettings>

[<AbstractClassAttribute>]
type CategorizedSettingsBase<'TCategorizedSettings when 'TCategorizedSettings : CategorizedSettingsBase> = 
    class
        inherit CategorizedSettingsBase<TypeConvertedValueExpressionAttribute, 'TCategorizedSettings>
    end

JavaScript does not support generic types or methods.

View Source

Type Parameters

TCategorizedSettings: Type of derived CategorizedSettingsBaseTCategorizedSettings.

The CategorizedSettingsBaseTCategorizedSettings type exposes the following members.

Constructors

	Name	Description
	CategorizedSettingsBaseTCategorizedSettings(String, TypeRegistry)	Creates a new instance of the CategorizedSettingsBaseTCategorizedSettings class for the application's configuration file.
	CategorizedSettingsBaseTCategorizedSettings(String, Boolean, Boolean, TypeRegistry)	Creates a new instance of the CategorizedSettingsBaseTCategorizedSettings class for the application's configuration file.
	CategorizedSettingsBaseTCategorizedSettings(ConfigurationFile, String, Boolean, Boolean, Boolean, TypeRegistry)	Creates a new instance of the CategorizedSettingsBaseTCategorizedSettings class for the application's configuration file.

Top

Properties

	Name	Description
	CategoryName	Gets or sets default category name of section used to access settings in configuration file. (Inherited from CategorizedSettingsBase)
	ConfigFile	Gets or sets reference to working configuration file. (Inherited from CategorizedSettingsBase)
	Culture	Gets or sets the CultureInfo to use for the conversion of setting values to and from String. (Inherited from SettingsBase)
	Item	Gets or sets the value of the specified field or property. (Inherited from SettingsBase)
	MemberAccessBindingFlags	Gets or sets BindingFlags used to access fields and properties of derived class. (Inherited from SettingsBase)
	RequireSerializeSettingAttribute	Gets or sets flag that determines if SerializeSettingAttribute is required to exist before a field or property is serialized to the configuration file; defaults to False. (Inherited from SettingsBase)
	UseCategoryAttributes	Gets or sets value that determines whether a CategoryAttribute applied to a field or property will be used for the category name. (Inherited from CategorizedSettingsBase)

Top

Methods

	Name	Description
	CreateSetting	Create setting in configuration file if it doesn't already exist. This method is for internal use. (Inherited from CategorizedSettingsBase)
	CreateValue	Adds a setting to the application's configuration file, if it doesn't already exist. (Inherited from SettingsBase)
	DeriveDefaultValue	Attempts to get best default value for given member. (Inherited from SettingsBase)
	Dispose	Releases all the resources used by the CategorizedSettingsBase object. (Inherited from SettingsBase)
	Dispose(Boolean)	Releases the unmanaged resources used by the CategorizedSettingsBase object and optionally releases the managed resources. (Inherited from SettingsBase)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	ExecuteActionForFields	Executes specified action over all public derived class member fields. (Inherited from SettingsBase)
	ExecuteActionForProperties	Executes specified action over all public derived class properties. (Inherited from SettingsBase)
	Finalize	Releases the unmanaged resources before the CategorizedSettingsBase object is reclaimed by GC. (Inherited from SettingsBase)
	GetAttributeValueTAttribute, TValue	Attempts to find specified attribute and return specified value. (Inherited from SettingsBase)
	GetDefaultValue	Gets the default value specified by DefaultValueAttribute, if any, applied to the specified field or property. (Inherited from SettingsBase)
	GetEncryptKey	Gets the optional private encryption key specified by EncryptSettingAttribute, if any, applied to the specified field or property. (Inherited from SettingsBase)
	GetEncryptStatus	Gets the encryption status specified by EncryptSettingAttribute, if any, applied to the specified field or property. (Inherited from SettingsBase)
	GetEnumerator	Returns an enumerator based on String elements that iterates over the field and property names of this class that are targeted for serialization to the configuration file. (Inherited from SettingsBase)
	GetFieldCategoryName	Gets the category name to use for the specified field or property. (Inherited from CategorizedSettingsBase)
	GetFieldDescription	Gets the description specified by DescriptionAttribute, if any, applied to the specified field or property. (Inherited from CategorizedSettingsBase)
	GetFieldSettingScope	Gets the SettingScope specified by UserScopedSettingAttribute, if any, applied to the specified field or property. (Inherited from CategorizedSettingsBase)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetSettingName	Gets setting name to use for specified field or property. (Inherited from SettingsBase)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	GetValue(String, Type)	Gets the application's configuration file setting converted to the given type. (Inherited from SettingsBase)
	GetValueT(String)	Gets the application's configuration file setting converted to the given type. (Inherited from SettingsBase)
	GetValueT(String, T)	Copies the specified application setting into the given value. (Inherited from SettingsBase)
	Initialize	Initializes configuration settings from derived class fields or properties. (Inherited from SettingsBase)
	Load	Loads configuration file into setting fields. (Inherited from SettingsBase)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	PersistSettings	Persist any pending changes to configuration file. This method is for internal use. (Inherited from CategorizedSettingsBase)
	RestoreDefaultSettings	Restores the default settings of the configuration file. (Inherited from SettingsBase)
	RetrieveSetting	Retrieves setting from configuration file. This method is for internal use. (Inherited from CategorizedSettingsBase)
	Save	Saves setting fields into configuration file. (Inherited from SettingsBase)
	SetValue	Copies the given value into the specified application setting. (Inherited from SettingsBase)
	StoreSetting	Stores setting to configuration file. This method is for internal use. (Inherited from CategorizedSettingsBase)
	ToString	Returns a string that represents the current object. (Inherited from Object)
	UpdateExpressions	Refresh modeled value expressions from property values. (Inherited from CategorizedSettingsBaseTValueExpressionAttribute, TCategorizedSettings)
	UpdateProperties	Refresh property values from modeled value expressions. (Inherited from CategorizedSettingsBaseTValueExpressionAttribute, TCategorizedSettings)

Top

Extension Methods

	Name	Description
	GetEnumValueOrDefault	Gets the enumeration constant for value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)
	GetEnumValueOrDefaultT	Gets the enumeration constant for this value, if defined in the enumeration, or a default value. (Defined by EnumExtensions)

Top

Remarks

Consumer will need to call UpdateProperties method when modeled external sources are updated to ensure properties stay in-sync with external source.

Reference

GSF.Configuration Namespace