|
Categorized
|
Represents a settings entry in the config file.
Inheritance Hierarchy
Namespace: GSF.Configuration
Assembly: GSF.Core (in GSF.Core.dll) Version: 2.4.181-beta
Syntaxpublic class CategorizedSettingsElement : ConfigurationElement
The CategorizedSettingsElement type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | Category | Gets or sets the CategorizedSettingsElementCollection to which this CategorizedSettingsElement belongs. |
| CurrentConfiguration | Gets a reference to the top-level Configuration instance that represents the configuration hierarchy that the current ConfigurationElement instance belongs to. (Inherited from ConfigurationElement) |
| Description | Gets or sets the description of the setting. |
| ElementInformation | Gets an ElementInformation object that contains the non-customizable information and functionality of the ConfigurationElement object. (Inherited from ConfigurationElement) |
 | ElementProperty | Gets the ConfigurationElementProperty object that represents the ConfigurationElement object itself. (Inherited from ConfigurationElement) |
| Encrypted | Gets or sets a boolean value that indicates whether the setting value is to be encrypted. |
| EvaluationContext | Gets the ContextInformation object for the ConfigurationElement object. (Inherited from ConfigurationElement) |
| HasContext | Gets a value that indicates whether the CurrentConfiguration property is . (Inherited from ConfigurationElement) |
| ItemConfigurationProperty | Gets or sets a property or attribute of this configuration element. (Inherited from ConfigurationElement) |
| ItemString | Gets or sets a property, attribute, or child element of this configuration element. (Inherited from ConfigurationElement) |
| LockAllAttributesExcept | Gets the collection of locked attributes. (Inherited from ConfigurationElement) |
| LockAllElementsExcept | Gets the collection of locked elements. (Inherited from ConfigurationElement) |
| LockAttributes | Gets the collection of locked attributes (Inherited from ConfigurationElement) |
| LockElements | Gets the collection of locked elements. (Inherited from ConfigurationElement) |
| LockItem | Gets or sets a value indicating whether the element is locked. (Inherited from ConfigurationElement) |
| Name | Gets or sets the identifier of the setting. |
| Properties | Gets the collection of properties. (Inherited from ConfigurationElement) |
| Scope | Gets or sets the SettingScope. |
| SerializedValue | Gets value that will actually be serialized to the configuration file. |
| Value | Gets or sets the value of the setting. |
Methods| Name | Description | |
|---|---|---|
 | DeserializeElement | Reads XML from the configuration file. (Inherited from ConfigurationElement) |
 | Equals | Compares the current ConfigurationElement instance to the specified object. (Inherited from ConfigurationElement) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object) |
