App
|
public abstract class AppSettingsBase : SettingsBase
The AppSettingsBase type exposes the following members.
Name | Description | |
---|---|---|
AppSettingsBase | Creates a new instance of the AppSettingsBase class for the application's configuration file. | |
AppSettingsBase(ConfigurationFile, Boolean, Boolean) | Creates a new instance of the AppSettingsBase class for the application's configuration file. |
Name | Description | |
---|---|---|
ConfigFile | Gets or sets reference to working configuration file. | |
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) |
Name | Description | |
---|---|---|
CreateSetting |
Create setting in configuration file if it doesn't already exist.
This method is for internal use.
(Overrides SettingsBaseCreateSetting(String, String, String)) | |
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) | |
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.
(Overrides SettingsBasePersistSettings) | |
RestoreDefaultSettings |
Restores the default settings of the configuration file.
(Inherited from SettingsBase) | |
RetrieveSetting |
Retrieves setting from configuration file.
This method is for internal use.
(Overrides SettingsBaseRetrieveSetting(String, String)) | |
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.
(Overrides SettingsBaseStoreSetting(String, String, String)) | |
ToString | Returns a string that represents the current object. (Inherited from Object) |
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) |
In order to make custom types serializable for the configuration file, implement a TypeConverter for the type.
See MSDN for details.
public enum MyEnum { One, Two, Three } public class MySettings : AppSettingsBase { // Private property fields (private fields will not be serialized) private double m_doubleVal; // Public settings fields public bool BoolVal = true; public int IntVal = 1; public float FloatVal = 3.14F; public string StrVal = "This is a test..."; public MyEnum EnumVal = MyEnum.Three; [SettingName("UserOptions"), EncryptSetting()] public string Password = "default"; // Mark this field to not be serialized to INI file... [SerializeSetting(false)] public decimal DecimalVal; [Category("OtherSettings"), DefaultValue(1.159D)] public double DoubleVal { get { return m_doubleVal; } set { m_doubleVal = value; } } [SerializeSetting(false)] public bool DontSerializeMe { get; set; } }