SettingsBase Class

Represents the base class for application settings that are synchronized with its configuration file.

Inheritance Hierarchy

SystemObject
  GSF.ConfigurationSettingsBase
    GSF.ConfigurationAppSettingsBase
    GSF.ConfigurationCategorizedSettingsBase
    GSF.ConfigurationIniSettingsBase
    GSF.ConfigurationRegistrySettingsBase

Namespace: GSF.Configuration
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.230-beta+03417d7b5cff037b24e882d7adef82d359b34964

Syntax

C++

JavaScript

Copy

[EditorBrowsableAttribute(EditorBrowsableState.Never)]
public abstract class SettingsBase : IDisposable, 
	IEnumerable<string>, IEnumerable

<EditorBrowsableAttribute(EditorBrowsableState.Never)>
Public MustInherit Class SettingsBase
	Implements IDisposable, IEnumerable(Of String), 
	IEnumerable

[EditorBrowsableAttribute(EditorBrowsableState::Never)]
public ref class SettingsBase abstract : IDisposable, 
	IEnumerable<String^>, IEnumerable

[<AbstractClassAttribute>]
[<EditorBrowsableAttribute(EditorBrowsableState.Never)>]
type SettingsBase = 
    class
        interface IDisposable
        interface IEnumerable<string>
        interface IEnumerable
    end

GSF.Configuration.SettingsBase = function();

Type.createClass(
	'GSF.Configuration.SettingsBase',
	null,
	IDisposable,
	IEnumerable`1,
	IEnumerable);

View Source

The SettingsBase type exposes the following members.

Constructors

	Name	Description
	SettingsBase	Creates a new instance of the SettingsBase class for the application's configuration file.

Top

Properties

	Name	Description
	Culture	Gets or sets the CultureInfo to use for the conversion of setting values to and from String.
	Item	Gets or sets the value of the specified field or property.
	MemberAccessBindingFlags	Gets or sets BindingFlags used to access fields and properties of derived class.
	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.

Top

Methods

	Name	Description
	CreateSetting	Implementor should create setting in configuration file (or other location).
	CreateValue	Adds a setting to the application's configuration file, if it doesn't already exist.
	DeriveDefaultValue	Attempts to get best default value for given member.
	Dispose	Releases all the resources used by the CategorizedSettingsBase object.
	Dispose(Boolean)	Releases the unmanaged resources used by the CategorizedSettingsBase object and optionally releases the managed resources.
	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.
	ExecuteActionForProperties	Executes specified action over all public derived class properties.
	Finalize	Releases the unmanaged resources before the CategorizedSettingsBase object is reclaimed by GC. (Overrides ObjectFinalize)
	GetAttributeValueTAttribute, TValue	Attempts to find specified attribute and return specified value.
	GetDefaultValue	Gets the default value specified by DefaultValueAttribute, if any, applied to the specified field or property.
	GetEncryptKey	Gets the optional private encryption key specified by EncryptSettingAttribute, if any, applied to the specified field or property.
	GetEncryptStatus	Gets the encryption status specified by EncryptSettingAttribute, if any, applied to the specified field or property.
	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.
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetSettingName	Gets setting name to use for specified field or property.
	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.
	GetValueT(String)	Gets the application's configuration file setting converted to the given type.
	GetValueT(String, T)	Copies the specified application setting into the given value.
	Initialize	Initializes configuration settings from derived class fields or properties.
	Load	Loads configuration file into setting fields.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
	PersistSettings	Implementor should persist any pending changes to configuration file (or other location).
	RestoreDefaultSettings	Restores the default settings of the configuration file.
	RetrieveSetting	Implementor should retrieve setting from configuration file (or other location).
	Save	Saves setting fields into configuration file.
	SetValue	Copies the given value into the specified application setting.
	StoreSetting	Implementor should store setting to configuration file (or other location).
	ToString	Returns a string that represents the current object. (Inherited from Object)

Top

Extension Methods

	Name	Description
	AllParallelString	Determines whether all elements of a sequence satisfy a condition with each item being tested in parallel. (Defined by CollectionExtensions)
	DistinctByString, TKey	Returns only the elements whose keys are distinct. (Defined by CollectionExtensions)
	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)
	MajorityString	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityString	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByString, TKey	Returns the majority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MajorityByString, TKey	Returns the majority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	MaxString	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxString	Returns the largest item from the enumeration. (Defined by CollectionExtensions)
	MaxByString, TKey	Selects the largest item from the enumeration. (Defined by CollectionExtensions)
	MedianString	Gets the median item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	MiddleString	Gets the middle item(s) from an enumeration, i.e., one return item for odd lengths, two for even lengths. (Defined by CollectionExtensions)
	MinString	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinString	Returns the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinByString, TKey	Selects the smallest item from the enumeration. (Defined by CollectionExtensions)
	MinorityString	Returns the minority value in the collection, or default type value if no item represents the minority. (Defined by CollectionExtensions)
	MinorityString	Returns the minority value in the collection, or defaultValue if no item represents the minority. (Defined by CollectionExtensions)
	MinorityByString, TKey	Returns the minority value in the collection, or default type value if no item represents the majority. (Defined by CollectionExtensions)
	MinorityByString, TKey	Returns the minority value in the collection, or defaultValue if no item represents the majority. (Defined by CollectionExtensions)
	StandardDeviationString	Computes the standard deviation over a sequence of Double values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationString	Computes the standard deviation over a sequence of Decimal values. (Defined by NumericalAnalysisExtensions)
	StandardDeviationString	Computes the standard deviation over a sequence of Single values. (Defined by NumericalAnalysisExtensions)
	ToDelimitedStringString	Converts an enumeration to a string, using the default delimiter ("\|") that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringString	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToDelimitedStringString	Converts an enumeration to a string that can later be converted back to a list using LoadDelimitedString. (Defined by CollectionExtensions)
	ToPagedListString	Gets a PagedListT to paginate source enumeration for a given page and specified pageSize. (Defined by CollectionExtensions)

Top

Remarks

In order to make custom types serializable for the configuration file, implement a TypeConverter for the type.
See MSDN for details.

Reference

GSF.Configuration Namespace