| GetHashCode | Gets a unique value representing the current ConfigurationElement instance. (Inherited from ConfigurationElement) |
| GetTransformedAssemblyString | Returns the transformed version of the specified assembly name. (Inherited from ConfigurationElement) |
| GetTransformedTypeString | Returns the transformed version of the specified type name. (Inherited from ConfigurationElement) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| Init | Sets the ConfigurationElement object to its initial state. (Inherited from ConfigurationElement) |
| InitializeDefault | Used to initialize a default set of values for the ConfigurationElement object. (Inherited from ConfigurationElement) |
| IsModified | Indicates whether this configuration element has been modified since it was last saved or loaded, when implemented in a derived class. (Inherited from ConfigurationElement) |
| IsReadOnly | Gets a value indicating whether the ConfigurationElement object is read-only. (Inherited from ConfigurationElement) |
| ListErrors | Adds the invalid-property errors in this ConfigurationElement object, and in all subelements, to the passed list. (Inherited from ConfigurationElement) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object) |
| OnDeserializeUnrecognizedAttribute | Gets a value indicating whether an unknown attribute is encountered during deserialization. (Inherited from ConfigurationElement) |
| OnDeserializeUnrecognizedElement | Gets a value indicating whether an unknown element is encountered during deserialization. (Inherited from ConfigurationElement) |
| OnRequiredPropertyNotFound | Throws an exception when a required property is not found. (Inherited from ConfigurationElement) |
| PostDeserialize | Called after deserialization. (Inherited from ConfigurationElement) |
| PreSerialize | Called before serialization. (Inherited from ConfigurationElement) |
| Reset | Resets the internal state of the ConfigurationElement object, including the locks and the properties collections. (Inherited from ConfigurationElement) |
| ResetModified | Resets the value of the IsModified method to when implemented in a derived class. (Inherited from ConfigurationElement) |
| SerializeElement | Writes the contents of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement) |
| SerializeToXmlElement | Writes the outer tags of this configuration element to the configuration file when implemented in a derived class. (Inherited from ConfigurationElement) |
| SetCryptoKey | Sets the key to be used for encrypting and decrypting the Value. |
| SetPropertyValue | Sets a property to the specified value. (Inherited from ConfigurationElement) |
| SetReadOnly | Sets the IsReadOnly property for the ConfigurationElement object and all subelements. (Inherited from ConfigurationElement) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
| Unmerge | Modifies the ConfigurationElement object to remove all values that should not be saved. (Inherited from ConfigurationElement) |
| Update(Object) | Updates setting information. |
| Update(Object, String) | Updates setting information. |
| Update(Object, String, Boolean) | Updates setting information. |
| Update(Object, String, Boolean, SettingScope) | Updates setting information. |
| ValueAsT | Gets the setting value as the specified type. |
| ValueAsT(T) | Gets the setting value as the specified type. |
| ValueAsBoolean | Gets the setting value as a boolean. |
| ValueAsBoolean(Boolean) | Gets the setting value as a boolean. |
| ValueAsByte | Gets the setting value as a byte. |
| ValueAsByte(Byte) | Gets the setting value as a byte. |
| ValueAsChar | Gets the setting value as a char. |
| ValueAsChar(Char) | Gets the setting value as a char. |
| ValueAsDateTime | Gets the setting value as DateTime. |
| ValueAsDateTime(DateTime) | Gets the setting value as DateTime. |
| ValueAsDecimal | Gets the setting value as a decimal. |
| ValueAsDecimal(Decimal) | Gets the setting value as a decimal. |
| ValueAsDouble | Gets the setting value as a double. |
| ValueAsDouble(Double) | Gets the setting value as a double. |
| ValueAsInt16 | Gets the setting value as a short. |
| ValueAsInt16(Int16) | Gets the setting value as a short. |
| ValueAsInt32 | Gets the setting value as an int. |
| ValueAsInt32(Int32) | Gets the setting value as an int. |
| ValueAsInt64 | Gets the setting value as a long. |
| ValueAsInt64(Int64) | Gets the setting value as a long. |
| ValueAsSByte | Gets the setting value as a signed byte. |
| ValueAsSByte(SByte) | Gets the setting value as a signed byte. |
| ValueAsSingle | Gets the setting value as a float. |
| ValueAsSingle(Single) | Gets the setting value as a float. |
| ValueAsString | Gets the setting value as a string. |
| ValueAsString(String) | Gets the setting value as a string. |
| ValueAsUInt16 | Gets the setting value as an unsigned short. |
| ValueAsUInt16(UInt16) | Gets the setting value as an unsigned short. |
| ValueAsUInt32 | Gets the setting value as an unsigned int. |
| ValueAsUInt32(UInt32) | Gets the setting value as an unsigned int. |
| ValueAsUInt64 | Gets the setting value as an unsigned long. |
| ValueAsUInt64(UInt64) | Gets the setting value as an unsigned long. |
Fields| Name | Description | |
|---|---|---|
  | DefaultDescription | Specifies the default value for the Description property. |
| DefaultEncrypted | Specifies the default value for the Encrypted property. |
| DefaultScope | Specifies the default value for the Scope property. |
| DefaultValue | Specifies the default value for the Value property. |
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) |
See Also